projectdoc Toolbox

List of loggers for monitoring projectdoc.

Lists loggers that may be interesting for confluence administrators to track services of the projectdoc add-on.

Loggers

These are the logger keys for switching them on. Set these logger to Debug if you need more information about a component.

Special Purpose

Loggers on tracing events taking place over all components.

de.smartics.projectdoc.atlassian.confluence
Everything related to this add-on for Confluence.
de.smartics.projectdoc.performance
Logger to track performance in selected services. This is especially useful to track transclusion issues.
de.smartics.projectdoc.healthCheck

Logger to report health issues with the projectdoc Toolbox configuration and user data. This allows tools of the projectdoc Toolbox to log encountered issues.

Since 4.13

 

The logger is defined since version 4.13.

Health logger may be quite verbose. It is recommended that they are only activated in case the documentation architect or gardener is looking for issues or is trying to improve the information architecture.

The following subordinate loggers are defined.

  • transclusion (WARN)
    • MISSING CONTENT FOR TRANSCLUSION
      If the transcluded fragment identified by identifiers or tags cannot be found on the referenced page.
  • names
    • UNKNOWN NAME (WARN)
      If a name specified in a Name List Macro does not refer to a document with that name and doctype.
  • templatePlaceholders
    In case a configured macro detects a placeholder in a template that is not replaced.
  • dynamicValues (since 6.0)
    • DYNAMIC PROPERTY VALUE PREVENTION (WARN)
      If a dynamic property value is encountered and is an issue for the selected dynamic value mode.
 

To get set the log level for a subordinate logger add its name to the health check logger, for instance de.smartics.projectdoc.healthCheck.names.

Documents

Loggers on tracing actions on projecdoc documents.

de.smartics.projectdoc.atlassian.confluence.persistence.PersistenceEventListener
Logs page events that are relevant for persisting projectdoc documents.
de.smartics.projectdoc.atlassian.confluence.cache
Logs action on the projectdoc document cache.
de.smartics.projectdoc.atlassian.confluence.lucene
Logs actions of the projectdoc extractor interfacing with Lucene.

Caching

Loggers for tracing caching actions.

de.smartics.projectdoc.atlassian.confluence.tools.cache.fragments
Logs actions of the Fragments Cache for Transclusions.
de.smartics.projectdoc.atlassian.confluence.doctypes.templates
Logs actions on the projectdoc doctype cache.
de.smartics.projectdoc.atlassian.confluence.cache
Logs action on the projectdoc document cache.
de.smartics.projectdoc.atlassian.confluence.tools.fragments
Logs details on fragment handling.

Web-API

Loggers regarding REST API calls of the Web API Extension.

de.smartics.projectdoc.extension.webapi.rest
Logs calls to the web API.