Generate diagnostics for your Lightrun on-premise deployment¶

Starting from version 1.50, you can generate and download a comprehensive set of diagnostic reports in JSON format. The reports contain detailed technical information about your Lightrun setup, including general system details, server logs, and agent logs.

Generating these reports helps with troubleshooting your Lightrun setup within your organization. Reports are downloaded as a system_diagnostics.zip file, organized by category, and saved locally to your computer. Each category is stored in a separate JSON file.

In the System Diagnostics page in the Lightrun Management Portal, you can select the type of report you would like to generate based on these main categories:

• General Information
• Server Logs
• Agent Logs
• Plugin Logs

List of available reports¶

The reports are generated and are displayed in these set of JSON files:

• AGENTS.json: Lists the agent count by runtime environment and version.
• ACTIONS_INFO.json: Lists information by action type, including the active action count, average hit size for logs and snapshots, max hit size, first and last hits, and total hit counts.
• DB_TABLES_INFO.json: Lists Lightrun database information, including size and table names. Data within the tables is not included.
• ENVIRONMENT_VARIABLES.json: Lists the environment variables set on the Lightrun server. Sensitive information is redacted.
• FEATURE_TOGGLES.json: Lists all the feature flags, their enabled/disabled status, and associated parameters.
• INTEGRATIONS.json: Lists the Lightrun integrations configured in the system.
• KEYCLOAK.json: Lists the Keycloak parameters configured in the system.
• LICENSES_INFO.json: Lists the agent count, user count, and license expiry date.
• PLUGINS.json: Lists the Lightrun plugins connected to the IDEs in your organization, including the count of plugins by version and by IDE versions.
• USAGE_INFO.json: Lists the number of active users, agent pools, and usage statistics by agent pool.

Generate system diagnostics reports¶

1. Log in to the Lightrun Management Portal.

2. Under Settings, navigate to Compliance > System Diagnostics.

   

3. Select the categories of reports you want to generate.

   The main categories available are:

   • General Information
   • Server Logs: All server logs will be included.
   • Agent Logs: Select the agents for which logs are collected. Note that there is a limit to the number of agents.
   • Plugin Log: Select the user for whom logs will be generated.

4. Click Generate.

   A message will indicate that the data is being generated.

5. Once complete, the system_diagnostics.zip file is displayed.

6. Click the download icon to save the zip file to your local drive.