Summary

You can follow the steps below to gather data about the use of Timepiece features:

Logs

If you need to track ...

• How frequently Timepiece is used on your system,
• Which users are using the app,
• How big are the reports they are getting

... you can enable the info logs as described below.

Output

When the info logs are enabled, Timepiece will write messages like the below to Jira logs (atlassian-jira.log file on your server) every time a Timepiece report is requested (either from Timepiece main page, a Timepiece tab on an issue view page, a dashboard gadget or via REST API).

2022-12-02 12:12:20,847+0300 http-nio-9400-exec-22 INFO admin 732x422x5 1jq7g21 31.206.25.126 /rest/tis/report/1.0/out/tableaggregation [t.c.o.p.tis.rest.ReportBuildingControllerBase] Time in Status by OBSS report requested by user : admin Report Type : durationBetweenStatuses, Source : GADGET
2022-12-02 12:12:21,458+0300 Thread-380            INFO admin 732x422x5 1jq7g21 31.206.25.126 /rest/tis/report/1.0/out/tableaggregation [t.c.o.p.tis.builder.ReportDataBuilder]         Started to build report data: 15 issues
2022-12-02 12:12:21,863+0300 Thread-380            INFO admin 732x422x5 1jq7g21 31.206.25.126 /rest/tis/report/1.0/out/tableaggregation [t.c.o.p.tis.builder.ReportDataBuilder]         Report data has been built

When multiple TiS report requests are being processed by the Jira server simultaneously, multiple instances of these lines might be mixed up with each other in the log output. In that case, you can match the lines for individual report requests using the requestID (shown as 732x422x in the sample above) in the log output.

Enabling Info Logs

To see these logs you will need to enable INFO level logging for these packages:

• tr.com.obss.plugin.tis.rest.ReportBuildingControllerBase
• tr.com.obss.plugin.tis.builder

How to enable info logs:

1. Navigate to Jira Administration >> System >> Logging and Profiling page. ( /secure/admin/ViewLogging.jspa )
2. Click on Configure logging level for another package.
   1. Enter the Package Name.
   2. Select Info as the Logging Level.
   3. Click Add.
3. Repeat for each package.

After following these steps, you should see the new package name in the package list on the same page, as shown below:

Parameter Sets

Timepiece keeps its parameter sets in a DB table named AO_956E29_REPORT_SETTINGS in JiraDB.

You can check this table to see which users have saved param sets.

select s.username, s.* 
from AO_956E29_REPORT_SETTINGS s;

-- The username column contains the name of the user who created this param set.

-- This is a query built for MySQL. If you are using a different DBMS, you will need to change this query accordingly.

.

.

Dashboard Gadgets

You can run the following DB query on Jira DB to see which dashboards have Timepiece gadgets on them and which users those dashboards belong to:

select 
dashboard.id                        as dashboard_Id,       
dashboard.pagename                  as Dashboard_Name,       
users.id                            as user_id,       
users.lower_user_name               as user_name,       
gadget.id                           as Gadget_Id
from portalpage as dashboard
         join portletconfiguration as gadget on gadget.portalpage = dashboard.id
         join app_user as users on users.user_key = dashboard.username
where gadget.gadget_xml = 'rest/gadgets/1.0/g/com.obss.plugin.time-in-status:tis-gadget/tis-gadget.xml';

-- This is a query built for MySQL. If you are using a different DBMS, you will need to change this query accordingly.

Atlassian's App Usage App

Atlassian published the app below for Jira Data Center which collects and reports data about each app's usage. 

https://marketplace.atlassian.com/apps/1230311/app-usage-for-jira?hosting=datacenter&tab=overview