Configuring Audit Logging

Within Confluence it is possible to use the Audit log section to view specific logged events with the exporter app. This documentation outlines the events which are logged by the exporter app and outlines scenarios that can cause differences in audit logging. For general information regarding Atlassian's Audit Log feature please see their documentation.

Logging Targets

Events can be logged on multiple targets. These must be configured independently and any combination can be used.

See the table below for descriptions of the individual event types.

Audit Log - Confluence 7.5.0 or later

All events will be added to the Confluence Audit log by default. See the Confluence documentation for details and differences between Confluence versions and editions (Server or Data Center).

All events will be logged in the 'Apps' coverage area.
On Data Center make sure to set the coverage level as needed (see table below). This is accessible in the Audit Log section via ••• > Settings
Past events cannot be retrieved retrospectively if the incorrect logging coverage is set.

Example audit log entries

Features available on Confluence 8.0 (Data Center)

Log Files - all Confluence versions

After enabling this target, subsequent events will be printed to the standard Confluence log files. You need to enable this by configuring logging for the below logger names.

Please read the corresponding Confluence documentation for instructions and to understand the difference between temporary and permanent logging configuration.

Set any of the below loggers to INFO level.

To log all events:

CODE

com.k15t.scroll.scroll-office.AUDIT

To control logging by event type you can define these instead:

CODE

com.k15t.scroll.scroll-office.AUDIT.export-job
com.k15t.scroll.scroll-office.AUDIT.template-change

Example log file entries

Export generated example:

2023-02-15 17:22:34,281 INFO [scroll-office-export:thread-1] [scroll.scroll-office.AUDIT.export-job] auditExportJob User 402891526d01e7e4016d01e8a2340000 performed export: JobDetails[App='Scroll Word Exporter', Template name='Documentation', Template ID='com.k15t.scroll.office.default-template-documentation', Page title='emoji page', Page ID='9502722', Space Key='TS', Initiator='EXPORT_DIALOG', Export scope='descendants']

Template change example:

2023-02-15 13:57:22,291 INFO [http-nio-127.0.0.1-1990-exec-3] [scroll.scroll-office.AUDIT.template-change] auditTemplateChangeEvent User 402832e484e2dfc60184e2e001dd0000 changed template: TemplateChangeEvent[eventType=STATE_CHANGE, templateId='04c6ee95-0cce-4f85-ae69-b14612014530', templateName='Audit Testing Template', spaceKey='TS', nameBeforeEdit='null', copySourceId='null', copySourceName='null', previousState=UNAVAILABLE, newState=AVAILABLE]

Logged Events

The table below provides an overview of the logged events that can be displayed in the Audit log section.

Event	Description	Coverage Level (Data Center)	Logged Details
Page(s) exported DATA CENTER ONLY	An export was generated from a space in Confluence	Full	Date: Date/Time of export Author: User that performed the export Category: The Scroll Exporter app used for the export Affected Object(s) Name of the export template used Link to the page where the export was generated from Export Initiator: Method for performing the export eg. from the export dialogue, Scroll Export Button Macro, within the export template or via the REST API) Export Scope: Scope of the export eg. Full page tree or single page Export Template ID: ID for the export template used More affected objects: Link to the space where the export was performed
Template copied	An export template was copied	Base or Advanced	Date: Date/Time when the template was copied Author: User that copied the template Category: The Scroll Exporter app that the template belongs to Affected Object(s) Name of the copied template Link to the space where the template was copied Please note, a link will not be present if the template was copied in the global template list Export Template ID: ID of the new template copy Original Template ID: ID of the original template that was copied Original Template Name: Name of the original template that was copied
Template created	An export template was created	Base or Advanced	Date: Date/Time when the template was created Author: User that created the template Category: The Scroll Exporter app that the template belongs to Affected Object(s) Name of the created template Link to the space where the template was created Please note, a link will not be present if the template was created in the global template list Export Template ID: ID for the created template
Template edited	An export template was edited	Base or Advanced	Date: Date/Time when the template was edited Author: User that edited the template Category: The Scroll Exporter app that the template belongs to Affected Object(s) Name of the template edited Link to the space where the template was edited Please note, a link will not be present if the template was edited in the global template list Template Name: Details regarding the template name change Export Template ID: ID for the edited template
Template exported	An export template was downloaded	Base or Advanced	Date: Date/Time of export Author: User that performed the download Category: The Scroll Exporter app that template belongs to Affected Object(s) Name of the export template downloaded Link to the space where the template was downloaded Export Template ID: ID for the export template downloaded
Template imported	An export template was imported	Base or Advanced	Date: Date/Time when the template was imported Author: User that imported the template Category: The Scroll Exporter app that the template belongs to Affected Object(s) Name of the imported template Link to the space where the template was imported. Please note, a link will not be present if the template was imported to the global template list Export Template ID: ID for the imported template
Template removed	An export template was deleted	Base or Advanced	Date: Date/Time when the template was deleted Author: User that deleted the template Category: The Scroll Exporter app that the template belongs to Affected Object(s) Name of the deleted template Link to the space where the template was deleted Please note, a link will not be present if the template was deleted from the global template list Export Template ID: ID for the deleted template
Template visibility changed	An export template was made available / unavailable for exporting	Base or Advanced	Date: Date/Time when the template visibility was changed Author: User that changed the template visibility Category: The Scroll Exporter app that the template belongs to Affected Object(s) Name of the template Link to the space where the template's visibility was changed. Please note, a link will not be present if the template visibility was changed in the global template list Visibility: Details regarding the template visibility change Export Template ID: ID for the affected template