Confluence Usage Tracking Plugin

This plugin is disabled by default since Confluence 3.0. It has has known performance problems in large installations. You need to re-enable in order to use it. For more information please refer to the 3.0 release notes. The plugin is not available in Confluence Clustered Edition.

Description

Shows user activity in Confluence.

Usage

To view the usage statistics for a particular space, do the following:

  1. Click Browse Space ( )
  2. Select the Activity tab.
  3. Select the period of time to review space usage for.

If you are an administrator, you can also view global usage statistics. There is no simple link to access it, however. There are two options:

  1. Enter '/admin/globalusage.action' on the end of your Confluence server's root directory (e.g. 'http://foo.com/confluence/admin/globalusage.action').
  2. Navigate to a space's activity tab as described above, then click the 'Global Confluence activity' link.

Macros

There are three macros included with the usage tracking plugin which allows you to insert statistics on any Confluence page. The output of some of these macros can be wrapped in the chart macro to display charts of the statistics information.

usage macro

A macro to show usage statistics. Parameters:

  • spaces: - (optional) a comma-separated list of spaces to restrict content to. By default the current space will be used.
  • types: - (optional) a comma-separated list of content types to restrict content to (page content by default).
  • events: - (optional) a comma-separated list of events to restrict content usage based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
  • columns: - (optional) the type of column to display (event by default). Allowed column values are 'event', 'space' and 'type'.
  • timespan: - (optional) restrict the timespan of popularilty from today minus the given value. The timespan value should be a number followed by one of the following: 'w' for week, 'd' for day and 'm' for minute. 1d (1 day) is used by default.
  • period: - (optional) the periodic interval to display (daily by default). Allowed period values are 'daily','weekly', 'monthly', 'yearly', 'hourly' and 'minutely'.
Examples:

{usage:spaces=@all}

{usage:spaces=dog,cat|types=page,blogpost}

{usage:period=hourly|timespan=1d|events=create,view,update}

popular macro

A macro to show popular content. Parameters:

  • spaces: - (optional) a comma-separated list of spaces to restrict content to. By default the current space will be used.
  • types: - (optional) a comma-separated list of content types to restrict content to (page content by default).
  • labels: - (optional) a comma-separated list of labels to restrict content to.
  • display: - (optional) a comma-separated list of items to display (title, count by default). Allowed values are 'icon', 'title', 'count'.
  • timespan: - (optional) restrict the timespan of usage from today minus the given value. The timespan value should be a number followed by one of the following: 'w' for week, 'd' for day and 'm' for minute. 1w (1 week) is used by default.
  • events: - (optional) a comma-separated list of events to restrict content popularity based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
  • max: - (optional) the maximum number of popular content to display (10 by default).
  • style: - (optional) the style to display the popular content in (table by default). Allowed style values are 'list', 'table' and 'flat'.
Examples:

{popular:spaces=@all}

{popular:spaces=dog,cat|types=page,blogpost}

{popular:timespan=1m|events=create,view,update|max=20}

topusers macro

A macro to show active users.

  • spaces: - (optional) a comma-separated list of spaces to restrict content to. By default the current space will be used.
  • display: - (optional) a comma-separated list of items to display (title, count by default). Allowed values are 'icon', 'title', 'count'.
  • events: - (optional) a comma-separated list of events to restrict top users based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
  • columns: - (optional) the type of column to display (event by default). Allowed column values are 'event', 'space' and 'type'.
  • timespan: - (optional) restrict the timespan of usage from today minus the given value. The timespan value should be a number followed by one of the following: 'w' for week, 'd' for day and 'm' for minute. 1w (1 week) is used by default.
  • period: - (optional) the periodic interval to display (daily by default). Allowed period values are 'daily','weekly', 'monthly', 'yearly', 'hourly' and 'minutely'.
Examples:

{topusers:spaces=@all}

{topusers:spaces=dog,cat|types=page,blogpost}

{topusers:timespan=1w|period=daily|events=create,view,update|display=icon,title,count}