Generate diagnostics for your Lightrun deployments¶

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 to generate based on the following main categories:

Note that starting from version 1.57, on-premise users with the ROLE_MANAGER are treated administrators and have full permissions to generate all report types.

• General Information – Available to admins only
• Server Logs – Available to all users
• Agent Logs – Available to all users
• Plugin Logs – Available to admins only

List of available reports¶

Reports are generated and displayed as JSON files, categorized by Lightrun roles:

• Admins have access to all reports.
• Managers have access to manager-level reports as well as user reports.
• Users have access only to user reports.

Admins (Includes all reports)¶

• FEATURE_TOGGLES.json – Lists all feature flags, their enabled/disabled status, and associated parameters.
• ENVIRONMENT_VARIABLES.json – Lists environment variables set on the Lightrun server. Sensitive information is redacted.
• KEYCLOAK.json – Lists Keycloak parameters configured in the system.
• DB_TABLES_INFO.json – Lists Lightrun database details, including size and table names. Data within the tables is not included.
• SERVER_LOGS.json – Lists logs related to server operations.
• K8S_INFO – Lists a set of JSON files detailing system resources. Example file: k8s-operator-controller-manager-xxx.json. Supported from version 1.54.

Managers (Includes manager and user reports)¶

• LICENSES_INFO.json – Lists agent count, user count, and license expiry date.
• INTEGRATIONS.json – Lists Lightrun integrations configured in the system.
• AGENTS.json – Lists the agent count by runtime environment and version.
• PLUGINS.json – Lists Lightrun plugins connected to IDEs in your organization, including plugin counts by version and IDE version.
• ACTIONS_INFO.json – Lists information by action type, including active action count, average hit size for logs and snapshots, max hit size, first and last hits, and total hit counts.
• USAGE_INFO.json – Lists the number of active users, agent pools, and usage statistics by agent pool.

Users (Access to user reports only)¶

• AGENTS.json – Lists the agent count by runtime environment and version.
• PLUGINS.json – Lists Lightrun plugins connected to IDEs in your organization, including plugin counts by version and IDE version.

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 Logs: Select the user for whom logs will be generated.

4. [Starting from version 1.56] Select the Sanitize sensitive data checkbox to replace sensitive data with sanitized values ensuring privacy.

5. [Starting from version 1.55] Set the debug level for server logs.

   As an administrator, enable the Set Log Level to Debug toggle, select Server.

6. [Starting from version 1.57] Set the debug level for agent logs. The debug level is set for all agents, bug logs are collected only from the top 5 most active agents.

   As an administrator, enable the Set Log Level to Debug toggle, select Agents, and select an agent from the list.

7. click Apply.

8. Click Generate.

   A message will indicate that the data is being generated.

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

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