Documentationbreadcrumb arrow Pluginsbreadcrumb arrow LogicMonitor Devices
Grafana Cloud Enterprise
LogicMonitor Devices data source plugin

LogicMonitor Devices data source plugin

LogicMonitor Devices Grafana Enterprise data source plugin

The LogicMonitor Devices data source allows you to query and visualize LogicMonitor device metrics in Grafana.

Note

Grafana LogicMonitor Devices enterprise data source plugin is currently in public preview. Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.

Note

The LogicMonitor Devices data source is an Enterprise plugin. It is available with Grafana Cloud (Free, Pro, and Advanced tiers) and Grafana Enterprise. For installation instructions, refer to Install Grafana Enterprise plugins.

Supported features

FeatureSupported
MetricsYes
LogsNo
TracesNo
AlertingYes
AnnotationsYes

Before you begin

Before configuring the LogicMonitor Devices data source, ensure you have:

Install the plugin

To install the data source, refer to the Installation guide.

Configure the data source

To add the LogicMonitor Devices data source:

  1. Click Connections in the left-side menu.
  2. Click Add new connection.
  3. Type LogicMonitor in the search bar.
  4. Select LogicMonitor Devices.
  5. Click Add new data source.

Basic settings

SettingDescription
NameA name for this LogicMonitor data source instance.
Account NameYour LogicMonitor account name. For foo.logicmonitor.com, enter foo.

Authentication

This plugin supports bearer token–based authentication. To create a token:

  1. Log in to your LogicMonitor portal.
  2. Navigate to Settings > Users and Roles.
  3. (Optional) Add a new user with a readonly role if one doesn’t already exist.
  4. Go to the Bearer Tokens tab.
  5. Create a new token for the associated user.
SettingDescription
TokenYour LogicMonitor REST API v3 bearer token.

Verify the connection

Click Save & test to verify the connection. A successful test displays the message “health check succeeded for ‘metrics usage details’ query”. If the connection fails, refer to Troubleshoot LogicMonitor data source issues.

Provision the data source

You can configure this data source using configuration files with the Grafana provisioning system. For more information, refer to Provisioning Grafana data sources.

Example provisioning configuration:

YAML
apiVersion: 1
datasources:
  - name: LogicMonitor
    type: grafana-logicmonitor-datasource
    jsonData:
      variables:
        account_name: <ACCOUNT_NAME>
      authMethod: bearer
    secureJsonData:
      logicmonitor.token: <TOKEN>

Replace <ACCOUNT_NAME> with your LogicMonitor account name and <TOKEN> with your LogicMonitor REST API v3 bearer token.

Provision the data source with Terraform

You can configure this data source using the Grafana Terraform provider.

hcl
resource "grafana_data_source" "logicmonitor" {
  type = "grafana-logicmonitor-datasource"
  name = "LogicMonitor"

  json_data_encoded = jsonencode({
    variables = {
      account_name = "<ACCOUNT_NAME>"
    }
    authMethod = "bearer"
  })

  secure_json_data_encoded = jsonencode({
    "logicmonitor.token" = "<TOKEN>"
  })
}

Replace <ACCOUNT_NAME> with your LogicMonitor account name and <TOKEN> with your LogicMonitor REST API v3 bearer token.

Query the data source

The query editor allows you to run queries by selecting an Action Type and providing the required parameters.

Device Instance Data

Retrieve time series data for individual device instances.

FieldRequiredDescription
DeviceYesSelect a device from your LogicMonitor account.
DatasourceYesSelect a data source associated with the device.
InstanceYesSelect an instance within the data source.
DataPointsNoSelect specific data points to retrieve. If not specified, all data points are returned.

Device Instance Data by Device Group

Retrieve time series data for devices within a specific device group.

FieldRequiredDescription
Device GroupYesSelect a device group from your LogicMonitor account.
DeviceYesSelect a device within the group.
DatasourceYesSelect a data source associated with the device.
InstanceYesSelect an instance within the data source.
DataPointsNoSelect specific data points to retrieve.

