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

This commit is contained in:
Jack Baldry
2025-06-24 09:23:29 +01:00
committed by GitHub
parent 623302d055
commit ff2ac27301
142 changed files with 543 additions and 543 deletions
@@ -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.