Diagnostic Operation for Resources

LogicMonitor enables you to run user created and LogicMonitor supported out-of-the-box DiagnosticSource modules to fetch diagnostic data to help troubleshoot issues directly from a Resource. You can run multiple DiagnosticSources at the same time across one or more resources, but the same module cannot be run in parallel on a single resource.

LogicMonitor supports the following execution status for a DiagnosticSource module:

When the DiagnosticSource execution is complete, you can view the result generated by the script. You can view the execution history of a resource for a specific time range. The history of DiagnosticSources provides details of the issues and the diagnosis performed to identify the root cause. 

You can view the output in JSON or plain text format. You can select the format that suits your needs. Details of the supported formats are as follows: 

• JSON format—In the JSON format, the rendered output is contained in a “data” field. Most LogicMonitor supported DiagnosticSources provide output in JSON format to avoid issues with special characters, multiple languages, and to allow potential for future metadata for specifying rendering (html, markdown, and so on). 
  The following displays an example output in JSON format:

{
  "format": "md",
  "data": "|%CPU|COMMAND|\n|----|-------|\n|4.0 |systemd|\n|1.0 |sshd   |"
}

• Plain text format—If the output is not a valid JSON in the “data” field, the output falls back to the plain text format.

Requirements for Running DiagnosticSource

To run a DiagnosticSource module, you need the following:

• The Security settings configured by enabling the Allow Execution of Diagnostic Sources switch to run DiagnosticSources
  For more information, see Security Settings.
• A LogicMonitor user with Diagnostics: Execute permissions for the resource group in the Resources permission set
  For more information, see Resources Role Permissions.
• EA Collector 38.400 or later installed
  For more information, see Adding Collector.
• DiagnosticSource modules in My Module Toolbox and applied to the resources
  For more information, see Configuring DiagnosticSource.
• Resources including cloud resources monitored by local Collectors
  For more information, see Enabling Cloud Monitoring using Local Collector.

Running DiagnosticSource

1. In LogicMonitor, navigate to Resource Tree.
2. Locate the resource to which a DiagnosticSource module is applied.
3. Select the Diagnostics tab.
4. In the Actions column, select Run for the DiagnosticSource that you want to run.

The system runs the DiagnosticSource module and updates the execution status as In Progress.

When the process is complete, you can view the latest output in the Overview tab.

Viewing DiagnosticSource Run Result

1. In LogicMonitor, navigate to Resource Tree.
2. Locate the resource to which a DiagnosticSource module is applied.
3. Select the Diagnostics tab.
4. Select a DiagnosticSource.
   By default, the Overview tab displays the following details:
   • Name of the DiagnosticSource
   • Recent execution status
   • Date and time when the DiagnosticSource run started and ended
   • Username of the user who triggered the DiagnosticSource 
   • Output details
   • Option to view output in fullscreen mode, download, and copy the output
     
5. Select the History tab.
   
6. (Optional) Select a time range.
7.  Select a record to view the run history.