cogShows the rendering logs of a document within the XWiki UI
TypeXAR
CategoryApplication
Developed by

Clément Aubin, Vincent Massol

Active Installs2
Rating
1 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

Once installed, this application will display icons in the content menu of the document if any message has been logged during the rendering of this document. These icons will only be displayed if the user accessing the document has edit access on it, and if there are logs to display.

icons.png

When clicking on the logs, a modal will be displayed with the detail of each log :

modal.png

Below is the code used in order to create the above screenshots :

{{velocity language="velocity"}}
## Deprecation warning
$doc.syntaxId

#set($logger = $services.logging.getLogger($doc.documentReference.name))
$services.logging.setLevel($doc.documentReference.name, 'TRACE')

$logger.trace('Some trace')
$logger.debug('Some debug')
$logger.info('Some info')
$logger.warn('Some warning')
$logger.error('Some error')
{{/velocity}}

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.contrib.pagelogs:application-pagelogs-ui 1.0):

  • org.xwiki.contrib.pagelogs:application-pagelogs-api 1.0
Tags:
    

Get Connected