Table queries

Use these query types to retrieve and display data in table format:

  • Devices: Lists all available devices in your LogicMonitor account.
  • Datasources: Lists all data sources within a selected device.
  • Instances: Lists all instances within a selected device and data source.

Use Explore

Use Explore to run queries and visualize results without building a dashboard. For more information, refer to Explore.

Query examples

The following examples show common use cases for querying LogicMonitor data.

Monitor CPU utilization

To monitor CPU performance for a specific device:

  1. Select Device Instance Data as the action type.
  2. Select your target device from the Device drop-down.
  3. Select CPU from the Datasource drop-down.
  4. Select the CPU instance from the Instance drop-down.
  5. (Optional) Select specific data points like cpu_utilization from DataPoints.

Compare devices across a group

To compare metrics across all devices in a group:

  1. Select Device Instance Data by Device Group as the action type.
  2. Select your device group from the Device Group drop-down.
  3. Select a device, data source, and instance.
  4. Duplicate the query for each device you want to compare.

Template variables

Use template variables to create dynamic, reusable dashboards.

To add a LogicMonitor query variable:

  1. Navigate to Dashboard settings > Variables.
  2. Click Add variable.
  3. Select Query as the variable type.
  4. Select the LogicMonitor Devices data source.
  5. Enter your query.

For more information about adding query variables, refer to Add a query variable.

After creating a variable, use it in your LogicMonitor queries with variable syntax. For more information, refer to Templates and variables.

Set up alerting

The LogicMonitor Devices data source supports Grafana alerting on Device Instance Data metrics.

To create an alert rule:

  1. Create a panel with a LogicMonitor Device Instance Data query.
  2. Click Alert in the panel edit view.
  3. Click Create alert rule from this panel.
  4. Configure the alert conditions based on your LogicMonitor metrics.
  5. Set notification policies and contact points.

For more information about Grafana alerting, refer to Grafana Alerting.

Add annotations

Annotations allow you to mark points on a graph with rich events. You can use LogicMonitor data to create annotations on your dashboards.

To add an annotation query:

  1. Navigate to Dashboard settings > Annotations.
  2. Click Add annotation query.
  3. Select the LogicMonitor Devices data source.
  4. Configure a query that returns the events you want to annotate.

For more information about annotations, refer to Annotate visualizations.

Troubleshoot LogicMonitor data source issues

This section provides solutions to common issues when configuring or using the LogicMonitor Devices data source.

Authentication errors

Error messageCauseSolution
“Account Name missing”Account name not providedEnter your LogicMonitor account name in the configuration.
“invalid/empty bearer token”Token field is emptyEnter your LogicMonitor REST API v3 bearer token.
“health check failed… (status code: 401)”Invalid or expired tokenVerify your token is correct and hasn’t expired. Generate a new token in LogicMonitor if needed.
“no such host”Incorrect account nameVerify the account name matches your LogicMonitor portal URL. For foo.logicmonitor.com, use foo.

Query errors

Error messageCauseSolution
Missing parameter errorRequired fields not selectedSelect values for all required fields (Device, Datasource, Instance) before running the query.
No data returnedTime range or permissions issueVerify data exists for the selected time range and that your token has read permissions.

Get additional help

If you’ve tried the solutions in this document and still encounter issues:

When reporting issues, include:

  • Grafana version
  • LogicMonitor plugin version
  • Error messages (redact sensitive information)
  • Steps to reproduce
  • Data source configuration (redact credentials)

Plugin updates

Always ensure that your plugin version is up-to-date so you have access to all current features and improvements. Navigate to Plugins and data > Plugins to check for updates. Grafana recommends upgrading to the latest Grafana version, and this applies to plugins as well.

Note

Plugins are automatically updated in Grafana Cloud.

Learn more