grafana/docs/sources/explore/index.md
Diana Payton e9e16cee6d
Docs: Grafana whats new 7.4 (#30404)
* Create whats-new-in-v7-4.md

* Update whats-new-in-v7-4.md

* Update types-options.md

* Update whats-new-in-v7-4.md

* Updated image paths

* minor edits

* updates

* content updates

* Update docs/sources/whatsnew/whats-new-in-v7-4.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

* Update docs/sources/whatsnew/whats-new-in-v7-4.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
2021-01-19 16:39:45 -08:00

20 KiB
Raw Blame History

+++ title = "Explore" keywords = ["explore", "loki", "logs"] aliases = ["/docs/grafana/latest/features/explore/"] weight = 90 +++

Explore

Grafana's dashboard UI is all about building dashboards for visualization. Explore strips away all the dashboard and panel options so that you can focus on the query. Iterate until you have a working query and then think about building a dashboard.

Explore is only available in Grafana 6.0 and above.

For infrastructure monitoring and incident response, you no longer need to switch to other tools to debug what went wrong. Explore allows you to dig deeper into your metrics and logs to find the cause. Grafana's new logging data source, Loki is tightly integrated into Explore and allows you to correlate metrics and logs by viewing them side-by-side. This creates a new debugging workflow where you can:

  1. Receive an alert
  2. Drill down and examine metrics
  3. Drill down again and search logs related to the metric and time interval (and in the future, distributed traces)

If you just want to explore your data and do not want to create a dashboard, then Explore makes this much easier. If your data source supports graph and table data, then Explore shows the results both as a graph and a table. This allows you to see trends in the data and more details at the same time.

Start exploring

Note: By default, users with the Viewer role cannot edit and do not have access to Explore. Refer to Organization roles for more information about what each role has access to.

There is an Explore icon on the menu bar to the left. This opens an empty Explore tab.

{{< docs-imagebox img="/img/docs/v65/explore_menu.png" class="docs-image--no-shadow" caption="Screenshot of the new Explore Icon" >}}

If you want to start with an existing query in a panel, choose the Explore option from the Panel menu. This opens an Explore tab with the query from the panel and allows you to tweak or iterate in the query outside of your dashboard.

{{< docs-imagebox img="/img/docs/v65/explore_panel_menu.png" class="docs-image--no-shadow" caption="Screenshot of the new Explore option in the panel menu" >}}

Choose your data source from the dropdown in the top left. Prometheus has a custom Explore implementation, the other data sources use their standard query editor.

The query field is where you can write your query and explore your data. There are three buttons beside the query field, a clear button (X), an add query button (+) and the remove query button (-). Just like the normal query editor, you can add and remove multiple queries.

Split and compare

The split view feature is an easy way to compare graphs and tables side-by-side or to look at related data together on one page. Click the split button to duplicate the current query and split the page into two side-by-side queries. It is possible to select another data source for the new query which for example, allows you to compare the same query for two different servers or to compare the staging environment to the production environment.

{{< docs-imagebox img="/img/docs/v65/explore_split.png" class="docs-image--no-shadow" caption="Screenshot of the new Explore option in the panel menu" >}}

In split view, timepickers for both panels can be linked (if you change one, the other gets changed as well) by clicking on one of the time-sync buttons attached to the timepickers. Linking of timepickers helps with keeping the start and the end times of the split view queries in sync and it will ensure that youre looking at the same time interval in both split panels.

You can close the newly created query by clicking on the Close Split button.

Share shortened link is only available in Grafana 7.3 and above.

The Share shortened link capability allows you to create smaller and simpler URLs of the format /goto/:uid instead of using longer URLs containing complex query parameters. You can create a shortened link by clicking on the Share option in Explore toolbar. Please note that any shortened links that are never used will be automatically deleted after 7 days.

Query history

Query history is a list of queries that you have used in Explore. The history is local to your browser and is not shared. To open and interact with your history, click the Query history button in Explore.

View query history

Query history lets you view the history of your querying. For each individual query, you can:

  • Run a query.
  • Create and/or edit a comment.
  • Copy a query to the clipboard.
  • Copy a shortened link with the query to the clipboard.
  • Star a query.

Manage favorite queries

All queries that have been starred in the Query history tab are displayed in the Starred. This allows you to access your favorite queries faster and to reuse these queries without typing them from scratch.

Sort query history

By default, query history shows you the most recent queries. You can sort your history by date or by data source name in ascending or descending order.

  1. Click the Sort queries by field.
  2. Select one of the following options:
    • Newest first
    • Oldest first
    • Data source A-Z
    • Data source Z-A

Note: If you are in split mode, then the chosen sorting mode applies only to the active panel.

Filter query history

Filter query history in Query history and Starred tab by data source name:

  1. Click the Filter queries for specific data source(s) field.
  2. Select the data source for which you would like to filter your history. You can select multiple data sources.

In Query history tab it is also possible to filter queries by date using the slider:

  • Use vertical slider to filter queries by date.
  • By dragging top handle, adjust start date.
  • By dragging top handle, adjust end date.

Note: If you are in split mode, filters are applied only to your currently active panel.

Search in query history

You can search in your history across queries and your comments. Search is possible for queries in the Query history tab and Starred tab.

  1. Click the Search queries field.
  2. Type the term you are searching for into search field.

Query history settings

You can customize the query history in the Settings tab. Options are described in the table below.

Setting Default value
Period of time for which Grafana will save your query history 1 week
Change the default active tab Query history tab
Only show queries for data source currently active in Explore True
Clear query history Permanently deletes all stored queries.

Note: Query history settings are global, and applied to both panels in split mode.

Prometheus-specific Features

The first version of Explore features a custom querying experience for Prometheus. When a query is executed, it actually executes two queries, a normal Prometheus query for the graph and an Instant Query for the table. An Instant Query returns the last value for each time series which shows a good summary of the data shown in the graph.

Metrics explorer

On the left side of the query field, click Metrics to open the Metric Explorer. This shows a hierarchical menu with metrics grouped by their prefix. For example, all Alertmanager metrics are grouped under the alertmanager prefix. This is a good starting point if you just want to explore which metrics are available.

{{< docs-imagebox img="/img/docs/v65/explore_metric_explorer.png" class="docs-image--no-shadow" caption="Screenshot of the new Explore option in the panel menu" >}}

Query field

The Query field supports autocomplete for metric names, function and works mostly the same way as the standard Prometheus query editor. Press the enter key to execute a query.

The autocomplete menu can be triggered by pressing Ctrl+Space. The Autocomplete menu contains a new History section with a list of recently executed queries.

Suggestions can appear under the query field - click on them to update your query with the suggested change.

  • For counters (monotonically increasing metrics), a rate function will be suggested.
  • For buckets, a histogram function will be suggested.
  • For recording rules, possible to expand the rules.

Table filters

Click on the filter button in the "label" column of a Table panel to add filters to the query expression. You can add filters for multiple queries as well - the filter is added for all the queries.

Logs integration

Along with metrics, Explore allows you to investigate your logs with the following data sources:

Logs visualization

Results of log queries are shown as histograms in the graph and individual logs are displayed below. If the data source does not send histogram data for the requested time range, the logs model computes a time series based on the log row counts bucketed by an automatically calculated time interval and the start of the histogram is then anchored by the first log row's timestamp from the result. The end of the time series is anchored to the time picker's To range.

Log level

For logs where a level label is specified, we use the value of the label to determine the log level and update color accordingly. If the log doesn't have a level label specified, we parse the log to find out if its content matches any of the supported expressions (see below for more information). The log level is always determined by the first match. In case Grafana is not able to determine a log level, it will be visualized with unknown log level.

Supported log levels and mapping of log level abbreviation and expressions:

Supported expressions Log level Color
emerg critical purple
fatal critical purple
alert critical purple
crit critical purple
critical critical purple
err error red
eror error red
error error red
warn warning yellow
warning warning yellow
info info green
information info green
notice info green
dbug debug blue
debug debug blue
trace trace light blue
* unknown grey

Visualization options

You can customize how logs are displayed and select which columns are shown.

Time

Shows or hides the time column. This is the timestamp associated with the log line as reported from the data source.

Unique labels

Shows or hides the unique labels column that includes only non-common labels. All common labels are displayed above.

Wrap lines

Set this to True if you want the display to use line wrapping. If set to False, it will result in horizontal scrolling.

Deduping

Log data can be very repetitive and Explore can help by hiding duplicate log lines. There are a few different deduplication algorithms that you can use:

  • Exact - Exact matches are done on the whole line except for date fields.
  • Numbers - Matches on the line after stripping out numbers such as durations, IP addresses, and so on.
  • Signature - The most aggressive deduping, this strips all letters and numbers and matches on the remaining whitespace and punctuation.

Flip results order

You can change the order of received logs from the default descending order (newest first) to ascending order (oldest first).

Labels and detected fields

Each log row has an extendable area with its labels and detected fields, for more robust interaction. For all labels we have added the ability to filter for (positive filter) and filter out (negative filter) selected labels. Each field or label also has a stats icon to display ad-hoc statistics in relation to all displayed logs.

Toggle detected fields

Note: This feature is only available in Grafana 7.2+.

If your logs are structured in json or logfmt, then you can show or hide detected fields. Expand a log line and then click the eye icon to show or hide fields.

{{< docs-imagebox img="/img/docs/explore/parsed-fields-7-2.gif" max-width="800px" caption="Toggling detected fields in Explore" >}}

Loki-specific features

As mentioned, one of the log integrations is for the new open source log aggregation system from Grafana Labs - Loki. Loki is designed to be very cost effective, as it does not index the contents of the logs, but rather a set of labels for each log stream. The logs from Loki are queried in a similar way to querying with label selectors in Prometheus. It uses labels to group log streams which can be made to match up with your Prometheus labels. For more information about Grafana Loki, refer to Grafana Loki or the Grafana Labs hosted variant: Grafana Cloud Logs.

See Loki's data source documentation on how to query for log data.

Switch from metrics to logs

If you switch from a Prometheus query to a logs query (you can do a split first to have your metrics and logs side by side) then it will keep the labels from your query that exist in the logs and use those to query the log streams. For example, the following Prometheus query:

grafana_alerting_active_alerts{job="grafana"}

after switching to the Logs data source, the query changes to:

{job="grafana"}

This will return a chunk of logs in the selected time range that can be grepped/text searched.

Live tailing

Use the Live tailing feature to see real-time logs on supported data sources.

Click the Live button in the Explore toolbar to switch to Live tail view.

While in Live tail view new logs will come from the bottom of the screen and will have fading contrasting background so you can keep track of what is new. Click the Pause button or scroll the logs view to pause the Live tailing and explore previous logs without interruption. Click Resume button to resume the Live tailing or click Stop button to exit Live tailing and go back to standard Explore view.

{{< docs-imagebox img="/img/docs/v64/explore_live_tailing.gif" class="docs-image--no-shadow" caption="Explore Live tailing in action" >}}

Tracing integration

Only available in Grafana v7.0+.

You can visualize traces from tracing data sources in explore. Data sources currently supported:

  • [Jaeger]({{< relref "../datasources/jaeger.md" >}})
  • [Zipkin]({{< relref "../datasources/zipkin.md" >}})
  • [Tempo]({{< relref "../datasources/tempo.md" >}})
  • X-Ray

For information about how to use the query editor see documentation for specific data source.

{{< docs-imagebox img="/img/docs/v70/explore-trace-view-full.png" class="docs-image--no-shadow" caption="Screenshot of the trace view" >}}

Header

{{< docs-imagebox img="/img/docs/v70/explore-trace-view-header.png" class="docs-image--no-shadow" caption="Screenshot of the trace view header" >}}

  • Header title: Shows the name of the root span and trace ID.
  • Search: Highlights spans containing the searched text.
  • Metadata: Various metadata about the trace.
Minimap

{{< docs-imagebox img="/img/docs/v70/explore-trace-view-minimap.png" class="docs-image--no-shadow" caption="Screenshot of the trace view minimap" >}}

Shows condensed view or the trace timeline. Drag your mouse over the minimap to zoom into smaller time range. Zooming will also update the main timeline, so it is easy to see shorter spans. Hovering over the minimap, when zoomed, will show Reset Selection button which resets the zoom.

Timeline

{{< docs-imagebox img="/img/docs/v70/explore-trace-view-timeline.png" class="docs-image--no-shadow" caption="Screenshot of the trace view timeline" >}}

Shows list of spans within the trace. Each span row consists of these components:

  • Expand children button: Expands or collapses all the children spans of selected span.
  • Service name: Name of the service logged the span.
  • Operation name: Name of the operation that this span represents.
  • Span duration bar: Visual representation of the operation duration within the trace.

Clicking anywhere on the span row shows span details.

Span details

{{< docs-imagebox img="/img/docs/v70/explore-trace-view-span-details.png" class="docs-image--no-shadow" caption="Screenshot of the trace view span details" >}}

  • Operation name
  • Span metadata
  • Tags: Any tags associated with this span.
  • Process metadata: Metadata about the process that logged this span.
  • Logs: List of logs logged by this span and associated key values. In case of Zipkin logs section shows Zipkin annotations.
Trace to logs

This feature is only available in Grafana 7.4+.

You can navigate from a span in a trace view directly to logs relevant for that span. This is available for Tempo, Jaeger, and Zipkin data source at this moment. See their relevant documentation for instruction how to configure this feature.

Trace to logs

Click the document icon to open a split view in Explore with the configured data source and query relevant logs for the span.

Navigate between Explore and a dashboard

To help accelerate workflows that involve regularly switching from Explore to a dashboard and vice-versa, we've added the ability to return to the origin dashboard after navigating to Explore from the panel's dropdown.

{{< docs-imagebox img="/img/docs/v64/panel_dropdown.png" class="docs-image--no-shadow" caption="Screenshot of the panel dropdown" >}}

After you've navigated to Explore, you should notice a "Back" button in the Explore toolbar.

{{< docs-imagebox img="/img/docs/v64/explore_toolbar.png" class="docs-image--no-shadow" caption="Screenshot of the explore toolbar" >}}

Simply clicking the button will return you to the origin dashboard, or, if you'd like to bring changes you make in Explore back to the dashboard, simply click the arrow next to the button to reveal a "Return to panel with changes" menu item.

{{< docs-imagebox img="/img/docs/v64/explore_return_dropdown.png" class="docs-image--no-shadow" caption="Screenshot of the expanded explore return dropdown" >}}

Query inspector

To help with debugging queries, Explore allows you to investigate query requests and responses, as well as query statistics, via the Query inspector. This functionality is similar to the panel inspector [Stats tab]({{< relref "../panels/inspect-panel.md#inspect-query-performance" >}}) and [Query tab]({{< relref "../panels/inspect-panel.md##view-raw-request-and-response-to-data-source" >}}).

{{< docs-imagebox img="/img/docs/v71/query_inspector_explore.png" class="docs-image--no-shadow" caption="Screenshot of the query inspector button in Explore" >}}