This topic details the information included in the different levels of usage and exception reporting available in the site settings. Reporting this information to LabKey can assist us in helping you address problems that may occur.

Set Reporting

To set up reporting of usage and exception information to LabKey:

  • Select (Admin) > Site > Admin Console.
  • Under Configuration, click Site Settings.
  • Select ON for Automatically check for updates to LabKey Server and report usage statistics to LabKey.
  • Select ON, [level] for Automatically report exceptions.
  • Click Save.

Basic Usage Reporting

When usage reporting is turned ON, the following details are reported back to LabKey, allowing the development team to gain insights into how the software is being used. This includes counts for certain data types, such as assay designs, reports of a specific type, or lists. May also capture the number of times a certain feature was used in a given time window, such as since the server was last restarted.

This will not capture the names of specific objects like folders names, dataset names, etc, nor the row-level content of those items. It will also not capture metrics at an individual folder level or other similar granularity. For example, a metric will not break down the number of lists defined in each folder, but it may capture the number of folders that have lists defined.

  • OS name
  • Java version
  • Enterprise pipeline enabled?
  • Heap Size
  • Database platform (SQL Server or Postgres) and version
  • Database driver name and version
  • Unique ids for server & server session
  • Tomcat version
  • Distribution name
  • Configured usage reporting level
  • Configured exception reporting level
  • Total counts of users and active users
  • Number of recent logins and logouts
  • Average session duration
  • Total days site has been active
  • Total project count
  • Total folder count
  • Module build and version details, when known
  • Web site description
  • Administrator email
  • Organization name
  • Site short name
  • Logo link
  • Number of hits for pages in each module
  • Assay design and run counts
  • Study dataset and report counts, plus specimen counts if enabled
  • Number of folders of each folder type
  • Number of TargetedMS runs
  • Folder counts for PHI settings usage (terms of use, PHI activity set, PHI roles required, PHI query logging behavior)
Note that this is a partial list, and the exact set of metrics will depend on the modules deployed and used on a given server. To see the exact set of metrics and their values, use the button on the Site Settings page.

Exception Reporting

When exception reporting is turned on, the following details are reported back to LabKey:

Low Level Exception Reporting

  • Error Code
  • OS name
  • Java version
  • Enterprise pipeline enabled?
  • The max heap size for the JVM
  • Tomcat version
  • Database platform (SQL Server or Postgres) and version
  • JDBC driver and version
  • Unique ids for server & server session
  • Distribution name
  • Configured usage reporting level
  • Configured exception reporting level
  • Stack trace
  • SQL state (when there is a SQL exception)
  • Web browser
  • Controller
  • Action
  • Module build and version details, when known

Medium Level Exception Reporting

Includes all of the information from "Low" level exception reporting, plus:

  • Exception message
  • Request URL
  • Referrer URL

High Level Exception Reporting

Includes all of the information from "Medium" level exception reporting, plus:

  • User email

Related Topics

Discussion

Was this content helpful?

Log in or register an account to provide feedback


previousnext
 
expand all collapse all