Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Properties Marker
overridefalse


Short DescriptionList of loggers for monitoring projectdoc.
 

Doctypetopichide
NameLogging
 

Parent
Parent Property
property-nameName
 

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
namesConfluence Administrator
propertyAudience
 

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience
 

Expected Duration
 

Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
propertyTags
 

Iteration

Iteration
value

filled

released

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesReference
propertyType
 

Sort Keyhide



Section
show-titlefalse
titleDescription

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

...

Section
titleLoggers

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

Section
titleSpecial Purpose

Loggers on tracing events taking place over all components.

Definition List


de.smartics.projectdoc.atlassian.confluenceEverything related to this add-on for Confluence.
de.smartics.projectdoc.performanceLogger 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.

Version Box
since4.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
      projectdoc-static-document-link-macro
      documentName 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
      Static Document Link
      documentDynamic Property Values
      labeldynamic property value
       is encountered and is an issue for the selected dynamic value mode.
Example Box

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.





projectdoc-section
titleDocuments

Loggers on tracing actions on projecdoc documents.

Definition List


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




Section
titleCaching

Loggers for tracing caching actions.

Definition List


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




Section
titleWeb-API

Loggers regarding REST API calls of the Web API Extension.

Definition List


de.smartics.projectdoc.extension.webapi.restLogs calls to the web API.





Section
titleSubordinate Topics
Display Table
doctypetopic
render-no-hits-as-blanktrue
selectName, Short Description
restrict-to-immediate-childrentrue
sort-bySort Key, Name

...