| Name | Confluence Usage Tracking Plugin |
|---|---|
| Vendor | Atlassian Software Systems (Website) |
| Authors | Mike Cannon-Brookes, Matthew Jensen, Agnes Ro |
| Homepage | http://confluence.atlassian.com/display/CONFEXT/Usage+Tracking+Plugin |
| Issue Management | http://developer.atlassian.com/jira/browse/USGTRK |
| Categories | Others |
| Version | 0.9 |
| Availability | Confluence v2.8.0 to v2.10-m1 |
| State | Stable |
| Support |
|
| License | Freeware / Open Source (BSD) |
| Price | Free |
| Release Docs | http://confluence.atlassian.com/display/CONFEXT/Usage+Tracking+Plugin |
| Java API Docs | n/a |
| Download Source | http://svn.atlassian.com/svn/public/contrib/confluence/usage-plugin/tags/usage-tracking-plugin-0.9/ |
| Download JAR | usage-tracking-plugin-0.9.jar |
 | This plugin is available in the Confluence Repository Client. |
 | This plugin has known performance problems in large installations. See the plugin's issue tracker for more information. |
Compatibility With Confluence
| Plugin Version | 2.4.5 | 2.5.8 | 2.6.2 | 2.7.3 | 2.8.1 | 2.9 | Tested |
|---|---|---|---|---|---|---|---|
| 0.7.2 | |
|
|
 |
