public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Clean up Explore documentation (#64908)

Browse Source 
* Remove the info about custom Prometheus Query Editor as it's not relevant since #60020

* Update basic Explore documentation

* Change graphs and tables to visualizations as Explore supports different types of visualization

* Make clear "Starred" refers to a tab

* Update how to select start/end date for query history

* Remove Prometheus specific section as it's no longer relevant. Prometheus query editor is documented in https://grafana.com/docs/grafana/latest/datasources/prometheus/query-editor/#metrics-browser

* Add informational log level (added in #30942)

* Use more direct language

* Fix a link

* Make headers more consistent

* Minor tweaks

* Update docs/sources/explore/explore-inspector.md

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>

* Do not enumerate bullet points

* Fix incorrect header type

* Update tracing headers

* Link to more info about Mixed data source

* Use "data source" instead of "datasource"

* Fix tracing headers

* Fix more log headers

* Update docs/sources/explore/explore-inspector.md

Co-authored-by: J Stickler <julie.stickler@grafana.com>

---------

Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
This commit is contained in:
Piotr Jamróz
2023-03-28 21:53:17 +02:00
committed by GitHub
co-authored by Eve Meelan J Stickler
parent 4b29b1d741
commit ae3be459f0
5 changed files with 26 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/explore/query-management.md
+2 -28
View File
@@ -33,7 +33,7 @@ Query history lets you view the history of your querying. For each individual qu
### 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.
All queries that have been starred in the Query history tab are displayed in the Starred tab. This allows you to access your favorite queries faster and to reuse these queries without typing them from scratch.
### Sort query history
@@ -54,7 +54,7 @@ Filter query history in Query history and Starred tab by data source name:
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 bottom handle, adjust start date.
- By dragging top handle, adjust end date.
### Search in query history
@@ -73,29 +73,3 @@ You can customize the query history in the Settings tab. Options are described i
| Change the default active tab | Query history tab |
> **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.
{{< figure src="/static/img/docs/v65/explore_metric_explorer.png" class="docs-image--no-shadow" max-width= "800px" caption="Screenshot of the new Explore option in the panel menu" >}}
### Query field
The Query field supports autocomplete for metric names and functions, comparable to the standard Prometheus query editor. Press the Enter key to create a new line and Shift+Enter 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.