Fix all the old usage of admonition syntax (#106984)

This commit is contained in:
Jack Baldry
2025-06-19 17:31:13 +01:00
committed by GitHub
parent aecac275f5
commit 244ffad99d
141 changed files with 529 additions and 529 deletions
+2 -2
View File
@@ -84,9 +84,9 @@ For details on data source management, including instructions on how configure u
Before you can create your first dashboard, you need to add your data source.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Only users with the organization admin role can add data sources.
{{% /admonition %}}
{{< /admonition >}}
**To add a data source:**
@@ -68,9 +68,9 @@ Administrators can also [provision the data source](#provision-the-data-source)
Once you've added the data source, you can [configure it](#configure-the-data-source) so that your Grafana instance's users can create queries in its [query editor](query-editor/) when they [build dashboards](ref:build-dashboards) and use [Explore](ref:explore).
{{% admonition type="note" %}}
{{< admonition type="note" >}}
To troubleshoot issues while setting up the CloudWatch data source, check the `/var/log/grafana/grafana.log` file.
{{% /admonition %}}
{{< /admonition >}}
## Configure the data source
@@ -407,9 +407,9 @@ filter @message like /Exception/
| sort exceptionCount desc
```
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If you receive an error like `input data must be a wide series but got ...` when trying to alert on a query, make sure that your query returns valid numeric data that can be output to a Time series panel.
{{% /admonition %}}
{{< /admonition >}}
For more information on Grafana alerts, refer to [Alerting](ref:alerting).
@@ -420,10 +420,10 @@ Pricing for CloudWatch Logs is based on the amount of data ingested, archived, a
Each time you select a dimension in the query editor, Grafana issues a `ListMetrics` API request.
Each time you change queries in the query editor, Grafana issues a new request to the `GetMetricData` API.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Grafana replaced all `GetMetricStatistics` API requests with calls to GetMetricData to provide better support for CloudWatch metric math, and enables the automatic generation of search expressions when using wildcards or disabling the `Match Exact` option.
The `GetMetricStatistics` API qualified for the CloudWatch API free tier, but `GetMetricData` calls don't.
{{% /admonition %}}
{{< /admonition >}}
For more information, refer to the [CloudWatch pricing page](https://aws.amazon.com/cloudwatch/pricing/).
@@ -67,9 +67,9 @@ Open source Grafana enables the `AWS SDK Default`, `Credentials file`, and `Acce
## Assume a role
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Assume a role is required for the Grafana Assume Role.
{{% /admonition %}}
{{< /admonition >}}
You can specify an IAM role to assume in the **Assume Role ARN** field.
@@ -87,9 +87,9 @@ To disable this feature in open source Grafana or Grafana Enterprise, refer to t
### Use an external ID
{{% admonition type="note" %}}
{{< admonition type="note" >}}
You cannot use an external ID for the Grafana Assume Role authentication provider.
{{% /admonition %}}
{{< /admonition >}}
To assume a role in another account that was created with an external ID, specify the external ID in the **External ID** field.
@@ -128,9 +128,9 @@ For more information on why and how to use service endpoints, refer to the [AWS
Create a file at `~/.aws/credentials`, the `HOME` path for the user running the `grafana-server` service.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If you think you have the credentials file in the right location, but it's not working, try moving your `.aws` file to `/usr/share/grafana/` and grant your credentials file at most 0644 permissions.
{{% /admonition %}}
{{< /admonition >}}
### Credentials file example
@@ -159,13 +159,13 @@ securityContext:
## Use Grafana Assume Role
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Grafana Assume Role is currently in [private preview](https://grafana.com/docs/release-life-cycle/) for Grafana Cloud.
It's currently only available for Amazon CloudWatch.
To gain early access to this feature, contact Customer Support and ask for the `awsDatasourcesTempCredentials` feature toggle to be enabled on your account.
{{% /admonition %}}
{{< /admonition >}}
The Grafana Assume Role authentication provider lets you authenticate with AWS without having to create and maintain long term AWS users or rotate their access and secret keys. Instead, you can create an IAM role that has permissions to access CloudWatch and a trust relationship with Grafana's AWS account. Grafana's AWS account then makes an STS request to AWS to create temporary credentials to access your AWS data. It makes this STS request by passing along an `externalID` that's unique per Cloud account, to ensure that Grafana Cloud users can only access their own AWS data. For more information, refer to the [AWS documentation on external ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html).
@@ -111,9 +111,9 @@ For details on the available functions, refer to [AWS Metric Math](https://docs.
For example, to apply arithmetic operations to a metric, apply a unique string id to the raw metric, then use this id and apply arithmetic operations to it in the Expression field of the new metric.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If you use the expression field to reference another query, like `queryA * 2`, you can't create an alert rule based on that query.
{{% /admonition %}}
{{< /admonition >}}
#### Period macro
@@ -192,9 +192,9 @@ The suggestions appear after typing a space, comma, or dollar (`$`) character, o
{{< figure src="/static/img/docs/cloudwatch/cloudwatch-code-editor-autocomplete-8.3.0.png" max-width="500px" class="docs-image--right" caption="Code editor autocomplete" >}}
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Template variables in the code editor can interfere with autocompletion.
{{% /admonition %}}
{{< /admonition >}}
To run the query, click **Run query** above the code editor.
@@ -66,9 +66,9 @@ In contrast, Azure Monitor Logs can store a variety of data types, each with the
1. Select a resource from which to query metrics by using the subscription, resource group, resource type, and resource fields. Multiple resources can also be selected as long as they belong to the same subscription, region and resource type. Note that only a limited amount of resource types support this feature.
1. To select a different namespace than the default—for instance, to select resources like storage accounts that are organized under multiple namespaces—use the **Namespace** option.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Not all metrics returned by the Azure Monitor Metrics API have values.
{{% /admonition %}}
{{< /admonition >}}
> The data source retrieves lists of supported metrics for each subscription and ignores metrics that never have values.
@@ -139,10 +139,10 @@ The Azure Monitor data source also supports querying of [Basic Logs](https://lea
1. Select a resource to query. Multiple resources can be selected as long as they are of the same type.
Alternatively, you can dynamically query all resources under a single resource group or subscription.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If a timespan is specified in the query, the overlap of the timespan between the query and the dashboard will be used as the query timespan. See the [API documentation for
details.](https://learn.microsoft.com/en-us/rest/api/loganalytics/dataaccess/query/get?tabs=HTTP#uri-parameters)
{{% /admonition %}}
{{< /admonition >}}
1. Enter your KQL query.
@@ -155,10 +155,10 @@ You can also augment queries by using [template variables](../template-variables
1. Select the **Logs** service.
1. Select a resource to query. Multiple resources can be selected as long as they are of the same type.
1. Switch the `Logs` toggle from `Analytics` to `Basic`. A modal will display to notify users of potential additional costs.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Basic Logs queries do not support time-ranges specified in the query. The time-range will be hardcoded to the dashboard time-range. There are also other query limitations. See the
[documentation for details.](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/basic-logs-query?tabs=portal-1#limitations)
{{% /admonition %}}
{{< /admonition >}}
1. Enter your KQL query.
You can also augment queries by using [template variables](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/datasources/azure-monitor/template-variables/).
@@ -348,17 +348,17 @@ Application Insights stores trace data in an underlying Log Analytics workspace
1. Select the **Traces** service.
1. Select a resource to query. Multiple resources can be selected as long as they are of the same type.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
This query type only supports Application Insights resources.
{{% /admonition %}}
{{< /admonition >}}
Running a query of this kind will return all trace data within the timespan specified by the panel/dashboard.
Optionally, you can apply further filtering or select a specific Operation ID to query. The result format can also be switched between a tabular format or the trace format which will return the data in a format that can be used with the Trace visualization.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Selecting the trace format will filter events with the `trace` type.
{{% /admonition %}}
{{< /admonition >}}
1. Specify an Operation ID value.
1. Specify event types to filter by.
@@ -65,11 +65,11 @@ Our maintenance policy for Elasticsearch data source is aligned with the [Elasti
You can define and configure the data source in YAML files as part of Grafana's provisioning system.
For more information about provisioning, and for available configuration options, refer to [Provisioning Grafana](ref:provisioning-grafana).
{{% admonition type="note" %}}
{{< admonition type="note" >}}
The previously used `database` field has now been [deprecated](https://github.com/grafana/grafana/pull/58647).
You should now use the `index` field in `jsonData` to store the index name.
Please see the examples below.
{{% /admonition %}}
{{< /admonition >}}
### Provisioning examples
@@ -95,9 +95,9 @@ Select one of the following authentication methods from the dropdown menu.
### TLS settings
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Use TLS (Transport Layer Security) for an additional layer of security when working with Elasticsearch. For information on setting up TLS encryption with Elasticsearch see [Configure TLS](https://www.elastic.co/guide/en/elasticsearch/reference/8.8/configuring-tls.html#configuring-tls). You must add TLS settings to your Elasticsearch configuration file **prior** to setting these options in Grafana.
{{% /admonition %}}
{{< /admonition >}}
- **Add self-signed certificate** - Check the box to authenticate with a CA certificate. Follow the instructions of the CA (Certificate Authority) to download the certificate file. Required for verifying self-signed TLS certificates.
@@ -166,9 +166,9 @@ You can also override this setting in a dashboard panel under its data source op
- **Include frozen indices** - Toggle on when the `X-Pack enabled` setting is active. Includes frozen indices in searches. You can configure Grafana to include [frozen indices](https://www.elastic.co/guide/en/elasticsearch/reference/7.13/frozen-indices.html) when performing search requests.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Frozen indices are [deprecated in Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/7.17/frozen-indices.html) since v7.14.
{{% /admonition %}}
{{< /admonition >}}
### Logs
@@ -32,9 +32,9 @@ refs:
Grafana provides a query editor for Elasticsearch. Elasticsearch queries are in Lucene format.
See [Lucene query syntax](https://www.elastic.co/guide/en/kibana/current/lucene-query.html) and [Query string syntax](https://www.elastic.co/guide/en/elasticsearch/reference/8.9/query-dsl-query-string-query.html#query-string-syntax) if you are new to working with Lucene queries in Elasticsearch.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
When composing Lucene queries, ensure that you use uppercase boolean operators: `AND`, `OR`, and `NOT`. Lowercase versions of these operators are not supported by the Lucene query syntax.
{{% /admonition %}}
{{< /admonition >}}
{{< figure src="/static/img/docs/elasticsearch/elastic-query-editor-10.1.png" max-width="800px" class="docs-image--no-shadow" caption="Elasticsearch query editor" >}}
@@ -137,9 +137,9 @@ Run a raw data query to retrieve a table of all fields that are associated with
- **Raw data size** - Number of raw data documents. You can specify a different amount. The default is `500`.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
The option to run a **raw document query** is deprecated as of Grafana v10.1.
{{% /admonition %}}
{{< /admonition >}}
## Use template variables
@@ -68,9 +68,9 @@ These queries by default return results in term order (which can then be sorted
To produce a list of terms sorted by doc count (a top-N values list), add an `orderBy` property of "doc_count".
This automatically selects a descending sort.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
To use an ascending sort (`asc`) with doc_count (a bottom-N list), set `order: "asc"`. However, Elasticsearch [discourages this](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html#search-aggregations-bucket-terms-aggregation-order) because sorting by ascending doc count can return inaccurate results.
{{% /admonition %}}
{{< /admonition >}}
To keep terms in the doc count order, set the variable's Sort dropdown to **Disabled**.
You can alternatively use other sorting criteria, such as **Alphabetical**, to re-sort them.
@@ -74,9 +74,9 @@ In the case that the metric value type is a distribution, the aggregation will b
The various metrics are documented [here](https://cloud.google.com/monitoring/api/metrics_gcp) and further details on the kinds and types of metrics can be found [here](https://cloud.google.com/monitoring/api/v3/kinds-and-types).
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Distribution metrics are typically best visualized as either a heatmap or histogram. When visualizing in this way, aggregation is not necessary. However, for other visualization types, performance degradation may be observed when attempting to query distribution metrics that are not aggregated due to the number of potential buckets that can be returned. For more information on how to visualize distribution metrics refer to [this page](https://cloud.google.com/monitoring/charts/charting-distribution-metrics).
{{% /admonition %}}
{{< /admonition >}}
### Apply a filter
@@ -71,9 +71,9 @@ Some functions like aliasByNode support an optional second argument. To add an a
To learn more, refer to [Graphite's documentation on functions](https://graphite.readthedocs.io/en/latest/functions.html).
{{% admonition type="warning" %}}
{{< admonition type="warning" >}}
Some functions take a second argument that may be a function that returns a series. If you are adding a second argument that is a function, it is suggested to use a series reference from a second query instead of the function itself. The query editor does not currently support parsing of a second argument that is a function when switching between the query editor and the code editor.
{{% /admonition %}}
{{< /admonition >}}
### Sort labels
@@ -91,10 +91,10 @@ Grafana consolidates all Graphite metrics so that Graphite doesn't return more d
By default, Grafana consolidates data points using the `avg` function.
To control how Graphite consolidates metrics, use the Graphite `consolidateBy()` function.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Legend summary values (max, min, total) can't all be correct at the same time because they are calculated client-side by Grafana.
Depending on your consolidation function, only one or two can be correct at the same time.
{{% /admonition %}}
{{< /admonition >}}
### Combine time series
@@ -109,10 +109,10 @@ To select data, use the `seriesByTag` function, which takes tag expressions (`=`
The Grafana query builder does this for you automatically when you select a tag.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
The regular expression search can be slow on high-cardinality tags, so try to use other tags to reduce the scope first.
To help reduce the results, start by filtering on a particular name or namespace.
{{% /admonition %}}
{{< /admonition >}}
## Nest queries
@@ -176,10 +176,10 @@ You can define and configure the data source in YAML files as part of Grafana's
For more information about provisioning, and for available configuration options, refer
to [Provision Grafana](ref:provision-grafana).
{{% admonition type="note" %}}
{{< admonition type="note" >}}
The `database` [field is deprecated](https://github.com/grafana/grafana/pull/58647).
Grafana recommends using the `dbName` field in `jsonData`. There is no need to change existing provisioning settings.
{{% /admonition %}}
{{< /admonition >}}
### Provisioning examples
+2 -2
View File
@@ -109,9 +109,9 @@ You can also configure settings specific to the Jaeger data source. These option
![Trace to logs settings](/media/docs/tempo/tempo-trace-to-logs-9-4.png)
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If you use Grafana Cloud, open a [support ticket in the Cloud Portal](/profile/org#support) to access this feature.
{{% /admonition %}}
{{< /admonition >}}
The **Trace to logs** setting configures the [trace to logs feature](ref:explore-trace-integration) that is available when you integrate Grafana with Jaeger.
+2 -2
View File
@@ -72,9 +72,9 @@ Administrators can also [configure the data source via YAML](#provision-the-data
Once you've added the Loki data source, you can [configure it](#configure-the-data-source) so that your Grafana instance's users can create queries in its [query editor](query-editor/) when they [build dashboards](ref:build-dashboards), use [Explore](ref:explore), and [annotate visualizations](query-editor/#apply-annotations).
{{% admonition type="note" %}}
{{< admonition type="note" >}}
To troubleshoot configuration and other issues, check the log file located at `/var/log/grafana/grafana.log` on Unix systems, or in `<grafana_install_dir>/data/log` on other platforms and manual installations.
{{% /admonition %}}
{{< /admonition >}}
## Provision the data source
@@ -61,9 +61,9 @@ The first option to configure is the name of your connection:
There are several authentication methods you can choose in the Authentication section.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Use TLS (Transport Layer Security) for an additional layer of security when working with Loki. For information on setting up TLS encryption with Loki see [Grafana Loki configuration parameters](/docs/loki/latest/configuration/).
{{% /admonition %}}
{{< /admonition >}}
- **Basic authentication** - The most common authentication method. Use your `data source` user name and `data source` password to connect.
@@ -91,9 +91,9 @@ Use TLS (Transport Layer Security) for an additional layer of security when work
- **Maximum lines** - Sets the maximum number of log lines returned by Loki. Increase the limit to have a bigger results set for ad-hoc analysis. Decrease the limit if your browser is sluggish when displaying log results. The default is `1000`.
<!-- {{% admonition type="note" %}}
<!-- {{< admonition type="note" >}}
To troubleshoot configuration and other issues, check the log file located at `/var/log/grafana/grafana.log` on Unix systems, or in `<grafana_install_dir>/data/log` on other platforms and manual installations.
{{% /admonition %}} -->
{{< /admonition >}} -->
### Derived fields
@@ -104,9 +104,9 @@ These links appear in the [log details](ref:log-details).
You can add multiple derived fields.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If you use Grafana Cloud, you can request modifications to this feature by clicking **Open a Support Ticket** from the Grafana Cloud Portal.
{{% /admonition %}}
{{< /admonition >}}
Each derived field consists of the following:
@@ -114,9 +114,9 @@ Each derived field consists of the following:
- **Type** - Defines the type of the derived field. It can be either:
{{% admonition type="caution" %}}
{{< admonition type="caution" >}}
Using complex regular expressions in either type can impact browser performance when processing large volumes of logs. Consider using simpler patterns when possible.
{{% /admonition %}}
{{< /admonition >}}
- **Regex**: A regular expression to parse a part of the log message and capture it as the value of the new field. Can contain only one capture group.
@@ -55,9 +55,9 @@ To switch between the editor modes, select the corresponding **Builder** and **C
To run a query, select **Run queries** located at the top of the editor.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
To run Loki queries in [Explore](ref:explore), select **Run query**.
{{% /admonition %}}
{{< /admonition >}}
Each mode is synchronized, so you can switch between them without losing your work, although there are some limitations. Builder mode doesn't support some complex queries.
When you switch from Code mode to Builder mode with such a query, the editor displays a warning message that explains how you might lose parts of the query if you continue.
@@ -66,9 +66,9 @@ Grafana’s query editors are unique for each data source. For general informati
The MySQL query editor is located on the [Explore page](ref:explore). You can also access the MySQL query editor from a dashboard panel. Click the ellipsis in the upper right of the panel and select **Edit**.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If a default database is configured in the **Data Source Configuration page**, or via a provisioning configuration file, users will be restricted to querying only that pre-configured database. This feature is behind a feature flag and is available once you enable `sqlDatasourceDatabaseSelection`.
{{% /admonition %}}
{{< /admonition >}}
## MySQL query editor components
@@ -76,9 +76,9 @@ The MySQL query editor has two modes: **Builder** and **Code**.
Builder mode helps you build a query using a visual interface. Code mode allows for advanced querying and offers support for complex SQL query writing.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If your table or database name contains a reserved word or a [prohibited character](https://dev.mysql.com/doc/en/identifiers.html) the editor will put quotes around the name. For example, the name `table-name` will be quoted with backticks - `` `table-name` ``.
{{% /admonition %}}
{{< /admonition >}}
## MySQL Builder mode
@@ -121,9 +121,9 @@ To create advanced queries, switch to **Code mode** by clicking **Code** in the
Select **Table** or **Time Series** as the format. Click the **{}** in the bottom right to format the query. Click the **downward caret** to expand the Code mode editor. **CTRL/CMD + Return** serves as a keyboard shortcut to execute the query.
{{% admonition type="warning" %}}
{{< admonition type="warning" >}}
Changes made to a query in Code mode will not transfer to Builder mode and will be discarded. You will be prompted to copy your code to the clipboard to save any changes.
{{% /admonition %}}
{{< /admonition >}}
## Macros
@@ -174,9 +174,9 @@ Table panel results:
Set the **Format** option to **Time series** to create and run time series queries.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
To run a time series query you must include a column named `time` that returns either a SQL datetime value or a numeric datatype representing the UNIX epoch time in seconds. Additionally, the query results must be sorted by the `time` column for proper visualization in panels.
{{% /admonition %}}
{{< /admonition >}}
The examples in this section refer to the data in the following table:
@@ -194,9 +194,9 @@ The examples in this section refer to the data in the following table:
A time series query result is returned in a [wide data frame format](https://grafana.com/developers/plugin-tools/key-concepts/data-frames#wide-format). Any column except time or of type string transforms into value fields in the data frame query result. Any string column transforms into field labels in the data frame query result.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
For backward compatibility, an exception to the aforementioned rule applies to queries returning three columns, including a string column named `metric`. Instead of converting the metric column into field labels, it is used as the field name, and the series name is set to the value of the metric column. Refer to the following example with a metric column.
{{% /admonition %}}
{{< /admonition >}}
**Example with `metric` column:**
+4 -4
View File
@@ -94,13 +94,13 @@ can be used to query OpenTSDB. Fill Policy is also introduced in OpenTSDB 2.2.
![](/static/img/docs/v43/opentsdb_query_editor.png)
{{% admonition type="note" %}}
{{< admonition type="note" >}}
While using OpenTSDB 2.2 data source, make sure you use either Filters or Tags as they are mutually exclusive. If used together, might give you weird results.
{{% /admonition %}}
{{< /admonition >}}
{{% admonition type="note" %}}
{{< admonition type="note" >}}
When using OpenTSDB 2.4 with alerting, queries are executed with the parameter `arrays=true`. This causes OpenTSDB to return data points as an array of arrays instead of a map of key-value pairs. Grafana then converts this data into the appropriate data frame format.
{{% /admonition %}}
{{< /admonition >}}
### Auto complete suggestions
@@ -297,9 +297,9 @@ Add the following setting in the **[auth]** section of the .ini configuration fi
azure_auth_enabled = true
```
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If you are using Azure authentication, don't enable `Forward OAuth identity`. Both methods use the same HTTP authorization headers, and the OAuth token will override your Azure credentials.
{{% /admonition %}}
{{< /admonition >}}
## Recording rules (beta)
@@ -123,15 +123,15 @@ Click **+ Operations** to select from a list of operations including Aggregation
a set of time series where each series includes multiple data points over a period of time. You can choose to visualize the data as lines, bars, points, stacked lines, or stacked bars.
- **Instant** - Returns a single data point per series — the most recent value within the selected time range. The results can be displayed in a table or as raw data. To visualize instant query results in a time series panel, start by adding field override, then add a property to the override called `Transform`, and set the Transform value to `Constant` in the drop-down. For more information, refer to the [Time Series Transform option documentation](ref:time-series-transform).
{{% admonition type="note" %}}
{{< admonition type="note" >}}
Grafana adjusts the query time range to align with the dynamically calculated step interval. This alignment ensures consistent metric visualization and supports Prometheus's result caching requirements. However, this alignment can cause minor visual differences, such as a slight gap at the graph's right edge or a shifted start time. For example, a `15s` step aligns timestamps to Unix times divisible by 15 seconds. A `1w` `minstep` aligns the range to the start of the week, which for Prometheus is Thursday at 00:00 UTC.
{{% /admonition %}}
{{< /admonition >}}
- **Exemplars** - Toggle on to run a query that includes exemplars in the graph. Exemplars are unique to Prometheus. For more information see [Introduction to exemplars](ref:exemplars).
{{% admonition type="note" %}}
{{< admonition type="note" >}}
There is no option to add exemplars with an **Instant** query type.
{{% /admonition %}}
{{< /admonition >}}
### Filter metrics
@@ -159,9 +159,9 @@ The following options are included under the **Additional Settings** drop-down:
- **Disable text wrap**: Toggle on to disable text wrapping.
- **Enable regex search**: Toggle on to filter metric names by regex search, which uses an additional call on the Prometheus API.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
The Metrics explorer (Builder mode) and [Metrics browser (Code mode)](#metrics-browser-in-code-mode) are separate elements. The Metrics explorer does not have the ability to browse labels yet, but the Metrics browser can display all labels on a metric name.
{{% /admonition %}}
{{< /admonition >}}
### Operations
@@ -220,9 +220,9 @@ You can then select one or more labels shown in **Step 2**.
Select one or more values in **Step 3** for each label to tighten your query scope.
In **Step 4**, you can select **Use query** to run the query, **Use as rate query** to add the rate operation to your query (`$__rate_interval`), **Validate selector** to verify the selector is valid and show the number of series found, or **Clear** to clear your selections and start over.
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If you don't remember the exact metric name, you can start by selecting a few labels to filter the list. This helps you find relevant label values and narrow down your options.
{{% /admonition %}}
{{< /admonition >}}
All lists in the Metrics browser include a search field to quickly filter metrics or labels by keyword.
In the **Values** section, there's a single search field that filters across all selected labels, making it easier to find matching values. For example, if you have labels like `app`, `job`, and `job_name`, only one of them might contain the value you're looking for.
+2 -2
View File
@@ -120,9 +120,9 @@ That makes it much easier for the developers to replicate and solve your issue.
## Use a custom version of TestData
{{% admonition type="note" %}}
{{< admonition type="note" >}}
This feature is experimental and requires Grafana version 10.3.0 or later.
{{% /admonition %}}
{{< /admonition >}}
If you want to use a version of TestData different from the one shipped with Grafana, follow these steps:
+2 -2
View File
@@ -102,9 +102,9 @@ To configure basic settings for the data source, complete the following steps:
![Trace to logs settings](/media/docs/tempo/tempo-trace-to-logs-9-4.png)
{{% admonition type="note" %}}
{{< admonition type="note" >}}
If you use Grafana Cloud, open a [support ticket in the Cloud Portal](/profile/org#support) to access this feature.
{{% /admonition %}}
{{< /admonition >}}
The **Trace to logs** setting configures the [trace to logs feature](ref:trace-integration) that is available when you integrate Grafana with Zipkin.