|
David Chui (Apr/15/2008) | |
| 0.8 | |
|
|
David Chui (Jul/02/2008) | |||
| 0.9 | |
|
|
|
David Chui (Aug/11/2008) |
Description/Features
A macro for tracking content view, create, edit and delete events in Confluence.
Installation
This plugin is bundled with Confluence. However, it may be updated periodically, so check the Plugin Repository to see if any new versions are available.
Documentation
To view the usage statistics for a particular space, do the following:
- Click Browse Space (
) - Select the Activity tab.
- 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:
- Enter '/admin/globalusage.action' on the end of your Confluence server's root directory (e.g. 'http://foo.com/confluence/admin/globalusage.action').
- 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}
Version History
| Version | Date | State | License | Price |
0.9
(#6)
|
04 Jun 2008 | Stable | Freeware / Open Source (BSD) | Free |
|
0.8
(#5)
|
29 Feb 2008 | Stable | Freeware / Open Source (BSD) | Free |
|
0.7.2
(#4)
|
31 May 2007 | Stable | Freeware / Open Source (BSD) | Free |
|
0.5
(#3)
|
29 Mar 2007 | Stable | Freeware / Open Source (BSD) | Free |
|
0.4
(#2)
|
01 Feb 2007 | Stable | Freeware / Open Source (BSD) | Free |
|
0.3
(#1)
|
01 Jan 2007 | Stable | Freeware / Open Source (BSD) | Free |
Screenshots
|
|
|
The Global Activity report.
|
The Space Activity report.
|
Outstanding Tasks
Atlassian Developer Network JIRA
(16 issues)
|
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| T | Key | Summary | Assignee | Reporter | Pr | Status | Res | Created | Updated | Due |
|
USGTRK-32 | No distinction between Timespam and Period for Topusers macro | Jonathan Nolen | Gurleen Anand |
|
 Open
|
UNRESOLVED | Sep 22, 2008 | Sep 22, 2008 | |
|
USGTRK-12 | Per user statistics in Confluence | Jonathan Nolen | Matt Ryall |
|
Open
|
UNRESOLVED | Nov 29, 2007 | Sep 21, 2008 | |
|
|
USGTRK-7 | Usage tracking plugin cause locking issues and slow down system | Jonathan Nolen | Paul Curren [Atlassian] |
|
Open
|
UNRESOLVED | Nov 28, 2007 | Sep 17, 2008 | |
|
USGTRK-31 | Exclude users from usage statistics | Jonathan Nolen | Matthew Cunningham |
|
Open
|
UNRESOLVED | Aug 27, 2008 | Aug 27, 2008 | |
|
|
USGTRK-10 | Activity plugin does not work in a cluster | Jonathan Nolen | Matt Ryall |
|
Open
|
UNRESOLVED | Nov 29, 2007 | Aug 26, 2008 | |
|
|
USGTRK-5 | Output data in a form that can be wrapped in a chart | Jonathan Nolen | Andy Brook |
|
Open
|
UNRESOLVED | Nov 13, 2007 | Jul 30, 2008 | |
|
|
USGTRK-16 | Activity Data lost after import - User Usage Plugin | Jonathan Nolen | Matt Ryall |
|
Open
|
UNRESOLVED | Nov 29, 2007 | Jul 11, 2008 | |
|
|
USGTRK-24 | Allow users to specify how many items they want to show in the popular and top users list in the global report | Jonathan Nolen | Ivan Benko |
|
Open
|
UNRESOLVED | Apr 03, 2008 | Jun 16, 2008 | |
|
|
USGTRK-26 | Error in reading index files to query active users. Please try rebuilding the index. | Jonathan Nolen | Imtiaz B Syed |
|
Open
|
UNRESOLVED | Apr 23, 2008 | Apr 23, 2008 | |
|
|
USGTRK-25 | add page status parameter to popular macro | Jonathan Nolen | Penny Rohr |
|
Open
|
UNRESOLVED | Apr 14, 2008 | Apr 14, 2008 | |
|
|
USGTRK-15 | Improve activity plugin performance | Jonathan Nolen | Matt Ryall |
|
Open
|
UNRESOLVED | Nov 29, 2007 | Mar 27, 2008 | |
|
|
USGTRK-17 | activity lists return too many results | Jonathan Nolen | Matt Ryall |
|
Open
|
UNRESOLVED | Nov 29, 2007 | Nov 29, 2007 | |
|
|
USGTRK-14 | Axis labels in activity plugin graphs overlap and become unreadable | Jonathan Nolen | Matt Ryall |
|
Open
|
UNRESOLVED | Nov 29, 2007 | Nov 29, 2007 | |
|
|
USGTRK-13 | Activity plugin graphs always drop to zero | Jonathan Nolen | Matt Ryall |
|
Open
|
UNRESOLVED | Nov 29, 2007 | Nov 29, 2007 | |
|
|
USGTRK-11 | Ability for a date range selection in addition to the existing functionality | Jonathan Nolen | Matt Ryall |
|
Open
|
UNRESOLVED | Nov 29, 2007 | Nov 29, 2007 | |
|
|
USGTRK-9 | Rename the Activity Plugin | Jonathan Nolen | Matt Ryall |
|
Open
|
UNRESOLVED | Nov 29, 2007 | Nov 29, 2007 | |
Comments (24)
Nov 23, 2007
Davide De Benedictis says:
Hi guys, I'm using the topusers macro on my conluence installation with these op...Hi guys,
I'm using the topusers macro on my conluence installation with these options:
{topusers:spaces=@all|events=create,update|display=icon,title,count|timespan=1w}If I set timespan=1m I get just "none"
Why?
Reading the documentation, things got still more obscure with the period option.
What's the difference between period ant timespan options?
Bye
Jan 29, 2008
Frank Stiller says:
Hy Davide, i think 1m is 1 minute, try 1M (should be month). A overall statisti...Hy Davide,
i think 1m is 1 minute, try 1M (should be month). A overall statistic of 1 minute makes no sense.
The difference between timespan and period is timespan gives the total time shown and period shows the statistic value for the point in time, e.g. you have a total timespan of 1w(eek) and a period of d(ay) which should give you a daily statistic of the last week.
cheers
Feb 12, 2008
Davide De Benedictis says:
Thank you for the explanation Frank, I've tried with different combinations of ...Thank you for the explanation Frank,
I've tried with different combinations of period and timespan but if I use (M)onth I get always "none"
I think there should be some bug.
Bye
Feb 27, 2008
Mohamed Sherefudheen says:
Hello I am getting the following exception with your plugin using with confluenc...Hello I am getting the following exception with your plugin using with confluence 2.4.4
I tried a complete reindex but it dint help.
How can I fix it. When does this file plugin files get created.
com.atlassian.bonnie.LuceneException: java.io.FileNotFoundException: /confluence/confluence-2.4.4/index/plugin/usage/_1asga.fnm (No such file or directory)
Feb 28, 2008
Choy Li Tham says:
Hi Mohamed, It would be appreciated that if you could raise a support request a...Hi Mohamed,
It would be appreciated that if you could raise a support request at here for further investigation.
Regards,
Choy Li
Feb 29, 2008
sanjay gopalakrishnan says:
Hi, It would be great if the popular marco could support the period attribute. ...Hi,
It would be great if the popular marco could support the period attribute. Thereby for specific type of pages (identified using labels) we can use the period attribute along with the timespan attibute and get a periodic view of event across time. e.g. a trend report for 'x' type of pages that gives say 'views' for the last 1 years segmented based on the month. An alternative alignWithDates (suggest better name!) kind of attribute would also be useful that if true would generate the above reports in style (5th march to 1st march,29th feb to 1st feb and so on instead of 5th march to 6th feb as this currently works) for monthly periodic reports.
This should help many stastical reports being met.
I hope my thoughts go to the authors...
I would not be too demanding if i ask an excel export option as well...
Mar 04, 2008
Ming Giet Chong says:
Hi Sanjay, Thanks for the suggestion. I would suggest you to raise an improveme...Hi Sanjay,
Thanks for the suggestion. I would suggest you to raise an improvement request at the issue tracker. Alternatively, you might want to direct your questions/idea to the plugin authors. Thanks.
Regards,
MG
Apr 08
Aaron Smith says:
Hi, I'm having a slight problem using the labels parameter with the "popular" m...Hi,
I'm having a slight problem using the labels parameter with the "popular" macro. It seems to be ignoring the labels parameter and showing all the content within the current space. Here is an example of the syntax I am using.
popular:labels=installation|timespan=1y|max=25
I tried using the labels parameter with the "recently-updated" macro and it worked, so I'm pretty sure the labels are setup correctly. I am using version: 2.3.1 Build:#643 of Confluence.
Thanks for your help!
-Aaron
Apr 07
Mei Yan Chan says:
Hi Aaron, May I know which version of the plugin are you using? I would suggest...Hi Aaron,
May I know which version of the plugin are you using? I would suggest you to raise this issue in our support system for further investigation. Please try to escape the macros to prevent it from being rendered while posting a sample usage of them. Thanks.
Regards,
Mei
Apr 23
Imtiaz B Syed says:
Dear Mike,Matthew & Agnes, I am having one critical issue with this Usage T...Dear Mike,Matthew & Agnes,
I am having one critical issue with this Usage Tracking Plugin. I have done some modification one by one and each modification i have updated the version in atlassian-plugin.xml. In initial stages when i updated the default plugin with mine it installed successfully and was working fine. But, today it suddenly started throwing exception as
"Error in reading index files to query active users. Please try rebuilding the index."
Its not working even after rebuilding the index. Usual rebuild will take more than 30 mins but today rebuilding index done with in 8 mins. Please provide some help in this error.
Due to this error the Global Activities and space activities also not working in the server. Installation of plugin is successfull every time when i try but trowing exception as
"Error in reading index files to query active users. Please try rebuilding the index.".
at java.lang.Thread.run(Thread.java:595)
2008-04-23 10:13:06,461 INFO [STDOUT] 2008-04-23 10:13:06,460 ERROR [Thread-77] [ext.usage.index.UsageIndexManager] index java.io.FileNotFoundException: /opt/xyz/confluenceJBoss/index/plugin/usage/_ag71.fnm (No such file or directory)
– url: /<context>/display/HCCS/FAQ | userName: <username> | action: viewpage | page: 16287211
java.io.FileNotFoundException: /opt/xyz/confluenceJBoss/index/plugin/usage/_ag71.fnm (No such file or directory)
at java.io.RandomAccessFile.open(Native Method)
at java.io.RandomAccessFile.<init>(RandomAccessFile.java:212)
at org.apache.lucene.store.FSDirectory$FSIndexInput$Descriptor.<init>(FSDirectory.java:506)
at org.apache.lucene.store.FSDirectory$FSIndexInput.<init>(FSDirectory.java:536)
at org.apache.lucene.store.FSDirectory$FSIndexInput.<init>(FSDirectory.java:531)
at org.apache.lucene.store.FSDirectory.openInput(FSDirectory.java:440)
at org.apache.lucene.index.FieldInfos.<init>(FieldInfos.java:57)
at org.apache.lucene.index.SegmentReader.initialize(SegmentReader.java:186)
at org.apache.lucene.index.SegmentReader.get(SegmentReader.java:167)
at org.apache.lucene.index.SegmentReader.get(SegmentReader.java:131)
at org.apache.lucene.index.IndexReader$1.doBody(IndexReader.java:206)
at org.apache.lucene.index.SegmentInfos$FindSegmentsFile.run(SegmentInfos.java:610)
at org.apache.lucene.index.IndexReader.open(IndexReader.java:185)
at org.apache.lucene.index.IndexReader.open(IndexReader.java:167)
at org.apache.lucene.search.IndexSearcher.<init>(IndexSearcher.java:56)
at org.apache.lucene.search.DelayCloseIndexSearcher.<init>(DelayCloseIndexSearcher.java:86)
at com.atlassian.confluence.ext.usage.index.UsageLuceneConnection.refreshSearcher(UsageLuceneConnection.java:39)
at com.atlassian.confluence.ext.usage.index.UsageIndexManager.index(UsageIndexManager.java:245)
at com.atlassian.confluence.ext.usage.event.UsageEventListener$1.run(UsageEventListener.java:78)
at EDU.oswego.cs.dl.util.concurrent.QueuedExecutor$RunLoop.run(QueuedExecutor.java:89)
at java.lang.Thread.run(Thread.java:595)
Need help.....