mirror of
https://github.com/grafana/grafana.git
synced 2025-01-24 15:27:01 -06:00
CloudWatch: Clarify match exact tooltip and docs (#85095)
* CloudWatch: Clarify match exact tooltip * Update docs * fix typo * ida comment and removing a couple "you"s * present tense
This commit is contained in:
parent
44376f8039
commit
ba3acf83bf
@ -29,7 +29,7 @@ For general documentation on querying data sources in Grafana, see [Query and tr
|
||||
|
||||
The CloudWatch data source can query data from both CloudWatch metrics and CloudWatch Logs APIs, each with its own specialized query editor.
|
||||
|
||||
- [CloudWatch metrics](#query-cloudwatch-metrics)
|
||||
- [CloudWatch Metrics](#query-cloudwatch-metrics)
|
||||
- [CloudWatch Logs](#query-cloudwatch-logs)
|
||||
|
||||
{{< figure src="/static/img/docs/cloudwatch/cloudwatch-query-editor-api-modes-8.3.0.png" max-width="500px" class="docs-image--right" caption="CloudWatch API modes" >}}
|
||||
@ -45,10 +45,10 @@ You can build two types of queries with the CloudWatch query editor:
|
||||
|
||||
### Create a Metric Search query
|
||||
|
||||
To create a valid Metric Search query, specify the namespace, metric name, and at least one statistic.
|
||||
To create a valid Metric Search query, specify the namespace, metric name, and at least one statistic. Dimensions are optional, but for a dimension to be considered part of the query it must have both a key and a value.
|
||||
|
||||
If you enable `Match Exact`, you must also specify all dimensions of the metric you're querying so that the [metric schema](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/search-expression-syntax.html) matches exactly.
|
||||
If `Match Exact` is disabled, you can specify any number of dimensions on which you'd like to filter.
|
||||
If you enable `Match Exact`, you must also specify all dimensions of the metric you're querying so that the [metric schema](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/search-expression-syntax.html) matches exactly. With `Match Exact` enabled the query only returns metrics that have the specified dimensions and no others, so dimensions that are on the metric but that are not being filtered on must be added as a wildcard (`*`) filter.
|
||||
If `Match Exact` is disabled, you can specify any number of dimensions on which you'd like to filter. With `Match Exact` disabled the query returns any metrics that match the namespace, metric name, and all defined dimensions, whether or not they have additional dimensions.
|
||||
The data source returns up to 100 metrics matching your filter criteria.
|
||||
|
||||
You can also augment queries by using [template variables]({{< relref "./template-variables" >}}).
|
||||
|
@ -146,7 +146,24 @@ export const MetricStatEditor = ({
|
||||
<EditorField
|
||||
label="Match exact"
|
||||
optional={true}
|
||||
tooltip="Only show metrics that exactly match all defined dimension names."
|
||||
tooltip={
|
||||
<>
|
||||
{
|
||||
'Only show metrics that contain exactly the dimensions defined in the query and match the specified values. If this is enabled, all dimensions of the metric being queried must be specified so that the '
|
||||
}
|
||||
<a
|
||||
href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/search-expression-syntax.html"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
metric schema
|
||||
</a>
|
||||
{
|
||||
' matches exactly. If this is disabled, metrics that match the schema and have additional dimensions will also be returned.'
|
||||
}
|
||||
</>
|
||||
}
|
||||
tooltipInteractive
|
||||
>
|
||||
<EditorSwitch
|
||||
id={`${refId}-cloudwatch-match-exact`}
|
||||
|
Loading…
Reference in New Issue
Block a user