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, and also helps us know where to prioritize product improvements.
Set up reporting of usage and exception information to LabKey on the Site Settings page. Learn more here:
Usage Statistics Reported
When
reporting of usage statistics is set to either "On" or "Report only", details like those listed below 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, which modules are enabled, etc. They also capture the number of times certain features have been used overall as well as on a monthly basis to follow trends.
Usage reporting will
not capture your data or the names of specific objects like folders, datasets, study participants ids, etc., nor the row-level content of any items.
- OS name
- Java version
- Heap Size
- Database platform (i.e. Postgres) and version
- Database driver name and version
- Unique ids for server & server session
- Tomcat version
- Distribution name
- Whether the enterprise pipeline is enabled
- 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
- Number of folders of each folder type
- 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 to view or download an example report.
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
- The max heap size for the JVM
- Tomcat version
- Database platform (i.e. Postgres) and version
- JDBC driver and version
- Unique ids for server & server session
- Distribution name
- Whether the enterprise pipeline is enabled
- 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:
Related Topics