grafana/docs/sources/explore/explore-inspector.md
Jack Baldry 7eb17bccca
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/enterprise-licensing pages to have 'Enterprise' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/recorded-queries pages to have labels cloud,enterprise

* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set administration/stats-and-license pages to have labels cloud,enterprise

* Set alerting pages to have labels cloud,enterprise,oss

* Set breaking-changes pages to have labels cloud,enterprise,oss

* Set dashboards pages to have labels cloud,enterprise,oss

* Set datasources pages to have labels cloud,enterprise,oss

* Set explore pages to have labels cloud,enterprise,oss

* Set fundamentals pages to have labels cloud,enterprise,oss

* Set introduction/grafana-cloud pages to have labels cloud

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix introduction pages products

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set panels-visualizations pages to have labels cloud,enterprise,oss

* Set release-notes pages to have labels cloud,enterprise,oss

* Set search pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss

* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise

* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Set troubleshooting pages to have labels cloud,enterprise,oss

* Set whatsnew pages to have labels cloud,enterprise,oss

* Apply updated labels from review

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 09:10:12 +01:00

3.9 KiB

labels title weight
products
cloud
enterprise
oss
Inspector in Explore 400

Inspector in Explore

The inspector helps you understand and troubleshoot your queries. You can inspect the raw data, export that data to a comma-separated values (CSV) file, export log results in TXT format, and view query requests.

Inspector UI

The inspector has following tabs:

  • Stats tab - Shows how long your query takes and how much it returns.
  • Query tab - Shows you the requests to the server sent when Grafana queries the data source.
  • JSON tab - Allows you to view and copy the data JSON and data frame structure JSON.
  • Data tab - Shows the raw data returned by the query.
  • Error tab - Shows the error. Only visible when query returns error.

Inspector tasks

You can perform a variety of tasks in the Explore inspector.

Open the Inspector

  1. Run the query you would like to inspect.
  2. Click the Inspector button.

The inspector pane opens on the bottom of the screen.

Inspect raw query results

You can view raw query results, that is the data returned by the query in a table.

In the Inspector tab, click the Data tab.

For multiple queries or for queries multiple nodes, there are additional options.

  • Show data frame: Select the result set data you want to view.
  • Series joined by time: View the raw data from all of your queries at once, one result set per column. You can click a column heading to sort the data.

Download raw query results as CSV

Grafana generates a CSV file in your default browser download location. You can open it in the viewer of your choice.

  1. In the Inspector tab, get raw query results by following the instructions described in Inspect raw query results.
  2. Refine query settings until you can see the raw data that you want to export.
  3. Click Download CSV.

In order to download a CSV file specifically formatted for Excel, expand Data options and then enable the Download for Excel toggle before you click the Download CSV option.

Download log results as TXT

Grafana generates a TXT file in your default browser download location. You can open it in the viewer of your choice.

  1. Open the inspector.
  2. Inspect the log query results as described above.
  3. Click Download logs.

Download trace results

Based on the data source type, Grafana generates a JSON file for the trace results in one of the supported formats: Jaeger, Zipkin, or OTLP formats.

  1. Open the inspector.
  2. Inspect the trace query results as described above.
  3. Click Download traces.

Inspect query performance

The Stats tab displays statistics that tell you how long your query takes, how many queries you send, and the number of rows returned. This information can help you troubleshoot your queries, especially if any of the numbers are unexpectedly high or low.

  1. Open the inspector.
  2. Navigate to the Stats tab.

Statistics are displayed in read-only format.

View JSON model

You can explore and export data as well as data frame JSON models.

  1. In the Inspector panel, click the JSON tab.
  2. From the Select source dropdown, choose one of the following options:
    • Data - Displays a JSON object representing the data that was returned to Explore.
    • DataFrame structure - Displays the raw result set.
  3. You can expand or collapse portions of the JSON to view separate sections. You can also click the Copy to clipboard option to copy JSON body and paste it into another application.

View raw request and response to data source

  1. Open the panel inspector and then click the Query tab.
  2. Click Refresh.

Grafana sends the query to the server and displays the result. You can drill down on specific portions of the query, expand or collapse all of it, or copy the data to the clipboard to use in other applications.