The list widget displays a list of events and issues, which can come from a variety of sources such as Logs, RUM, or Events. Search and query across sources to narrow down the events you want the widget to highlight and display.

List widget displaying error tracking issues

Setup

Configuration

1. Choose the type of data to graph. You can create a list widget from Issues, Logs, Audit Trail, Watchdog Alerts, or Events depending on which products are available for your organization.

2. Set display preferences. On screenboards and notebooks, choose whether your widget has a custom timeframe or uses the global timeframe.

3. Optional: Give your graph a title (or leave blank for suggested title).

Options

Each type of list widget has its own configuration.

Issues

Sorting by

For issues, you can sort by:

• Number of errors (default)
• First seen
• Impacted sessions

Note: Changing the “Sorting by” selection does not change the columns displayed. If you change your list to sort by impacted sessions, and want to see this on your widget, you must also select or add “Impacted Sessions” to the graph editor.

Logs

Grouping by

For logs, you can group by:

• Patterns
• Transactions

RUM event list options

Sorting by

For RUM, you can sort by:

• Session type
• Time spent
• View count
• Error count
• Action count
• Session frustration count
• Initial view name
• Last view name

Ascending or descending

Events

Report format size:

For Events, you can choose how they’re displayed in the widget:

• Small (title only)
• Large (full event)

Incidents

Sorting by

For incidents, you can sort by:

• Created time
• Severity
• Status

Ascending or descending

API

This widget can be used with the Dashboards API. See the following table for the widget JSON schema definition:

{
  "legend_size": "string",
  "requests": [
    {
      "columns": [
        {
          "field": "content",
          "is_clustering_pattern_field_path": true,
          "width": "compact"
        }
      ],
      "query": {
        "clustering_pattern_field_path": "message",
        "compute": [
          {
            "aggregation": "count",
            "facet": "resource_name"
          }
        ],
        "data_source": "apm_issue_stream",
        "event_size": "string",
        "group_by": [
          {
            "facet": "resource_name"
          }
        ],
        "indexes": [],
        "query_string": "@service:app",
        "sort": {
          "column": "",
          "order": "desc"
        },
        "storage": "indexes"
      },
      "response_format": "event_list"
    }
  ],
  "show_legend": false,
  "time": {
    "live_span": "5m"
  },
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "list_stream"
}

Further Reading

Additional helpful documentation, links, and articles:

Building Dashboards using JSONDOCUMENTATION NotebooksDOCUMENTATION