Import the analytics dashboard into Grafana

You can view the alert and incident analytics from Lightstep Incident Response directly in Grafana by importing or creating a dashboard in Grafana.

Before you begin

Role required: Responder, Manager, or Administrator

About this task

Note: While this integration with a third-party product is supported, the documentation here is based upon information provided by that third-party. More current information about the operation of that third-party’s system may be available from them directly.

Procedure

  1. For the plugin, clone the lightstep-ir-grafana-metrics repository from https://github.com/ServiceNow/lightstep-ir-grafana-metrics.
  2. After cloning, you must:
    1. Move the plugin to Grafana's default plugin directory /usr/local/var/lib/grafana/plugins.
    2. Add the plugin ID lightstep-ir-grafana-metrics to the list of unsigned plugins in the Grafana.ini file found under /usr/local/etc/grafana/grafana.ini.

      Add to list of unsigned plugins.

    3. Restart Grafana.
  3. Log in to Grafana.
  4. Navigate to Configuration > Data Sources.
  5. Click Add data source.
  6. Search for and select the Lightstep Incident Response Metrics plugin.
    Add lightstep plugin as a data source.
  7. In the form, fill in the fields:
    Field Description
    Host Your Lightstep Incident Response application URL. For example, https://<your_subdomain>.airapp.lightstep.com.
    API key API key generated in Incident Response.
    To generate an API key, see Create API keys.
    Important: After generating a key, you must copy and save it somewhere. The key will not be visible again after you leave the page.
    Enter the host and API key.
  8. Click Save & Test.
  9. Click Explore.
    In the Explore page, click Run query to fetch the data.

    The data source receives real-time data from Incident Response. This data is used in the dashboard widgets.

    Explore the LIR plugin data source.

  10. Import the dashboards available in Incident Response:
    1. Navigate to Dashboards > Import.
    2. Click Upload JSON file.
    3. Select the file Lightstep grafana analytics dashboard.json from the lightstep-ir-grafana-metrics repository that you cloned.

      Path: /lightstep-ir-grafana-metrics/template/Lightstep grafana analytics dashboard.json

      Select the dashboard json file.

    4. Click Import.

      Click Import.

Results

The Lightstep Incident Response analytics dashboard becomes available in Grafana.

LIR analytics dashboard.

What to do next

You can create custom dashboards based on your needs using the Lightstep Incident Response data.
  1. Create a dashboard and add a panel. For detailed instructions, see Create a dashboard and add a panel.
  2. In the panel, select the data source as Lightstep Incident Response Metrics.
  3. In the Metric Name field, enter the metric name for the widget you need. The following are available from Incident Response:
    • Source - Alerts per week (Last 90 days): alerts_by_source_per_week
    • Service - Alerts per week (Last 90 days): alerts_by_service_per_week
    • Service - Incidents per week (Last 90 days): incidents_by_service_per_week
    • Alerts - Service and Priority (Last 30 days): alerts_by_service_and_priority
    • Alerts - Team and Assignee (Last 30 days): alerts_by_team_and_assignee
    • Incidents - Team and Assignee (Last 30 days): incidents_by_team_and_assignee

    Create custom dashboard.

  4. Make the required customizations, and then save the panel and the dashboard.

If you want to deploy the Lightstep Incident Response Grafana plugin in the Kubernetes environment, see Grafana Kubernetes deployment.