diff --git a/docs/generator/links_to_types.go b/docs/generator/links_to_types.go index 867654e1648d..8de89bfd1321 100644 --- a/docs/generator/links_to_types.go +++ b/docs/generator/links_to_types.go @@ -38,12 +38,10 @@ func (l *LinksToTypesGenerator) Generate() (string, error) { } note := ` -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} ` return heading + acceptingSection + outputSection + note, nil diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 866c69ae32f4..0d4f71b7addd 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -24,11 +24,11 @@ Grafana Agent is based around **components**. Components are wired together to form programmable observability **pipelines** for telemetry collection, processing, and delivery. -{{% admonition type="note" %}} +{{< admonition type="note" >}} This page focuses mainly on [Flow mode](https://grafana.com/docs/agent//flow/), the Terraform-inspired variant of Grafana Agent. For information on other variants of Grafana Agent, refer to [Introduction to Grafana Agent]({{< relref "./about.md" >}}). -{{% /admonition %}} +{{< /admonition >}} Grafana Agent can collect, transform, and send data to: diff --git a/docs/sources/_index.md.t b/docs/sources/_index.md.t index 549ba33ef8db..daf939a62ac3 100644 --- a/docs/sources/_index.md.t +++ b/docs/sources/_index.md.t @@ -24,11 +24,11 @@ Grafana Agent is based around **components**. Components are wired together to form programmable observability **pipelines** for telemetry collection, processing, and delivery. -{{% admonition type="note" %}} +{{< admonition type="note" >}} This page focuses mainly on [Flow mode](https://grafana.com/docs/agent//flow/), the Terraform-inspired variant of Grafana Agent. For information on other variants of Grafana Agent, refer to [Introduction to Grafana Agent]({{< relref "./about.md" >}}). -{{% /admonition %}} +{{< /admonition >}} Grafana Agent can collect, transform, and send data to: diff --git a/docs/sources/about.md b/docs/sources/about.md index 57468c7f3e24..eca262408d7d 100644 --- a/docs/sources/about.md +++ b/docs/sources/about.md @@ -105,10 +105,10 @@ You should run Static mode when: ### Static mode Kubernetes operator -{{% admonition type="note" %}} +{{< admonition type="note" >}} Grafana Agent version 0.37 and newer provides Prometheus Operator compatibility in Flow mode. You should use Grafana Agent Flow mode for all new Grafana Agent deployments. -{{% /admonition %}} +{{< /admonition >}} The [Static mode Kubernetes operator][] is a variant of Grafana Agent introduced on June 17, 2021. It's currently in beta. diff --git a/docs/sources/flow/_index.md b/docs/sources/flow/_index.md index 934c4694014b..cc800508f222 100644 --- a/docs/sources/flow/_index.md +++ b/docs/sources/flow/_index.md @@ -72,9 +72,9 @@ prometheus.remote_write "default" { The {{< param "PRODUCT_NAME" >}} [configuration generator](https://grafana.github.io/agent-configurator/) will help you get a head start on creating flow code. -{{% admonition type="note" %}} +{{< admonition type="note" >}} This feature is experimental, and it doesn't support all River components. -{{% /admonition %}} +{{< /admonition >}} ## Next steps diff --git a/docs/sources/flow/concepts/config-language/expressions/types_and_values.md b/docs/sources/flow/concepts/config-language/expressions/types_and_values.md index 1f27c0b5ecac..70afaf790472 100644 --- a/docs/sources/flow/concepts/config-language/expressions/types_and_values.md +++ b/docs/sources/flow/concepts/config-language/expressions/types_and_values.md @@ -167,7 +167,7 @@ If the key isn't a valid identifier, you must wrap it in double quotes like a st } ``` -{{% admonition type="note" %}} +{{< admonition type="note" >}} Don't confuse objects with blocks. * An _object_ is a value assigned to an [Attribute][]. You **must** use commas between key-value pairs on separate lines. @@ -175,7 +175,7 @@ Don't confuse objects with blocks. [Attribute]: {{< relref "../syntax.md#Attributes" >}} [Block]: {{< relref "../syntax.md#Blocks" >}} -{{% /admonition %}} +{{< /admonition >}} ## Functions diff --git a/docs/sources/flow/concepts/modules.md b/docs/sources/flow/concepts/modules.md index 940357f30127..28ebbfb499cd 100644 --- a/docs/sources/flow/concepts/modules.md +++ b/docs/sources/flow/concepts/modules.md @@ -39,9 +39,9 @@ Module loader components are responsible for the following functions: Module loaders are typically called `module.LOADER_NAME`. -{{% admonition type="note" %}} +{{< admonition type="note" >}} Some module loaders may not support running modules with arguments or exports. -{{% /admonition %}} +{{< /admonition >}} Refer to [Components][] for more information about the module loader components. diff --git a/docs/sources/flow/get-started/install/_index.md b/docs/sources/flow/get-started/install/_index.md index b43983c5ea53..25b9a5b2f101 100644 --- a/docs/sources/flow/get-started/install/_index.md +++ b/docs/sources/flow/get-started/install/_index.md @@ -29,9 +29,9 @@ The following architectures are supported: - macOS: AMD64 (Intel), ARM64 (Apple Silicon) - FreeBSD: AMD64 -{{% admonition type="note" %}} +{{< admonition type="note" >}} Installing {{< param "PRODUCT_NAME" >}} on other operating systems is possible, but isn't recommended or supported. -{{% /admonition %}} +{{< /admonition >}} {{< section >}} diff --git a/docs/sources/flow/get-started/install/chef.md b/docs/sources/flow/get-started/install/chef.md index 70d9441d22f0..9d16cb684620 100644 --- a/docs/sources/flow/get-started/install/chef.md +++ b/docs/sources/flow/get-started/install/chef.md @@ -24,7 +24,7 @@ You can use Chef to install and manage {{< param "PRODUCT_NAME" >}}. ## Steps -To add {{% param "PRODUCT_NAME" %}} to a host: +To add {{< param "PRODUCT_NAME" >}} to a host: 1. Add the following resources to your [Chef][] recipe to add the Grafana package repositories to your system: diff --git a/docs/sources/flow/get-started/install/docker.md b/docs/sources/flow/get-started/install/docker.md index c7884a6dc21b..c7e07b1b3b7a 100644 --- a/docs/sources/flow/get-started/install/docker.md +++ b/docs/sources/flow/get-started/install/docker.md @@ -57,10 +57,10 @@ Replace the following: You can modify the last line to change the arguments passed to the {{< param "PRODUCT_NAME" >}} binary. Refer to the documentation for [run][] for more information about the options available to the `run` command. -{{% admonition type="note" %}} +{{< admonition type="note" >}} Make sure you pass `--server.http.listen-addr=0.0.0.0:12345` as an argument as shown in the example above. If you don't pass this argument, the [debugging UI][UI] won't be available outside of the Docker container. -{{% /admonition %}} +{{< /admonition >}} ## Run a Windows Docker container @@ -82,10 +82,10 @@ Replace the following: You can modify the last line to change the arguments passed to the {{< param "PRODUCT_NAME" >}} binary. Refer to the documentation for [run][] for more information about the options available to the `run` command. -{{% admonition type="note" %}} +{{< admonition type="note" >}} Make sure you pass `--server.http.listen-addr=0.0.0.0:12345` as an argument as shown in the example above. If you don't pass this argument, the [debugging UI][UI] won't be available outside of the Docker container. -{{% /admonition %}} +{{< /admonition >}} ## Verify diff --git a/docs/sources/flow/get-started/install/kubernetes.md b/docs/sources/flow/get-started/install/kubernetes.md index 9326fce4bf03..d045c7b5ce13 100644 --- a/docs/sources/flow/get-started/install/kubernetes.md +++ b/docs/sources/flow/get-started/install/kubernetes.md @@ -30,10 +30,10 @@ weight: 200 ## Deploy -{{% admonition type="note" %}} +{{< admonition type="note" >}} These instructions show you how to install the generic [Helm chart](https://github.com/grafana/agent/tree/main/operations/helm/charts/grafana-agent) for {{< param "PRODUCT_NAME" >}}. You can deploy {{< param "PRODUCT_ROOT_NAME" >}} either in static mode or flow mode. The Helm chart deploys {{< param "PRODUCT_NAME" >}} by default. -{{% /admonition %}} +{{< /admonition >}} To deploy {{< param "PRODUCT_ROOT_NAME" >}} on Kubernetes using Helm, run the following commands in a terminal window: diff --git a/docs/sources/flow/get-started/install/macos.md b/docs/sources/flow/get-started/install/macos.md index 9903e13ff632..c16f70e6d941 100644 --- a/docs/sources/flow/get-started/install/macos.md +++ b/docs/sources/flow/get-started/install/macos.md @@ -22,9 +22,9 @@ weight: 400 You can install {{< param "PRODUCT_NAME" >}} on macOS with Homebrew . -{{% admonition type="note" %}} +{{< admonition type="note" >}} The default prefix for Homebrew on Intel is `/usr/local`. The default prefix for Homebrew on Apple Silicon is `/opt/Homebrew`. To verify the default prefix for Homebrew on your computer, open a terminal window and type `brew --prefix`. -{{% /admonition %}} +{{< /admonition >}} ## Before you begin diff --git a/docs/sources/flow/get-started/run/binary.md b/docs/sources/flow/get-started/run/binary.md index 7f9fda22ff77..0b9ac5b7d74a 100644 --- a/docs/sources/flow/get-started/run/binary.md +++ b/docs/sources/flow/get-started/run/binary.md @@ -46,9 +46,9 @@ Replace the following: You can set up and manage the standalone binary for {{< param "PRODUCT_NAME" >}} as a Linux systemd service. -{{% admonition type="note" %}} +{{< admonition type="note" >}} These steps assume you have a default systemd and {{< param "PRODUCT_NAME" >}} configuration. -{{% /admonition %}} +{{< /admonition >}} 1. To create a new user called `grafana-agent-flow` run the following command in a terminal window: diff --git a/docs/sources/flow/reference/cli/tools.md b/docs/sources/flow/reference/cli/tools.md index b45e7f215a23..b9fb73a761bd 100644 --- a/docs/sources/flow/reference/cli/tools.md +++ b/docs/sources/flow/reference/cli/tools.md @@ -15,10 +15,10 @@ weight: 400 The `tools` command contains command line tooling grouped by Flow component. -{{% admonition type="caution" %}} +{{< admonition type="caution" >}} Utilities in this command have no backward compatibility guarantees and may change or be removed between releases. -{{% /admonition %}} +{{< /admonition >}} ## Subcommands diff --git a/docs/sources/flow/reference/compatibility/_index.md b/docs/sources/flow/reference/compatibility/_index.md index 38751632780a..cdd9426cfb27 100644 --- a/docs/sources/flow/reference/compatibility/_index.md +++ b/docs/sources/flow/reference/compatibility/_index.md @@ -16,7 +16,7 @@ This section provides an overview of _some_ of the possible connections between For each common data type, we provide a list of compatible components that can export or consume it. -{{% admonition type="note" %}} +{{< admonition type="note" >}} The type of export may not be the only requirement for chaining components together. The value of an attribute may matter as well as its type. Refer to each component's documentation for more details on what values are acceptable. @@ -24,7 +24,7 @@ Refer to each component's documentation for more details on what values are acce For example: * A Prometheus component may always expect an `"__address__"` label inside a list of targets. * A `string` argument may only accept certain values like "traceID" or "spanID". -{{% /admonition %}} +{{< /admonition >}} ## Targets diff --git a/docs/sources/flow/reference/components/discovery.azure.md b/docs/sources/flow/reference/components/discovery.azure.md index 83eceabdf7a6..94b38bbec2a0 100644 --- a/docs/sources/flow/reference/components/discovery.azure.md +++ b/docs/sources/flow/reference/components/discovery.azure.md @@ -158,11 +158,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.consul.md b/docs/sources/flow/reference/components/discovery.consul.md index c63f94b8017c..e45e6a3ec040 100644 --- a/docs/sources/flow/reference/components/discovery.consul.md +++ b/docs/sources/flow/reference/components/discovery.consul.md @@ -177,11 +177,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.consulagent.md b/docs/sources/flow/reference/components/discovery.consulagent.md index df923fed4496..5557410188b1 100644 --- a/docs/sources/flow/reference/components/discovery.consulagent.md +++ b/docs/sources/flow/reference/components/discovery.consulagent.md @@ -138,11 +138,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.digitalocean.md b/docs/sources/flow/reference/components/discovery.digitalocean.md index 2a64ba7f6bec..a24eabaa0803 100644 --- a/docs/sources/flow/reference/components/discovery.digitalocean.md +++ b/docs/sources/flow/reference/components/discovery.digitalocean.md @@ -128,11 +128,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.dns.md b/docs/sources/flow/reference/components/discovery.dns.md index d2f0217b1d73..70fb3a64b9e1 100644 --- a/docs/sources/flow/reference/components/discovery.dns.md +++ b/docs/sources/flow/reference/components/discovery.dns.md @@ -103,11 +103,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.docker.md b/docs/sources/flow/reference/components/discovery.docker.md index 4d6ce94d557f..5a8518f22873 100644 --- a/docs/sources/flow/reference/components/discovery.docker.md +++ b/docs/sources/flow/reference/components/discovery.docker.md @@ -225,11 +225,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.dockerswarm.md b/docs/sources/flow/reference/components/discovery.dockerswarm.md index 58c065fb06eb..c1a7f8616cee 100644 --- a/docs/sources/flow/reference/components/discovery.dockerswarm.md +++ b/docs/sources/flow/reference/components/discovery.dockerswarm.md @@ -248,11 +248,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.ec2.md b/docs/sources/flow/reference/components/discovery.ec2.md index 7f01ae48c6e0..cc7f49259594 100644 --- a/docs/sources/flow/reference/components/discovery.ec2.md +++ b/docs/sources/flow/reference/components/discovery.ec2.md @@ -175,11 +175,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.eureka.md b/docs/sources/flow/reference/components/discovery.eureka.md index 70ab3f8f666d..93c76d9d09f8 100644 --- a/docs/sources/flow/reference/components/discovery.eureka.md +++ b/docs/sources/flow/reference/components/discovery.eureka.md @@ -162,11 +162,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.file.md b/docs/sources/flow/reference/components/discovery.file.md index c8493e01e62a..a78c39feabf7 100644 --- a/docs/sources/flow/reference/components/discovery.file.md +++ b/docs/sources/flow/reference/components/discovery.file.md @@ -182,11 +182,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.gce.md b/docs/sources/flow/reference/components/discovery.gce.md index 5752a4ce51b1..1a662bec2911 100644 --- a/docs/sources/flow/reference/components/discovery.gce.md +++ b/docs/sources/flow/reference/components/discovery.gce.md @@ -122,11 +122,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.hetzner.md b/docs/sources/flow/reference/components/discovery.hetzner.md index c6922e685f66..f917f8417a84 100644 --- a/docs/sources/flow/reference/components/discovery.hetzner.md +++ b/docs/sources/flow/reference/components/discovery.hetzner.md @@ -186,11 +186,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.http.md b/docs/sources/flow/reference/components/discovery.http.md index 50ecf42dcc06..80639fe7077f 100644 --- a/docs/sources/flow/reference/components/discovery.http.md +++ b/docs/sources/flow/reference/components/discovery.http.md @@ -192,11 +192,9 @@ discovery.http "dynamic_targets" { - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.ionos.md b/docs/sources/flow/reference/components/discovery.ionos.md index 1c619a1641ac..378556ad7886 100644 --- a/docs/sources/flow/reference/components/discovery.ionos.md +++ b/docs/sources/flow/reference/components/discovery.ionos.md @@ -161,11 +161,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.kubelet.md b/docs/sources/flow/reference/components/discovery.kubelet.md index 7ef29244a01e..bf0e1085dcde 100644 --- a/docs/sources/flow/reference/components/discovery.kubelet.md +++ b/docs/sources/flow/reference/components/discovery.kubelet.md @@ -206,11 +206,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.kubernetes.md b/docs/sources/flow/reference/components/discovery.kubernetes.md index 1d4b2f9210c5..8745ff5ddd7a 100644 --- a/docs/sources/flow/reference/components/discovery.kubernetes.md +++ b/docs/sources/flow/reference/components/discovery.kubernetes.md @@ -466,10 +466,10 @@ Replace the following: This example limits the search to pods on the same node as this {{< param "PRODUCT_ROOT_NAME" >}}. This configuration could be useful if you are running {{< param "PRODUCT_ROOT_NAME" >}} as a DaemonSet. -{{% admonition type="note" %}} +{{< admonition type="note" >}} This example assumes you have used Helm chart to deploy {{< param "PRODUCT_NAME" >}} in Kubernetes and sets `HOSTNAME` to the Kubernetes host name. If you have a custom Kubernetes deployment, you must adapt this example to your configuration. -{{% /admonition %}} +{{< /admonition >}} ```river discovery.kubernetes "k8s_pods" { @@ -510,11 +510,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.kuma.md b/docs/sources/flow/reference/components/discovery.kuma.md index c498753f58ab..8763bc2eb357 100644 --- a/docs/sources/flow/reference/components/discovery.kuma.md +++ b/docs/sources/flow/reference/components/discovery.kuma.md @@ -145,11 +145,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.lightsail.md b/docs/sources/flow/reference/components/discovery.lightsail.md index 81bdb0c706b9..22868c58faeb 100644 --- a/docs/sources/flow/reference/components/discovery.lightsail.md +++ b/docs/sources/flow/reference/components/discovery.lightsail.md @@ -108,11 +108,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.linode.md b/docs/sources/flow/reference/components/discovery.linode.md index 77d01dbdf4e2..6a5733c9e6cc 100644 --- a/docs/sources/flow/reference/components/discovery.linode.md +++ b/docs/sources/flow/reference/components/discovery.linode.md @@ -20,9 +20,9 @@ discovery.linode "LABEL" { } ``` -{{% admonition type="note" %}} +{{< admonition type="note" >}} The linode APIv4 Token must be created with the scopes: `linodes:read_only`, `ips:read_only`, and `events:read_only`. -{{% /admonition %}} +{{< /admonition >}} ## Arguments @@ -185,11 +185,9 @@ prometheus.remote_write "demo" { - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.marathon.md b/docs/sources/flow/reference/components/discovery.marathon.md index b19ddb321c2c..43c50ab468de 100644 --- a/docs/sources/flow/reference/components/discovery.marathon.md +++ b/docs/sources/flow/reference/components/discovery.marathon.md @@ -155,11 +155,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.nerve.md b/docs/sources/flow/reference/components/discovery.nerve.md index 1334f6dea8e8..d8c7fc24bbe2 100644 --- a/docs/sources/flow/reference/components/discovery.nerve.md +++ b/docs/sources/flow/reference/components/discovery.nerve.md @@ -106,11 +106,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.nomad.md b/docs/sources/flow/reference/components/discovery.nomad.md index aebd128bb320..14c51bb6c72f 100644 --- a/docs/sources/flow/reference/components/discovery.nomad.md +++ b/docs/sources/flow/reference/components/discovery.nomad.md @@ -156,11 +156,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.openstack.md b/docs/sources/flow/reference/components/discovery.openstack.md index 83df98d8c41c..13b6f4924232 100644 --- a/docs/sources/flow/reference/components/discovery.openstack.md +++ b/docs/sources/flow/reference/components/discovery.openstack.md @@ -166,11 +166,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.ovhcloud.md b/docs/sources/flow/reference/components/discovery.ovhcloud.md index 453fcb3c1cfc..a433f4544a9a 100644 --- a/docs/sources/flow/reference/components/discovery.ovhcloud.md +++ b/docs/sources/flow/reference/components/discovery.ovhcloud.md @@ -155,11 +155,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.process.md b/docs/sources/flow/reference/components/discovery.process.md index f0d1eb184db2..839948d3d65b 100644 --- a/docs/sources/flow/reference/components/discovery.process.md +++ b/docs/sources/flow/reference/components/discovery.process.md @@ -15,9 +15,9 @@ title: discovery.process `discovery.process` discovers processes running on the local Linux OS. -{{% admonition type="note" %}} +{{< admonition type="note" >}} To use the `discovery.process` component you must run {{< param "PRODUCT_NAME" >}} as root and inside host PID namespace. -{{% /admonition %}} +{{< /admonition >}} ## Usage @@ -207,11 +207,9 @@ discovery.process "all" { - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/discovery.puppetdb.md b/docs/sources/flow/reference/components/discovery.puppetdb.md index a83d8454723c..c4e984bcd440 100644 --- a/docs/sources/flow/reference/components/discovery.puppetdb.md +++ b/docs/sources/flow/reference/components/discovery.puppetdb.md @@ -166,11 +166,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.relabel.md b/docs/sources/flow/reference/components/discovery.relabel.md index fb0928359273..5269f662f13f 100644 --- a/docs/sources/flow/reference/components/discovery.relabel.md +++ b/docs/sources/flow/reference/components/discovery.relabel.md @@ -135,11 +135,9 @@ discovery.relabel "keep_backend_only" { - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.scaleway.md b/docs/sources/flow/reference/components/discovery.scaleway.md index fc3ec8867212..f65aa6941346 100644 --- a/docs/sources/flow/reference/components/discovery.scaleway.md +++ b/docs/sources/flow/reference/components/discovery.scaleway.md @@ -183,11 +183,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.serverset.md b/docs/sources/flow/reference/components/discovery.serverset.md index 7eb43b5ee11d..a986c2966c18 100644 --- a/docs/sources/flow/reference/components/discovery.serverset.md +++ b/docs/sources/flow/reference/components/discovery.serverset.md @@ -104,11 +104,9 @@ prometheus.remote_write "default" { - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.triton.md b/docs/sources/flow/reference/components/discovery.triton.md index f48ae7f65b17..9a0c48d260cd 100644 --- a/docs/sources/flow/reference/components/discovery.triton.md +++ b/docs/sources/flow/reference/components/discovery.triton.md @@ -138,11 +138,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/discovery.uyuni.md b/docs/sources/flow/reference/components/discovery.uyuni.md index 42b77e8952b6..25909d8d5217 100644 --- a/docs/sources/flow/reference/components/discovery.uyuni.md +++ b/docs/sources/flow/reference/components/discovery.uyuni.md @@ -132,11 +132,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/faro.receiver.md b/docs/sources/flow/reference/components/faro.receiver.md index 3c15253f126a..72c95bfc195e 100644 --- a/docs/sources/flow/reference/components/faro.receiver.md +++ b/docs/sources/flow/reference/components/faro.receiver.md @@ -278,11 +278,9 @@ Replace the following: - Components that export [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/local.file_match.md b/docs/sources/flow/reference/components/local.file_match.md index 8c3ff3a43062..c9a083198718 100644 --- a/docs/sources/flow/reference/components/local.file_match.md +++ b/docs/sources/flow/reference/components/local.file_match.md @@ -158,11 +158,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.echo.md b/docs/sources/flow/reference/components/loki.echo.md index 756ffa00ee18..8109de1b96d0 100644 --- a/docs/sources/flow/reference/components/loki.echo.md +++ b/docs/sources/flow/reference/components/loki.echo.md @@ -76,11 +76,9 @@ loki.echo "example" { } - Components that consume [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.process.md b/docs/sources/flow/reference/components/loki.process.md index d1c8ef723bd9..91d25d7fdeee 100644 --- a/docs/sources/flow/reference/components/loki.process.md +++ b/docs/sources/flow/reference/components/loki.process.md @@ -382,7 +382,7 @@ following key-value pair to the set of extracted data. username: agent ``` -{{% admonition type="note" %}} +{{< admonition type="note" >}} Due to a limitation of the upstream jmespath library, you must wrap any string that contains a hyphen `-` in quotes so that it's not considered a numerical expression. @@ -394,7 +394,7 @@ You can use one of two options to circumvent this issue: 1. An escaped double quote. For example: `http_user_agent = "\"request_User-Agent\""` 1. A backtick quote. For example: ``http_user_agent = `"request_User-Agent"` `` -{{% /admonition %}} +{{< /admonition >}} ### stage.label_drop block @@ -581,9 +581,9 @@ The following arguments are supported: | `action` | `string` | The action to take when the selector matches the log line. Supported values are `"keep"` and `"drop"` | `"keep"` | no | | `drop_counter_reason` | `string` | A custom reason to report for dropped lines. | `"match_stage"` | no | -{{% admonition type="note" %}} +{{< admonition type="note" >}} The filters do not include label filter expressions such as `| label == "foobar"`. -{{% /admonition %}} +{{< /admonition >}} The `stage.match` block supports a number of `stage.*` inner blocks, like the top-level block. These are used to construct the nested set of stages to run if the @@ -1758,11 +1758,9 @@ loki.process "local" { - Components that consume [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.relabel.md b/docs/sources/flow/reference/components/loki.relabel.md index 4344af151b22..f60f5b2d40b4 100644 --- a/docs/sources/flow/reference/components/loki.relabel.md +++ b/docs/sources/flow/reference/components/loki.relabel.md @@ -124,11 +124,9 @@ loki.relabel "keep_error_only" { - Components that consume [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.api.md b/docs/sources/flow/reference/components/loki.source.api.md index afc2f3dad112..4c3f1fce87f3 100644 --- a/docs/sources/flow/reference/components/loki.source.api.md +++ b/docs/sources/flow/reference/components/loki.source.api.md @@ -126,11 +126,9 @@ loki.source.api "loki_push_api" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.awsfirehose.md b/docs/sources/flow/reference/components/loki.source.awsfirehose.md index 9b1d2c6d75c5..e621b750357d 100644 --- a/docs/sources/flow/reference/components/loki.source.awsfirehose.md +++ b/docs/sources/flow/reference/components/loki.source.awsfirehose.md @@ -120,9 +120,9 @@ The following blocks are supported inside the definition of `loki.source.awsfire ## Debug metrics The following are some of the metrics that are exposed when this component is used. -{{% admonition type="note" %}} +{{< admonition type="note" >}} The metrics include labels such as `status_code` where relevant, which you can use to measure request success rates. -{{%/admonition %}} +{{< /admonition >}} - `loki_source_awsfirehose_request_errors` (counter): Count of errors while receiving a request. - `loki_source_awsfirehose_record_errors` (counter): Count of errors while decoding an individual record. @@ -206,11 +206,9 @@ loki.relabel "logging_origin" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.azure_event_hubs.md b/docs/sources/flow/reference/components/loki.source.azure_event_hubs.md index fcbe22aa4880..f8aad7676b23 100644 --- a/docs/sources/flow/reference/components/loki.source.azure_event_hubs.md +++ b/docs/sources/flow/reference/components/loki.source.azure_event_hubs.md @@ -143,11 +143,9 @@ loki.write "example" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.cloudflare.md b/docs/sources/flow/reference/components/loki.source.cloudflare.md index cee51de6a541..0ce0312fcdeb 100644 --- a/docs/sources/flow/reference/components/loki.source.cloudflare.md +++ b/docs/sources/flow/reference/components/loki.source.cloudflare.md @@ -218,11 +218,9 @@ loki.write "local" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.docker.md b/docs/sources/flow/reference/components/loki.source.docker.md index 02bf03175b20..79a1204199e1 100644 --- a/docs/sources/flow/reference/components/loki.source.docker.md +++ b/docs/sources/flow/reference/components/loki.source.docker.md @@ -172,11 +172,9 @@ loki.write "local" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.file.md b/docs/sources/flow/reference/components/loki.source.file.md index edb407593c1f..a581ac0da043 100644 --- a/docs/sources/flow/reference/components/loki.source.file.md +++ b/docs/sources/flow/reference/components/loki.source.file.md @@ -17,9 +17,9 @@ title: loki.source.file Multiple `loki.source.file` components can be specified by giving them different labels. -{{% admonition type="note" %}} +{{< admonition type="note" >}} `loki.source.file` does not handle file discovery. You can use `local.file_match` for file discovery. Refer to the [File Globbing](#file-globbing) example for more information. -{{% /admonition %}} +{{< /admonition >}} ## Usage @@ -245,11 +245,9 @@ loki.write "local" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.gcplog.md b/docs/sources/flow/reference/components/loki.source.gcplog.md index 2ce88f73f398..4cb7cb59cbc0 100644 --- a/docs/sources/flow/reference/components/loki.source.gcplog.md +++ b/docs/sources/flow/reference/components/loki.source.gcplog.md @@ -202,11 +202,9 @@ loki.write "local" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.gelf.md b/docs/sources/flow/reference/components/loki.source.gelf.md index ac5796051be5..ccb0f7b37968 100644 --- a/docs/sources/flow/reference/components/loki.source.gelf.md +++ b/docs/sources/flow/reference/components/loki.source.gelf.md @@ -98,11 +98,9 @@ loki.write "endpoint" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.heroku.md b/docs/sources/flow/reference/components/loki.source.heroku.md index 8f2c01cea68c..df0df9a7bfc2 100644 --- a/docs/sources/flow/reference/components/loki.source.heroku.md +++ b/docs/sources/flow/reference/components/loki.source.heroku.md @@ -153,11 +153,9 @@ loki.write "local" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.journal.md b/docs/sources/flow/reference/components/loki.source.journal.md index 0448bd572d74..f80294e331ff 100644 --- a/docs/sources/flow/reference/components/loki.source.journal.md +++ b/docs/sources/flow/reference/components/loki.source.journal.md @@ -110,11 +110,9 @@ loki.write "endpoint" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.kafka.md b/docs/sources/flow/reference/components/loki.source.kafka.md index eb5e04217298..7f62ac3ff75e 100644 --- a/docs/sources/flow/reference/components/loki.source.kafka.md +++ b/docs/sources/flow/reference/components/loki.source.kafka.md @@ -183,11 +183,9 @@ loki.write "local" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.kubernetes.md b/docs/sources/flow/reference/components/loki.source.kubernetes.md index e9d19237aef6..a14e305d6d39 100644 --- a/docs/sources/flow/reference/components/loki.source.kubernetes.md +++ b/docs/sources/flow/reference/components/loki.source.kubernetes.md @@ -210,11 +210,9 @@ loki.write "local" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.kubernetes_events.md b/docs/sources/flow/reference/components/loki.source.kubernetes_events.md index 4447a915cfae..49a9f8b7d824 100644 --- a/docs/sources/flow/reference/components/loki.source.kubernetes_events.md +++ b/docs/sources/flow/reference/components/loki.source.kubernetes_events.md @@ -180,11 +180,9 @@ loki.write "local" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.podlogs.md b/docs/sources/flow/reference/components/loki.source.podlogs.md index 5e957c6ead09..2559fd95e055 100644 --- a/docs/sources/flow/reference/components/loki.source.podlogs.md +++ b/docs/sources/flow/reference/components/loki.source.podlogs.md @@ -299,11 +299,9 @@ loki.write "local" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.syslog.md b/docs/sources/flow/reference/components/loki.source.syslog.md index 017cc43ee0c5..c1c0900d4835 100644 --- a/docs/sources/flow/reference/components/loki.source.syslog.md +++ b/docs/sources/flow/reference/components/loki.source.syslog.md @@ -162,11 +162,9 @@ loki.write "local" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.source.windowsevent.md b/docs/sources/flow/reference/components/loki.source.windowsevent.md index bb41a62cc3eb..ae706b17c5d2 100644 --- a/docs/sources/flow/reference/components/loki.source.windowsevent.md +++ b/docs/sources/flow/reference/components/loki.source.windowsevent.md @@ -84,11 +84,9 @@ loki.write "endpoint" { - Components that export [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/loki.write.md b/docs/sources/flow/reference/components/loki.write.md index 75aad04f3f2a..946f72c5d324 100644 --- a/docs/sources/flow/reference/components/loki.write.md +++ b/docs/sources/flow/reference/components/loki.write.md @@ -243,11 +243,9 @@ Any labels that start with `__` will be removed before sending to the endpoint. - Components that consume [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/otelcol.connector.servicegraph.md b/docs/sources/flow/reference/components/otelcol.connector.servicegraph.md index ab3e55b5521f..8feb3dbff49e 100644 --- a/docs/sources/flow/reference/components/otelcol.connector.servicegraph.md +++ b/docs/sources/flow/reference/components/otelcol.connector.servicegraph.md @@ -231,11 +231,9 @@ traces_service_graph_request_failed_total{client="shop-backend",client_http_meth - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/otelcol.connector.spanlogs.md b/docs/sources/flow/reference/components/otelcol.connector.spanlogs.md index 5811b64b7733..1c49cd59554d 100644 --- a/docs/sources/flow/reference/components/otelcol.connector.spanlogs.md +++ b/docs/sources/flow/reference/components/otelcol.connector.spanlogs.md @@ -291,11 +291,9 @@ For an input trace like this... - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.connector.spanmetrics.md b/docs/sources/flow/reference/components/otelcol.connector.spanmetrics.md index 23c2eaa0a24d..80004502676a 100644 --- a/docs/sources/flow/reference/components/otelcol.connector.spanmetrics.md +++ b/docs/sources/flow/reference/components/otelcol.connector.spanmetrics.md @@ -751,13 +751,13 @@ The example below uses the [merge_maps][] OTTL function. If the resource attributes are not treated in either of the ways described above, an error such as this one could be logged by `prometheus.remote_write`: `the sample has been rejected because another sample with the same timestamp, but a different value, has already been ingested (err-mimir-sample-duplicate-timestamp)`. -{{% admonition type="note" %}} +{{< admonition type="note" >}} In order for a Prometheus `target_info` metric to be generated, the incoming spans resource scope attributes must contain `service.name` and `service.instance.id` attributes. The `target_info` metric will be generated for each resource scope, while OpenTelemetry metric names and attributes will be normalized to be compliant with Prometheus naming rules. -{{% /admonition %}} +{{< /admonition >}} [merge_maps]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/{{< param "OTEL_VERSION" >}}/pkg/ottl/ottlfuncs/README.md#merge_maps [prom-data-model]: https://prometheus.io/docs/concepts/data_model/ @@ -774,11 +774,9 @@ metric names and attributes will be normalized to be compliant with Prometheus n - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.exporter.loadbalancing.md b/docs/sources/flow/reference/components/otelcol.exporter.loadbalancing.md index 4552adce44ce..59283441f97c 100644 --- a/docs/sources/flow/reference/components/otelcol.exporter.loadbalancing.md +++ b/docs/sources/flow/reference/components/otelcol.exporter.loadbalancing.md @@ -961,11 +961,9 @@ k3d cluster delete grafana-agent-lb-test - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/otelcol.exporter.logging.md b/docs/sources/flow/reference/components/otelcol.exporter.logging.md index c1e4c8413948..739f717426ea 100644 --- a/docs/sources/flow/reference/components/otelcol.exporter.logging.md +++ b/docs/sources/flow/reference/components/otelcol.exporter.logging.md @@ -115,11 +115,9 @@ otelcol.exporter.logging "default" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.exporter.loki.md b/docs/sources/flow/reference/components/otelcol.exporter.loki.md index 9a314c3b5aae..ae14eba57f74 100644 --- a/docs/sources/flow/reference/components/otelcol.exporter.loki.md +++ b/docs/sources/flow/reference/components/otelcol.exporter.loki.md @@ -171,11 +171,9 @@ loki.write "local" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/otelcol.exporter.otlp.md b/docs/sources/flow/reference/components/otelcol.exporter.otlp.md index a03970cb3561..69f2700659aa 100644 --- a/docs/sources/flow/reference/components/otelcol.exporter.otlp.md +++ b/docs/sources/flow/reference/components/otelcol.exporter.otlp.md @@ -222,11 +222,9 @@ otelcol.auth.basic "grafana_cloud_tempo" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/otelcol.exporter.otlphttp.md b/docs/sources/flow/reference/components/otelcol.exporter.otlphttp.md index 14d0c5112fad..a6cb0e4c5832 100644 --- a/docs/sources/flow/reference/components/otelcol.exporter.otlphttp.md +++ b/docs/sources/flow/reference/components/otelcol.exporter.otlphttp.md @@ -163,11 +163,9 @@ otelcol.exporter.otlphttp "tempo" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.exporter.prometheus.md b/docs/sources/flow/reference/components/otelcol.exporter.prometheus.md index 4285f34cc799..bed0cdd6e48c 100644 --- a/docs/sources/flow/reference/components/otelcol.exporter.prometheus.md +++ b/docs/sources/flow/reference/components/otelcol.exporter.prometheus.md @@ -58,7 +58,7 @@ When `include_scope_labels` is `true` the `otel_scope_name` and When `include_target_info` is true, OpenTelemetry Collector resources are converted into `target_info` metrics. -{{% admonition type="note" %}} +{{< admonition type="note" >}} OTLP metrics can have a lot of resource attributes. Setting `resource_to_telemetry_conversion` to `true` would convert all of them to Prometheus labels, which may not be what you want. @@ -68,7 +68,7 @@ See [Creating Prometheus labels from OTLP resource attributes][] for an example. [Creating Prometheus labels from OTLP resource attributes]: #creating-prometheus-labels-from-otlp-resource-attributes -{{% /admonition %}} +{{< /admonition >}} ## Exported fields @@ -183,11 +183,9 @@ prometheus.remote_write "mimir" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.processor.attributes.md b/docs/sources/flow/reference/components/otelcol.processor.attributes.md index ae1b1eafe555..febcbb934664 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.attributes.md +++ b/docs/sources/flow/reference/components/otelcol.processor.attributes.md @@ -166,11 +166,11 @@ For example, adding a `span_names` filter could cause the component to error if The `exclude` block provides an option to exclude data from being fed into the [action] blocks based on the properties of a span, log, or metric records. -{{% admonition type="note" %}} +{{< admonition type="note" >}} Signals excluded by the `exclude` block will still be propagated to downstream components as-is. If you would like to not propagate certain signals to downstream components, consider a processor such as [otelcol.processor.tail_sampling]({{< relref "./otelcol.processor.tail_sampling.md" >}}). -{{% /admonition %}} +{{< /admonition >}} {{< docs/shared lookup="flow/reference/components/match-properties-block.md" source="agent" version="" >}} @@ -646,11 +646,9 @@ otelcol.processor.attributes "default" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.processor.batch.md b/docs/sources/flow/reference/components/otelcol.processor.batch.md index 7a8eff522ff5..cf8b42d534f8 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.batch.md +++ b/docs/sources/flow/reference/components/otelcol.processor.batch.md @@ -239,11 +239,9 @@ otelcol.exporter.otlp "production" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.processor.discovery.md b/docs/sources/flow/reference/components/otelcol.processor.discovery.md index 9d9b7c05e3a3..258f821a789d 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.discovery.md +++ b/docs/sources/flow/reference/components/otelcol.processor.discovery.md @@ -17,15 +17,15 @@ of labels for each discovered target. `otelcol.processor.discovery` adds resource attributes to spans which have a hostname matching the one in the `__address__` label provided by the `discovery.*` component. -{{% admonition type="note" %}} +{{< admonition type="note" >}} `otelcol.processor.discovery` is a custom component unrelated to any processors from the OpenTelemetry Collector. -{{% /admonition %}} +{{< /admonition >}} Multiple `otelcol.processor.discovery` components can be specified by giving them different labels. -{{% admonition type="note" %}} +{{< admonition type="note" >}} It can be difficult to follow [OpenTelemetry semantic conventions][OTEL sem conv] when adding resource attributes via `otelcol.processor.discovery`: * `discovery.relabel` and most `discovery.*` processes such as `discovery.kubernetes` @@ -47,7 +47,7 @@ from Static mode's `prom_sd_operation_type`/`prom_sd_pod_associations` [configur [Prometheus data model]: https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels [OTEL sem conv]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/README.md [Traces]: {{< relref "../../../static/configuration/traces-config.md" >}} -{{% /admonition %}} +{{< /admonition >}} ## Usage @@ -205,11 +205,9 @@ otelcol.processor.discovery "default" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/otelcol.processor.filter.md b/docs/sources/flow/reference/components/otelcol.processor.filter.md index 49a11028a80c..7fe282407be5 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.filter.md +++ b/docs/sources/flow/reference/components/otelcol.processor.filter.md @@ -39,22 +39,22 @@ the following metrics-only functions are used exclusively by the processor: * `end_time_unix_nano - start_time_unix_nano` * `sum([1, 2, 3, 4]) + (10 / 1) - 1` -{{% admonition type="note" %}} +{{< admonition type="note" >}} Raw River strings can be used to write OTTL statements. For example, the OTTL statement `attributes["grpc"] == true` is written in River as \`attributes["grpc"] == true\` -{{% /admonition %}} +{{< /admonition >}} -{{% admonition type="note" %}} +{{< admonition type="note" >}} `otelcol.processor.filter` is a wrapper over the upstream OpenTelemetry Collector `filter` processor. If necessary, bug reports or feature requests will be redirected to the upstream repository. -{{% /admonition %}} +{{< /admonition >}} You can specify multiple `otelcol.processor.filter` components by giving them different labels. -{{% admonition type="warning" %}} +{{< admonition type="warning" >}} Exercise caution when using `otelcol.processor.filter`: - Make sure you understand schema/format of the incoming data and test the configuration thoroughly. @@ -64,7 +64,7 @@ Exercise caution when using `otelcol.processor.filter`: if the log references the dropped span. [Orphaned Telemetry]: https://github.com/open-telemetry/opentelemetry-collector/blob/v0.85.0/docs/standard-warnings.md#orphaned-telemetry -{{% /admonition %}} +{{< /admonition >}} ## Usage @@ -316,11 +316,9 @@ Some values in the River strings are [escaped][river-strings]: - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.processor.k8sattributes.md b/docs/sources/flow/reference/components/otelcol.processor.k8sattributes.md index 6e16dcebcd48..8d3d9601065c 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.k8sattributes.md +++ b/docs/sources/flow/reference/components/otelcol.processor.k8sattributes.md @@ -14,11 +14,11 @@ title: otelcol.processor.k8sattributes `otelcol.processor.k8sattributes` accepts telemetry data from other `otelcol` components and adds Kubernetes metadata to the resource attributes of spans, logs, or metrics. -{{% admonition type="note" %}} +{{< admonition type="note" >}} `otelcol.processor.k8sattributes` is a wrapper over the upstream OpenTelemetry Collector `k8sattributes` processor. If necessary, bug reports or feature requests will be redirected to the upstream repository. -{{% /admonition %}} +{{< /admonition >}} You can specify multiple `otelcol.processor.k8sattributes` components by giving them different labels. @@ -422,11 +422,9 @@ prometheus.remote_write "mimir" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.processor.memory_limiter.md b/docs/sources/flow/reference/components/otelcol.processor.memory_limiter.md index 9d1528adf70d..30a9f1614149 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.memory_limiter.md +++ b/docs/sources/flow/reference/components/otelcol.processor.memory_limiter.md @@ -121,11 +121,9 @@ information. - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.processor.probabilistic_sampler.md b/docs/sources/flow/reference/components/otelcol.processor.probabilistic_sampler.md index a76c85b2a21b..de866428c515 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.probabilistic_sampler.md +++ b/docs/sources/flow/reference/components/otelcol.processor.probabilistic_sampler.md @@ -15,11 +15,11 @@ title: otelcol.processor.probabilistic_sampler `otelcol.processor.probabilistic_sampler` accepts logs and traces data from other otelcol components and applies probabilistic sampling based on configuration options. -{{% admonition type="note" %}} +{{< admonition type="note" >}} `otelcol.processor.probabilistic_sampler` is a wrapper over the upstream OpenTelemetry Collector Contrib `probabilistic_sampler` processor. If necessary, bug reports or feature requests will be redirected to the upstream repository. -{{% /admonition %}} +{{< /admonition >}} You can specify multiple `otelcol.processor.probabilistic_sampler` components by giving them different labels. @@ -157,11 +157,9 @@ otelcol.processor.probabilistic_sampler "default" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.processor.resourcedetection.md b/docs/sources/flow/reference/components/otelcol.processor.resourcedetection.md index 4c727fa6e788..d6d476c481aa 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.resourcedetection.md +++ b/docs/sources/flow/reference/components/otelcol.processor.resourcedetection.md @@ -19,11 +19,11 @@ description: Learn about otelcol.processor.resourcedetection in a format that conforms to the [OpenTelemetry resource semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions/), and appends or overrides the resource values in the telemetry data with this information. -{{% admonition type="note" %}} +{{< admonition type="note" >}} `otelcol.processor.resourcedetection` is a wrapper over the upstream OpenTelemetry Collector Contrib `resourcedetection` processor. If necessary, bug reports or feature requests are redirected to the upstream repository. -{{% /admonition %}} +{{< /admonition >}} You can specify multiple `otelcol.processor.resourcedetection` components by giving them different labels. @@ -581,11 +581,11 @@ For more information, see the [Heroku cloud provider documentation][] under the The `system` block queries the host machine to retrieve various resource attributes. -{{% admonition type="note" %}} +{{< admonition type="note" >}} Use the [Docker](#docker) detector if running {{< param "PRODUCT_ROOT_NAME" >}} as a Docker container. -{{% /admonition %}} +{{< /admonition >}} The `system` block supports the following attributes: @@ -923,11 +923,9 @@ You need to add this to your workload: - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.processor.span.md b/docs/sources/flow/reference/components/otelcol.processor.span.md index fe6985881007..ac909575cb1a 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.span.md +++ b/docs/sources/flow/reference/components/otelcol.processor.span.md @@ -400,11 +400,9 @@ otelcol.processor.span "default" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.processor.tail_sampling.md b/docs/sources/flow/reference/components/otelcol.processor.tail_sampling.md index b6c6ccfdc0f7..cb651d67e4f0 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.tail_sampling.md +++ b/docs/sources/flow/reference/components/otelcol.processor.tail_sampling.md @@ -565,11 +565,9 @@ otelcol.exporter.otlp "production" { - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.processor.transform.md b/docs/sources/flow/reference/components/otelcol.processor.transform.md index 81967bb11c24..9a70c07e9509 100644 --- a/docs/sources/flow/reference/components/otelcol.processor.transform.md +++ b/docs/sources/flow/reference/components/otelcol.processor.transform.md @@ -42,7 +42,7 @@ there is also a set of metrics-only functions: * `end_time_unix_nano - start_time_unix_nano` * `sum([1, 2, 3, 4]) + (10 / 1) - 1` -{{% admonition type="note" %}} +{{< admonition type="note" >}} There are two ways of inputting strings in River configuration files: * Using quotation marks ([normal River strings][river-strings]). Characters such as `\` and `"` must be escaped by preceding them with a `\` character. @@ -57,17 +57,17 @@ Raw strings are generally more convenient for writing OTTL statements. [river-strings]: {{< relref "../../concepts/config-language/expressions/types_and_values.md/#strings" >}} [river-raw-strings]: {{< relref "../../concepts/config-language/expressions/types_and_values.md/#raw-strings" >}} -{{% /admonition %}} +{{< /admonition >}} -{{% admonition type="note" %}} +{{< admonition type="note" >}} `otelcol.processor.transform` is a wrapper over the upstream OpenTelemetry Collector `transform` processor. If necessary, bug reports or feature requests will be redirected to the upstream repository. -{{% /admonition %}} +{{< /admonition >}} You can specify multiple `otelcol.processor.transform` components by giving them different labels. -{{% admonition type="warning" %}} +{{< admonition type="warning" >}} `otelcol.processor.transform` allows you to modify all aspects of your telemetry. Some specific risks are given below, but this is not an exhaustive list. It is important to understand your data before using this processor. @@ -88,7 +88,7 @@ to a new metric data type or can be used to create new metrics. [Orphaned Telemetry]: https://github.com/open-telemetry/opentelemetry-collector/blob/{{< param "OTEL_VERSION" >}}/docs/standard-warnings.md#orphaned-telemetry [no-op]: https://en.wikipedia.org/wiki/NOP_(code) [metrics data model]: https://github.com/open-telemetry/opentelemetry-specification/blob/main//specification/metrics/data-model.md -{{% /admonition %}} +{{< /admonition >}} ## Usage @@ -602,11 +602,9 @@ each `"` with a `\"`, and each `\` with a `\\` inside a [normal][river-strings] - Components that consume [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.receiver.jaeger.md b/docs/sources/flow/reference/components/otelcol.receiver.jaeger.md index c19bb03dba77..4f584319fb6c 100644 --- a/docs/sources/flow/reference/components/otelcol.receiver.jaeger.md +++ b/docs/sources/flow/reference/components/otelcol.receiver.jaeger.md @@ -287,11 +287,9 @@ otelcol.exporter.otlp "default" { - Components that export [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.receiver.kafka.md b/docs/sources/flow/reference/components/otelcol.receiver.kafka.md index 28588420609d..abb89ef82fb3 100644 --- a/docs/sources/flow/reference/components/otelcol.receiver.kafka.md +++ b/docs/sources/flow/reference/components/otelcol.receiver.kafka.md @@ -339,11 +339,9 @@ otelcol.exporter.otlp "default" { - Components that export [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.receiver.loki.md b/docs/sources/flow/reference/components/otelcol.receiver.loki.md index 31d9877da882..c06b82cbe3dc 100644 --- a/docs/sources/flow/reference/components/otelcol.receiver.loki.md +++ b/docs/sources/flow/reference/components/otelcol.receiver.loki.md @@ -112,11 +112,9 @@ otelcol.exporter.otlp "default" { - Components that consume [Loki `LogsReceiver`]({{< relref "../compatibility/#loki-logsreceiver-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/otelcol.receiver.opencensus.md b/docs/sources/flow/reference/components/otelcol.receiver.opencensus.md index a6d7a5bb3ae3..ac694d890712 100644 --- a/docs/sources/flow/reference/components/otelcol.receiver.opencensus.md +++ b/docs/sources/flow/reference/components/otelcol.receiver.opencensus.md @@ -219,11 +219,9 @@ otelcol.exporter.otlp "default" { - Components that export [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.receiver.otlp.md b/docs/sources/flow/reference/components/otelcol.receiver.otlp.md index 134098ed2de4..862562508afd 100644 --- a/docs/sources/flow/reference/components/otelcol.receiver.otlp.md +++ b/docs/sources/flow/reference/components/otelcol.receiver.otlp.md @@ -257,11 +257,9 @@ otelcol.exporter.otlp "default" { - Components that export [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.receiver.prometheus.md b/docs/sources/flow/reference/components/otelcol.receiver.prometheus.md index d0723aad80c4..7611b0955a4b 100644 --- a/docs/sources/flow/reference/components/otelcol.receiver.prometheus.md +++ b/docs/sources/flow/reference/components/otelcol.receiver.prometheus.md @@ -111,11 +111,9 @@ otelcol.exporter.otlp "default" { - Components that consume [Prometheus `MetricsReceiver`]({{< relref "../compatibility/#prometheus-metricsreceiver-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.receiver.vcenter.md b/docs/sources/flow/reference/components/otelcol.receiver.vcenter.md index 11e6a0485e09..54891a882da4 100644 --- a/docs/sources/flow/reference/components/otelcol.receiver.vcenter.md +++ b/docs/sources/flow/reference/components/otelcol.receiver.vcenter.md @@ -230,11 +230,9 @@ otelcol.exporter.otlp "default" { - Components that export [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/otelcol.receiver.zipkin.md b/docs/sources/flow/reference/components/otelcol.receiver.zipkin.md index 2dd3d8a9ccfb..5d6c903036d1 100644 --- a/docs/sources/flow/reference/components/otelcol.receiver.zipkin.md +++ b/docs/sources/flow/reference/components/otelcol.receiver.zipkin.md @@ -152,11 +152,9 @@ otelcol.exporter.otlp "default" { - Components that export [OpenTelemetry `otelcol.Consumer`]({{< relref "../compatibility/#opentelemetry-otelcolconsumer-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/prometheus.exporter.agent.md b/docs/sources/flow/reference/components/prometheus.exporter.agent.md index 511be5217334..a4575bb08c1b 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.agent.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.agent.md @@ -82,11 +82,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.apache.md b/docs/sources/flow/reference/components/prometheus.exporter.apache.md index 08f19fa2d1d9..d3f786083b37 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.apache.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.apache.md @@ -96,11 +96,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.azure.md b/docs/sources/flow/reference/components/prometheus.exporter.azure.md index ea8fa08cd912..1835e5e24745 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.azure.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.azure.md @@ -180,11 +180,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md b/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md index 23f334b2f1a6..fb2a2653e983 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.blackbox.md @@ -204,11 +204,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.cadvisor.md b/docs/sources/flow/reference/components/prometheus.exporter.cadvisor.md index 02c923ebe898..b6cdf1f98e21 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.cadvisor.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.cadvisor.md @@ -135,11 +135,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.cloudwatch.md b/docs/sources/flow/reference/components/prometheus.exporter.cloudwatch.md index 2c1682a5fccc..0aad4bd0d8e7 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.cloudwatch.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.cloudwatch.md @@ -147,9 +147,9 @@ You can use the following blocks in`prometheus.exporter.cloudwatch` to configure | static > metric | [metric][] | Configures the list of metrics the job should scrape. Multiple metrics can be defined inside one job. | yes | | decoupled_scraping | [decoupled_scraping][] | Configures the decoupled scraping feature to retrieve metrics on a schedule and return the cached metrics. | no | -{{% admonition type="note" %}} +{{< admonition type="note" >}} The `static` and `discovery` blocks are marked as not required, but you must configure at least one static or discovery job. -{{% /admonition %}} +{{< /admonition >}} [discovery]: #discovery-block [static]: #static-block @@ -463,11 +463,9 @@ discovery job, the `type` field of each `discovery_job` must match either the de - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.consul.md b/docs/sources/flow/reference/components/prometheus.exporter.consul.md index 81185047459e..6a38931ad0d0 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.consul.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.consul.md @@ -106,11 +106,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.dnsmasq.md b/docs/sources/flow/reference/components/prometheus.exporter.dnsmasq.md index 2f22e0048807..bf60a1fee166 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.dnsmasq.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.dnsmasq.md @@ -96,11 +96,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.elasticsearch.md b/docs/sources/flow/reference/components/prometheus.exporter.elasticsearch.md index 6feb9c683eeb..f7150a3d41b4 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.elasticsearch.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.elasticsearch.md @@ -15,10 +15,10 @@ The `prometheus.exporter.elasticsearch` component embeds [elasticsearch_exporter](https://github.com/prometheus-community/elasticsearch_exporter) for the collection of metrics from ElasticSearch servers. -{{% admonition type="note" %}} +{{< admonition type="note" >}} Currently, an Agent can only collect metrics from a single ElasticSearch server. However, the exporter can collect the metrics from all nodes through that server configured. -{{% /admonition %}} +{{< /admonition >}} We strongly recommend that you configure a separate user for the Agent, and give it only the strictly mandatory security privileges necessary for monitoring your node, as per the [official documentation](https://github.com/prometheus-community/elasticsearch_exporter#elasticsearch-7x-security-privileges). @@ -139,11 +139,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.gcp.md b/docs/sources/flow/reference/components/prometheus.exporter.gcp.md index e9a3d7ab2786..b7ff3158c372 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.gcp.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.gcp.md @@ -59,9 +59,9 @@ prometheus.exporter.gcp "pubsub" { You can use the following arguments to configure the exporter's behavior. Omitted fields take their default values. -{{% admonition type="note" %}} +{{< admonition type="note" >}} Please note that if you are supplying a list of strings for the `extra_filters` argument, any string values within a particular filter string must be enclosed in escaped double quotes. For example, `loadbalancing.googleapis.com:resource.labels.backend_target_name="sample-value"` must be encoded as `"loadbalancing.googleapis.com:resource.labels.backend_target_name=\"sample-value\""` in the River config. -{{% /admonition %}} +{{< /admonition >}} | Name | Type | Description | Default | Required | | ------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- | @@ -182,11 +182,9 @@ prometheus.exporter.gcp "lb_subset_with_filter" { - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.github.md b/docs/sources/flow/reference/components/prometheus.exporter.github.md index 753458562ab5..662617299da4 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.github.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.github.md @@ -104,11 +104,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.kafka.md b/docs/sources/flow/reference/components/prometheus.exporter.kafka.md index 59400eea67fe..1de06212f557 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.kafka.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.kafka.md @@ -116,11 +116,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.memcached.md b/docs/sources/flow/reference/components/prometheus.exporter.memcached.md index bd158d76a996..7e9cc9a53d87 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.memcached.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.memcached.md @@ -108,11 +108,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.mongodb.md b/docs/sources/flow/reference/components/prometheus.exporter.mongodb.md index 1aa855542c06..4301eee4f4d2 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.mongodb.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.mongodb.md @@ -13,9 +13,9 @@ title: prometheus.exporter.mongodb The `prometheus.exporter.mongodb` component embeds percona's [`mongodb_exporter`](https://github.com/percona/mongodb_exporter). -{{% admonition type="note" %}} +{{< admonition type="note" >}} This exporter doesn't collect metrics from multiple nodes. For this integration to work properly, you must have connect each node of your MongoDB cluster to a {{< param "PRODUCT_NAME" >}} instance. -{{% /admonition %}} +{{< /admonition >}} We strongly recommend configuring a separate user for {{< param "PRODUCT_NAME" >}}, giving it only the strictly mandatory security privileges necessary for monitoring your node. Refer to the [Percona documentation](https://github.com/percona/mongodb_exporter#permissions) for more information. @@ -97,11 +97,9 @@ prometheus.remote_write "default" { - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.mssql.md b/docs/sources/flow/reference/components/prometheus.exporter.mssql.md index e2bcad76830e..6db00954f332 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.mssql.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.mssql.md @@ -339,11 +339,9 @@ queries: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.mysql.md b/docs/sources/flow/reference/components/prometheus.exporter.mysql.md index 7c0cb90ae69f..edc1c1a5a49f 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.mysql.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.mysql.md @@ -221,11 +221,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.oracledb.md b/docs/sources/flow/reference/components/prometheus.exporter.oracledb.md index 10712ba290d5..4053acc074b0 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.oracledb.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.oracledb.md @@ -109,11 +109,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.postgres.md b/docs/sources/flow/reference/components/prometheus.exporter.postgres.md index 39cfd8770108..f50e9fd77709 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.postgres.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.postgres.md @@ -222,11 +222,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.process.md b/docs/sources/flow/reference/components/prometheus.exporter.process.md index ddd315f28797..da135994fd7b 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.process.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.process.md @@ -142,11 +142,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.redis.md b/docs/sources/flow/reference/components/prometheus.exporter.redis.md index cebbbdd02906..ccb114ea8db5 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.redis.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.redis.md @@ -140,11 +140,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.snmp.md b/docs/sources/flow/reference/components/prometheus.exporter.snmp.md index 85b3d6a895bd..5bd05efed907 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.snmp.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.snmp.md @@ -14,9 +14,9 @@ title: prometheus.exporter.snmp The `prometheus.exporter.snmp` component embeds [`snmp_exporter`](https://github.com/prometheus/snmp_exporter). `snmp_exporter` lets you collect SNMP data and expose them as Prometheus metrics. -{{% admonition type="note" %}} +{{< admonition type="note" >}} `prometheus.exporter.snmp` uses the latest configuration introduced in version 0.23 of the Prometheus `snmp_exporter`. -{{% /admonition %}} +{{< /admonition >}} ## Usage @@ -208,11 +208,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.snowflake.md b/docs/sources/flow/reference/components/prometheus.exporter.snowflake.md index f384fd1a6805..9211f9424cbe 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.snowflake.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.snowflake.md @@ -110,11 +110,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.squid.md b/docs/sources/flow/reference/components/prometheus.exporter.squid.md index 49a8639c129d..957297d4af4e 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.squid.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.squid.md @@ -102,11 +102,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.statsd.md b/docs/sources/flow/reference/components/prometheus.exporter.statsd.md index 2e00b8db35b0..d7b2e7fc48df 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.statsd.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.statsd.md @@ -135,11 +135,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.unix.md b/docs/sources/flow/reference/components/prometheus.exporter.unix.md index ab2d88c8175e..7f3f4ca935cf 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.unix.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.unix.md @@ -418,11 +418,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.vsphere.md b/docs/sources/flow/reference/components/prometheus.exporter.vsphere.md index 61c951e9c71d..499805179f11 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.vsphere.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.vsphere.md @@ -98,11 +98,9 @@ prometheus.remote_write "default" { - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.exporter.windows.md b/docs/sources/flow/reference/components/prometheus.exporter.windows.md index fc16fed3230d..14e22d13d2b7 100644 --- a/docs/sources/flow/reference/components/prometheus.exporter.windows.md +++ b/docs/sources/flow/reference/components/prometheus.exporter.windows.md @@ -17,10 +17,10 @@ wide variety of hardware and OS metrics for Windows-based systems. The `windows_exporter` itself comprises various _collectors_, which you can enable and disable as needed. For more information on collectors, refer to the [`collectors-list`](#collectors-list) section. -{{% admonition type="note" %}} +{{< admonition type="note" >}} The black and white list configuration options are available for backwards compatibility but are deprecated. The include and exclude configuration options are preferred going forward. -{{% /admonition %}} +{{< /admonition >}} ## Usage @@ -286,10 +286,10 @@ Name | Description | Enabled by default Refer to the linked documentation on each collector for more information on reported metrics, configuration settings and usage examples. -{{% admonition type="caution" %}} +{{< admonition type="caution" >}} Certain collectors will cause {{< param "PRODUCT_ROOT_NAME" >}} to crash if those collectors are used and the required infrastructure isn't installed. These include but aren't limited to mscluster_*, vmware, nps, dns, msmq, teradici_pcoip, ad, hyperv, and scheduled_task. -{{% /admonition %}} +{{< /admonition >}} ## Example @@ -331,11 +331,9 @@ Replace the following: - Components that consume [Targets]({{< relref "../compatibility/#targets-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.operator.podmonitors.md b/docs/sources/flow/reference/components/prometheus.operator.podmonitors.md index fa324640d0ee..b8ef773567ca 100644 --- a/docs/sources/flow/reference/components/prometheus.operator.podmonitors.md +++ b/docs/sources/flow/reference/components/prometheus.operator.podmonitors.md @@ -265,11 +265,9 @@ prometheus.operator.podmonitors "pods" { - Components that export [Prometheus `MetricsReceiver`]({{< relref "../compatibility/#prometheus-metricsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/prometheus.operator.probes.md b/docs/sources/flow/reference/components/prometheus.operator.probes.md index 256634a88438..c8fddb96e1dd 100644 --- a/docs/sources/flow/reference/components/prometheus.operator.probes.md +++ b/docs/sources/flow/reference/components/prometheus.operator.probes.md @@ -267,11 +267,9 @@ prometheus.operator.probes "probes" { - Components that export [Prometheus `MetricsReceiver`]({{< relref "../compatibility/#prometheus-metricsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/prometheus.operator.servicemonitors.md b/docs/sources/flow/reference/components/prometheus.operator.servicemonitors.md index 8b2e0ce29cdf..29a6414a6339 100644 --- a/docs/sources/flow/reference/components/prometheus.operator.servicemonitors.md +++ b/docs/sources/flow/reference/components/prometheus.operator.servicemonitors.md @@ -267,11 +267,9 @@ prometheus.operator.servicemonitors "services" { - Components that export [Prometheus `MetricsReceiver`]({{< relref "../compatibility/#prometheus-metricsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/prometheus.receive_http.md b/docs/sources/flow/reference/components/prometheus.receive_http.md index d48985cc3f18..38d43cef5067 100644 --- a/docs/sources/flow/reference/components/prometheus.receive_http.md +++ b/docs/sources/flow/reference/components/prometheus.receive_http.md @@ -138,11 +138,9 @@ prometheus.remote_write "local" { - Components that export [Prometheus `MetricsReceiver`]({{< relref "../compatibility/#prometheus-metricsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/prometheus.relabel.md b/docs/sources/flow/reference/components/prometheus.relabel.md index 65cb02394d4a..22d6c0a42d28 100644 --- a/docs/sources/flow/reference/components/prometheus.relabel.md +++ b/docs/sources/flow/reference/components/prometheus.relabel.md @@ -181,11 +181,9 @@ The two resulting metrics are then propagated to each receiver defined in the - Components that consume [Prometheus `MetricsReceiver`]({{< relref "../compatibility/#prometheus-metricsreceiver-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/prometheus.remote_write.md b/docs/sources/flow/reference/components/prometheus.remote_write.md index f869343e0919..5664cd10aa6e 100644 --- a/docs/sources/flow/reference/components/prometheus.remote_write.md +++ b/docs/sources/flow/reference/components/prometheus.remote_write.md @@ -418,11 +418,9 @@ Any labels that start with `__` will be removed before sending to the endpoint. - Components that consume [Prometheus `MetricsReceiver`]({{< relref "../compatibility/#prometheus-metricsreceiver-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/prometheus.scrape.md b/docs/sources/flow/reference/components/prometheus.scrape.md index 8adf775687f1..765eb084b32f 100644 --- a/docs/sources/flow/reference/components/prometheus.scrape.md +++ b/docs/sources/flow/reference/components/prometheus.scrape.md @@ -298,11 +298,9 @@ Special labels added after a scrape - Components that export [Prometheus `MetricsReceiver`]({{< relref "../compatibility/#prometheus-metricsreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/pyroscope.ebpf.md b/docs/sources/flow/reference/components/pyroscope.ebpf.md index a324e71293ab..2ec8a7fa2199 100644 --- a/docs/sources/flow/reference/components/pyroscope.ebpf.md +++ b/docs/sources/flow/reference/components/pyroscope.ebpf.md @@ -18,9 +18,9 @@ title: pyroscope.ebpf `pyroscope.ebpf` configures an ebpf profiling job for the current host. The collected performance profiles are forwarded to the list of receivers passed in `forward_to`. -{{% admonition type="note" %}} +{{< admonition type="note" >}} To use the `pyroscope.ebpf` component you must run {{< param "PRODUCT_NAME" >}} as root and inside host pid namespace. -{{% /admonition %}} +{{< /admonition >}} You can specify multiple `pyroscope.ebpf` components by giving them different labels, however it is not recommended as it can lead to additional memory and CPU usage. @@ -298,11 +298,9 @@ pyroscope.ebpf "default" { - Components that export [Pyroscope `ProfilesReceiver`]({{< relref "../compatibility/#pyroscope-profilesreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/pyroscope.java.md b/docs/sources/flow/reference/components/pyroscope.java.md index 35ee91784816..92407132e99d 100644 --- a/docs/sources/flow/reference/components/pyroscope.java.md +++ b/docs/sources/flow/reference/components/pyroscope.java.md @@ -16,9 +16,9 @@ title: pyroscope.java `pyroscope.java` continuously profiles Java processes running on the local Linux OS using [async-profiler](https://github.com/async-profiler/async-profiler). -{{% admonition type="note" %}} +{{< admonition type="note" >}} To use the `pyroscope.java` component you must run {{< param "PRODUCT_NAME" >}} as root and inside host PID namespace. -{{% /admonition %}} +{{< /admonition >}} ## Usage @@ -57,11 +57,11 @@ async-profiler binaries for both glibc and musl into the directory with the foll After process profiling startup, the component detects libc type and copies according `libAsyncProfiler.so` into the target process file system at the exact same path. -{{% admonition type="note" %}} +{{< admonition type="note" >}} The `asprof` binary runs with root permissions. If you change the `tmp_dir` configuration to something other than `/tmp`, then you must ensure that the directory is only writable by root. -{{% /admonition %}} +{{< /admonition >}} #### `targets` argument @@ -181,11 +181,9 @@ pyroscope.java "java" { - Components that export [Pyroscope `ProfilesReceiver`]({{< relref "../compatibility/#pyroscope-profilesreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/components/pyroscope.scrape.md b/docs/sources/flow/reference/components/pyroscope.scrape.md index 4e4e95d04bae..35e7022df482 100644 --- a/docs/sources/flow/reference/components/pyroscope.scrape.md +++ b/docs/sources/flow/reference/components/pyroscope.scrape.md @@ -589,11 +589,9 @@ http://localhost:12345/debug/pprof/mutex - Components that export [Pyroscope `ProfilesReceiver`]({{< relref "../compatibility/#pyroscope-profilesreceiver-exporters" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} diff --git a/docs/sources/flow/reference/components/pyroscope.write.md b/docs/sources/flow/reference/components/pyroscope.write.md index 38b6b542abc0..3012be03319c 100644 --- a/docs/sources/flow/reference/components/pyroscope.write.md +++ b/docs/sources/flow/reference/components/pyroscope.write.md @@ -168,11 +168,9 @@ pyroscope.scrape "default" { - Components that consume [Pyroscope `ProfilesReceiver`]({{< relref "../compatibility/#pyroscope-profilesreceiver-consumers" >}}) -{{% admonition type="note" %}} - -Connecting some components may not be sensible or components may require further configuration to make the -connection work correctly. Refer to the linked documentation for more details. - -{{% /admonition %}} +{{< admonition type="note" >}} +Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. +Refer to the linked documentation for more details. +{{< /admonition >}} \ No newline at end of file diff --git a/docs/sources/flow/reference/config-blocks/http.md b/docs/sources/flow/reference/config-blocks/http.md index 39ffa5b2502c..f90944c3ff59 100644 --- a/docs/sources/flow/reference/config-blocks/http.md +++ b/docs/sources/flow/reference/config-blocks/http.md @@ -50,12 +50,12 @@ tls > windows_certificate_filter > server | [server][] | Con The `tls` block configures TLS settings for the HTTP server. -{{% admonition type="warning" %}} +{{< admonition type="warning" >}} If you add the `tls` block and reload the configuration when {{< param "PRODUCT_NAME" >}} is running, existing connections will continue communicating over plaintext. Similarly, if you remove the `tls` block and reload the configuration when {{< param "PRODUCT_NAME" >}} is running, existing connections will continue communicating over TLS. To ensure all connections use TLS, configure the `tls` block before you start {{< param "PRODUCT_NAME" >}}. -{{% /admonition %}} +{{< /admonition >}} Name | Type | Description | Default | Required ---- | ---- | ----------- | ------- | -------- @@ -159,12 +159,12 @@ the following TLS settings are overridden and will cause an error if defined. * `client_ca` * `client_ca_file` -{{% admonition type="warning" %}} +{{< admonition type="warning" >}} This feature is only available on Windows. TLS min and max may not be compatible with the certificate stored in the Windows certificate store. The `windows_certificate_filter` will serve the found certificate even if it is not compatible with the specified TLS version. -{{% /admonition %}} +{{< /admonition >}} ### server block diff --git a/docs/sources/flow/release-notes.md b/docs/sources/flow/release-notes.md index 06de96daafcf..baa91ae3d068 100644 --- a/docs/sources/flow/release-notes.md +++ b/docs/sources/flow/release-notes.md @@ -18,7 +18,7 @@ The release notes provide information about deprecations and breaking changes in For a complete list of changes to {{< param "PRODUCT_ROOT_NAME" >}}, with links to pull requests and related issues when available, refer to the [Changelog](https://github.com/grafana/agent/blob/main/CHANGELOG.md). -{{% admonition type="note" %}} +{{< admonition type="note" >}} These release notes are specific to {{< param "PRODUCT_NAME" >}}. Other release notes for the different {{< param "PRODUCT_ROOT_NAME" >}} variants are contained on separate pages: @@ -27,7 +27,7 @@ Other release notes for the different {{< param "PRODUCT_ROOT_NAME" >}} variants [release-notes-static]: {{< relref "../static/release-notes.md" >}} [release-notes-operator]: {{< relref "../operator/release-notes.md" >}} -{{% /admonition %}} +{{< /admonition >}} ## v0.40 diff --git a/docs/sources/flow/tasks/configure/configure-macos.md b/docs/sources/flow/tasks/configure/configure-macos.md index fc1c6677f579..8b860a010dcd 100644 --- a/docs/sources/flow/tasks/configure/configure-macos.md +++ b/docs/sources/flow/tasks/configure/configure-macos.md @@ -31,11 +31,11 @@ To configure {{< param "PRODUCT_NAME" >}} on macOS, perform the following steps: ## Configure the {{% param "PRODUCT_NAME" %}} service -{{% admonition type="note" %}} +{{< admonition type="note" >}} Due to limitations in Homebrew, customizing the service used by {{< param "PRODUCT_NAME" >}} on macOS requires changing the Homebrew formula and reinstalling {{< param "PRODUCT_NAME" >}}. -{{% /admonition %}} +{{< /admonition >}} To customize the {{< param "PRODUCT_NAME" >}} service on macOS, perform the following steps: diff --git a/docs/sources/flow/tasks/estimate-resource-usage.md b/docs/sources/flow/tasks/estimate-resource-usage.md index d57b55a8f5a1..f3ed1b7aed05 100644 --- a/docs/sources/flow/tasks/estimate-resource-usage.md +++ b/docs/sources/flow/tasks/estimate-resource-usage.md @@ -23,16 +23,14 @@ weight: 190 # Estimate {{% param "PRODUCT_NAME" %}} resource usage This page provides guidance for expected resource usage of -{{% param "PRODUCT_NAME" %}} for each telemetry type, based on operational -experience of some of the {{% param "PRODUCT_NAME" %}} maintainers. - -{{% admonition type="note" %}} +{{< param "PRODUCT_NAME" >}} for each telemetry type, based on operational +experience of some of the {{< param "PRODUCT_NAME" >}} maintainers. +{{< admonition type="note" >}} The resource usage depends on the workload, hardware, and the configuration used. The information on this page is a good starting point for most users, but your actual usage may be different. - -{{% /admonition %}} +{{< /admonition >}} ## Prometheus metrics @@ -48,8 +46,7 @@ scrape interval, you can expect to use approximately: These recommendations are based on deployments that use [clustering][], but they will broadly apply to other deployment modes. For more information on how to -deploy {{% param "PRODUCT_NAME" %}}, see -[deploying grafana agent][]. +deploy {{< param "PRODUCT_NAME" >}}, see [deploying grafana agent][]. [deploying grafana agent]: {{< relref "../get-started/deploy-agent.md" >}} [clustering]: {{< relref "../concepts/clustering.md" >}} @@ -67,7 +64,7 @@ to use approximately: These recommendations are based on Kubernetes DaemonSet deployments on clusters with relatively small number of nodes and high logs volume on each. The resource usage can be higher per each 1 MiB/second of logs if you have a large number of -small nodes due to the constant overhead of running the {{% param "PRODUCT_NAME" %}} on each node. +small nodes due to the constant overhead of running the {{< param "PRODUCT_NAME" >}} on each node. Additionally, factors such as number of labels, number of files and average log line length may all play a role in the resource usage. diff --git a/docs/sources/flow/tasks/migrate/from-prometheus.md b/docs/sources/flow/tasks/migrate/from-prometheus.md index 62fef82d3c2d..84241791ec24 100644 --- a/docs/sources/flow/tasks/migrate/from-prometheus.md +++ b/docs/sources/flow/tasks/migrate/from-prometheus.md @@ -71,10 +71,10 @@ This conversion will enable you to take full advantage of the many additional fe 1. If the `convert` command can't convert a Prometheus configuration, diagnostic information is sent to `stderr`.\ You can bypass any non-critical issues and output the {{< param "PRODUCT_NAME" >}} configuration using a best-effort conversion by including the `--bypass-errors` flag. - {{% admonition type="caution" %}} + {{< admonition type="caution" >}} If you bypass the errors, the behavior of the converted configuration may not match the original Prometheus configuration. Make sure you fully test the converted configuration before using it in a production environment. - {{% /admonition %}} + {{< /admonition >}} {{< code >}} @@ -143,10 +143,10 @@ Your configuration file must be a valid Prometheus configuration file rather tha 1. If your Prometheus configuration can't be converted and loaded directly into {{< param "PRODUCT_NAME" >}}, diagnostic information is sent to `stderr`. You can bypass any non-critical issues and start the Agent by including the `--config.bypass-conversion-errors` flag in addition to `--config.format=prometheus`. - {{% admonition type="caution" %}} + {{< admonition type="caution" >}} If you bypass the errors, the behavior of the converted configuration may not match the original Prometheus configuration. Do not use this flag in a production environment. - {{% /admonition %}} + {{< /admonition >}} ## Example diff --git a/docs/sources/flow/tasks/migrate/from-promtail.md b/docs/sources/flow/tasks/migrate/from-promtail.md index 2e7533bdafd0..7a0dda9b9248 100644 --- a/docs/sources/flow/tasks/migrate/from-promtail.md +++ b/docs/sources/flow/tasks/migrate/from-promtail.md @@ -71,10 +71,10 @@ This conversion will enable you to take full advantage of the many additional fe 1. If the convert command can't convert a Promtail configuration, diagnostic information is sent to `stderr`. You can bypass any non-critical issues and output the {{< param "PRODUCT_NAME" >}} configuration using a best-effort conversion by including the `--bypass-errors` flag. - {{% admonition type="caution" %}} + {{< admonition type="caution" >}} If you bypass the errors, the behavior of the converted configuration may not match the original Promtail configuration. Make sure you fully test the converted configuration before using it in a production environment. - {{% /admonition %}} + {{< /admonition >}} {{< code >}} @@ -139,10 +139,10 @@ Your configuration file must be a valid Promtail configuration file rather than 1. If your Promtail configuration can't be converted and loaded directly into {{< param "PRODUCT_ROOT_NAME" >}}, diagnostic information is sent to `stderr`. You can bypass any non-critical issues and start {{< param "PRODUCT_ROOT_NAME" >}} by including the `--config.bypass-conversion-errors` flag in addition to `--config.format=promtail`. - {{% admonition type="caution" %}} + {{< admonition type="caution" >}} If you bypass the errors, the behavior of the converted configuration may not match the original Promtail configuration. Do not use this flag in a production environment. - {{%/admonition %}} + {{< /admonition >}} ## Example diff --git a/docs/sources/flow/tasks/migrate/from-static.md b/docs/sources/flow/tasks/migrate/from-static.md index b6be6404aa40..5d1b73626f60 100644 --- a/docs/sources/flow/tasks/migrate/from-static.md +++ b/docs/sources/flow/tasks/migrate/from-static.md @@ -74,10 +74,10 @@ This conversion will enable you to take full advantage of the many additional fe 1. If the convert command can't convert a [Static][] configuration, diagnostic information is sent to `stderr`. You can use the `--bypass-errors` flag to bypass any non-critical issues and output the {{< param "PRODUCT_NAME" >}} configuration using a best-effort conversion. - {{% admonition type="caution" %}} + {{< admonition type="caution" >}} If you bypass the errors, the behavior of the converted configuration may not match the original Grafana Agent Static configuration. Make sure you fully test the converted configuration before using it in a production environment. - {{% /admonition %}} + {{< /admonition >}} {{< code >}} @@ -142,10 +142,10 @@ Your configuration file must be a valid [Static] configuration file. 1. If your [Static] configuration can't be converted and loaded directly into {{< param "PRODUCT_NAME" >}}, diagnostic information is sent to `stderr`. You can use the `--config.bypass-conversion-errors` flag with `--config.format=static` to bypass any non-critical issues and start {{< param "PRODUCT_NAME" >}}. - {{% admonition type="caution" %}} + {{< admonition type="caution" >}} If you bypass the errors, the behavior of the converted configuration may not match the original Grafana Agent Static configuration. Do not use this flag in a production environment. - {{%/admonition %}} + {{< /admonition >}} ## Example diff --git a/docs/sources/flow/tutorials/flow-by-example/first-components-and-stdlib/index.md b/docs/sources/flow/tutorials/flow-by-example/first-components-and-stdlib/index.md index 465caab75d03..59bc59c5d17b 100644 --- a/docs/sources/flow/tutorials/flow-by-example/first-components-and-stdlib/index.md +++ b/docs/sources/flow/tutorials/flow-by-example/first-components-and-stdlib/index.md @@ -50,17 +50,17 @@ This tutorial covers the basics of the River language and the standard library. } ``` - {{% admonition type="note" %}} + {{< admonition type="note" >}} The default log level is `info` and the default log format is `logfmt`. - {{% /admonition %}} + {{< /admonition >}} Try pasting this into `config.river` and running `/path/to/agent run config.river` to see what happens. Congratulations, you've just written your first River file! You've also just written your first {{< param "PRODUCT_NAME" >}} configuration file. This configuration won't do anything, so let's add some components to it. - {{% admonition type="note" %}} + {{< admonition type="note" >}} Comments in River are prefixed with `//` and are single-line only. For example: `// This is a comment`. - {{% /admonition %}} + {{< /admonition >}} ## Components @@ -96,11 +96,11 @@ prometheus.remote_write "local_prom" { } ``` -{{% admonition type="note" %}} +{{< admonition type="note" >}} [Component reference]: https://grafana.com/docs/agent//flow/reference/components/ A list of all available components can be found in the [Component reference][]. Each component has a link to its documentation, which contains a description of what the component does, its arguments, its exports, and examples. -{{% /admonition %}} +{{< /admonition >}} This pipeline has two components: `local.file` and `prometheus.remote_write`. The `local.file` component is configured with a single argument, `path`, which is set by calling the [env][] standard library function to retrieve the value of the `HOME` environment variable and concatenating it with the string `"file.txt"`. The `local.file` component has a single export, `content`, which contains the contents of the file. @@ -110,9 +110,9 @@ The `prometheus.remote_write` component is configured with an `endpoint` block, Flow of example pipeline with local.file and prometheus.remote_write components

-{{% admonition type="note" %}} +{{< admonition type="note" >}} The `local.file` component's label is set to `"example"`, so the fully qualified name of the component is `local.file.example`. The `prometheus.remote_write` component's label is set to `"local_prom"`, so the fully qualified name of the component is `prometheus.remote_write.local_prom`. -{{% /admonition %}} +{{< /admonition >}} This example pipeline still doesn't do anything, so let's add some more components to it. @@ -204,11 +204,11 @@ To give a visual hint, you want to create a pipeline that looks like this: Flow of exercise pipeline, with a scrape, unix_exporter, redis_exporter, and remote_write component

-{{% admonition type="note" %}} +{{< admonition type="note" >}} [concat]: https://grafana.com/docs/agent//flow/reference/stdlib/concat/ You may find the [concat][] standard library function useful. -{{% /admonition %}} +{{< /admonition >}} You can run {{< param "PRODUCT_NAME" >}} with the new configuration file by running: diff --git a/docs/sources/flow/tutorials/flow-by-example/logs-and-relabeling-basics/index.md b/docs/sources/flow/tutorials/flow-by-example/logs-and-relabeling-basics/index.md index 931b6182dee6..02c7c3c138f9 100644 --- a/docs/sources/flow/tutorials/flow-by-example/logs-and-relabeling-basics/index.md +++ b/docs/sources/flow/tutorials/flow-by-example/logs-and-relabeling-basics/index.md @@ -72,13 +72,13 @@ If you run {{< param "PRODUCT_ROOT_NAME" >}} and navigate to [localhost:3000/exp Relabeling uses the same rules as Prometheus. You can always refer to the [prometheus.relabel documentation](https://grafana.com/docs/agent//flow/reference/components/prometheus.relabel/#rule-block) for a full list of available options. -{{% admonition type="note" %}} +{{< admonition type="note" >}} You can forward multiple components to one `prometheus.relabel` component. This allows you to apply the same relabeling rules to multiple pipelines. -{{% /admonition %}} +{{< /admonition >}} -{{% admonition type="warning" %}} +{{< admonition type="warning" >}} There is an issue commonly faced when relabeling and using labels that start with `__` (double underscore). These labels are considered internal and are dropped before relabeling rules from a `prometheus.relabel` component are applied. If you would like to keep or act on these kinds of labels, use a [discovery.relabel](https://grafana.com/docs/agent//flow/reference/components/discovery.relabel/) component. -{{% /admonition %}} +{{< /admonition >}} ## Send logs to Loki @@ -170,9 +170,9 @@ loki.write "local_loki" { } ``` -{{% admonition type="note" %}} +{{< admonition type="note" >}} You can use the [loki.relabel](https://grafana.com/docs/agent//flow/reference/components/loki.relabel) component to relabel and add labels, just like you can with the [prometheus.relabel](https://grafana.com/docs/agent//flow/reference/components/prometheus.relabel) component. -{{% /admonition %}} +{{< /admonition >}} Once you have your completed configuration, run {{< param "PRODUCT_ROOT_NAME" >}} and execute the following: @@ -220,9 +220,9 @@ loki.write "local_loki" { ### Extract and add a Label from Logs -{{% admonition type="note" %}} +{{< admonition type="note" >}} This exercise is more challenging than the previous one. If you are having trouble, skip it and move to the next section, which will cover some of the concepts used here. You can always come back to this exercise later. -{{% /admonition %}} +{{< /admonition >}} This exercise will build on the previous one, though it's more involved. @@ -232,9 +232,9 @@ This component allows you to perform processing on logs, including extracting va Try modifying your configuration from the previous section to extract the `level` from the logs and add it as a label. If needed, you can find a solution to the previous exercise at the end of the [previous section](#add-a-label-to-logs). -{{% admonition type="note" %}} +{{< admonition type="note" >}} The `stage.logfmt` and `stage.labels` blocks for `loki.process` may be helpful. -{{% /admonition %}} +{{< /admonition >}} Once you have your completed config, run {{< param "PRODUCT_ROOT_NAME" >}} and execute the following: diff --git a/docs/sources/operator/_index.md b/docs/sources/operator/_index.md index 1c9aef3aca53..a39241c87a62 100644 --- a/docs/sources/operator/_index.md +++ b/docs/sources/operator/_index.md @@ -25,17 +25,17 @@ telemetry collection: * Prometheus Operator [Probe][] resources for collecting metrics from Kubernetes [Ingresses][]. * Custom [PodLogs][] resources for collecting logs. -{{% admonition type="note" %}} +{{< admonition type="note" >}} Grafana Agent Operator does not collect traces. -{{% /admonition %}} +{{< /admonition >}} Grafana Agent Operator is currently in [Beta][], and is subject to change or being removed with functionality which covers the same use case. -{{% admonition type="note" %}} +{{< admonition type="note" >}} If you are shipping your data to Grafana Cloud, use [Kubernetes Monitoring](/docs/grafana-cloud/kubernetes-monitoring/) to set up Agent Operator. Kubernetes Monitoring provides a simplified approach and preconfigured dashboards and alerts. -{{% /admonition %}} +{{< /admonition >}} Grafana Agent Operator uses additional custom resources to manage the deployment and configuration of Grafana Agents running in static mode. In addition to the diff --git a/docs/sources/operator/deploy-agent-operator-resources.md b/docs/sources/operator/deploy-agent-operator-resources.md index 47ea7baac373..6b6f6564c85a 100644 --- a/docs/sources/operator/deploy-agent-operator-resources.md +++ b/docs/sources/operator/deploy-agent-operator-resources.md @@ -34,9 +34,9 @@ The hierarchy of custom resources is as follows: To learn more about the custom resources Agent Operator provides and their hierarchy, see [Grafana Agent Operator architecture]({{< relref "./architecture" >}}). -{{% admonition type="note" %}} +{{< admonition type="note" >}} Agent Operator is currently in [beta]({{< relref "../stability.md#beta" >}}) and its custom resources are subject to change. -{{% /admonition %}} +{{< /admonition >}} ## Before you begin @@ -46,9 +46,9 @@ Before you begin, make sure that you have deployed the Grafana Agent Operator CR In this section, you'll roll out a `GrafanaAgent` resource. See [Grafana Agent Operator architecture]({{< relref "./architecture" >}}) for a discussion of the resources in the `GrafanaAgent` resource hierarchy. -{{% admonition type="note" %}} +{{< admonition type="note" >}} Due to the variety of possible deployment architectures, the official Agent Operator Helm chart does not provide built-in templates for the custom resources described in this guide. You must configure and deploy these manually as described in this section. We recommend templating and adding the following manifests to your own in-house Helm charts and GitOps flows. -{{% /admonition %}} +{{< /admonition >}} To deploy the `GrafanaAgent` resource: @@ -381,9 +381,9 @@ To deploy the `LogsInstance` resource into your cluster: 1. Copy the following `PodLogs` manifest to a file, then roll it to your cluster using `kubectl apply -f` followed by the filename. The manifest defines your logging targets. Agent Operator turns this into Agent configuration for the logs subsystem, and rolls it out to the DaemonSet of logging Agents. - {{% admonition type="note" %}} + {{< admonition type="note" >}} The following is a minimal working example which you should adapt to your production needs. - {{% /admonition %}} + {{< /admonition >}} ```yaml apiVersion: monitoring.grafana.com/v1alpha1 diff --git a/docs/sources/shared/flow/reference/components/rule-block-logs.md b/docs/sources/shared/flow/reference/components/rule-block-logs.md index 180bb7e18167..3db6449ed1b1 100644 --- a/docs/sources/shared/flow/reference/components/rule-block-logs.md +++ b/docs/sources/shared/flow/reference/components/rule-block-logs.md @@ -40,6 +40,6 @@ You can use the following actions: * `replace` - Matches `regex` to the concatenated labels. If there's a match, it replaces the content of the `target_label` using the contents of the `replacement` field. * `uppercase` - Sets `target_label` to the uppercase form of the concatenated `source_labels`. -{{% admonition type="note" %}} +{{< admonition type="note" >}} The regular expression capture groups can be referred to using either the `$CAPTURE_GROUP_NUMBER` or `${CAPTURE_GROUP_NUMBER}` notation. -{{% /admonition %}} +{{< /admonition >}} diff --git a/docs/sources/shared/flow/reference/components/rule-block.md b/docs/sources/shared/flow/reference/components/rule-block.md index 0b732954b18a..614b062b0ec6 100644 --- a/docs/sources/shared/flow/reference/components/rule-block.md +++ b/docs/sources/shared/flow/reference/components/rule-block.md @@ -40,6 +40,6 @@ You can use the following actions: * `replace` - Matches `regex` to the concatenated labels. If there's a match, it replaces the content of the `target_label` using the contents of the `replacement` field. * `uppercase` - Sets `target_label` to the uppercase form of the concatenated `source_labels`. -{{% admonition type="note" %}} +{{< admonition type="note" >}} The regular expression capture groups can be referred to using either the `$CAPTURE_GROUP_NUMBER` or `${CAPTURE_GROUP_NUMBER}` notation. -{{% /admonition %}} +{{< /admonition >}} diff --git a/docs/sources/shared/wal-data-retention.md b/docs/sources/shared/wal-data-retention.md index 973af3afb4d6..e7fa38871801 100644 --- a/docs/sources/shared/wal-data-retention.md +++ b/docs/sources/shared/wal-data-retention.md @@ -86,9 +86,9 @@ is unsuccessful, and you must manually delete the corrupted WAL to continue. If the WAL becomes corrupted, Grafana Agent writes error messages such as `err="failed to find segment for index"` to the log file. -{{% admonition type="note" %}} +{{< admonition type="note" >}} Deleting a WAL segment or a WAL file permanently deletes the stored WAL data. -{{% /admonition %}} +{{< /admonition >}} To delete the corrupted WAL: @@ -100,12 +100,12 @@ To delete the corrupted WAL: may be different than the default depending on the [wal_directory][] setting in your Static configuration file or the path specified by the Flow [command line flag][run] `--storage-path`. - {{% admonition type="note" %}} + {{< admonition type="note" >}} There is one `wal` directory per: * Metrics instance running in Static mode * `prometheus.remote_write` component running in Flow mode - {{% /admonition %}} + {{< /admonition >}} 1. [Start][Stop] Grafana Agent and verify that the WAL is working correctly. diff --git a/docs/sources/static/api/_index.md b/docs/sources/static/api/_index.md index 95995f5b6abb..ff3237d15a99 100644 --- a/docs/sources/static/api/_index.md +++ b/docs/sources/static/api/_index.md @@ -25,10 +25,10 @@ API endpoints are stable unless otherwise noted. Grafana Agent exposes a config management REST API for managing instance configurations when it is running in [scraping service mode][scrape]. -{{% admonition type="note" %}} +{{< admonition type="note" >}} The scraping service mode is a requirement for the config management API, however this is not a prerequisite for the Agent API or Ready/Healthy API. -{{% /admonition %}} +{{< /admonition >}} The following endpoints are exposed: @@ -127,13 +127,13 @@ defined in the Configuration Reference. The name field of the configuration is ignored and the name in the URL takes precedence. The request body must be formatted as YAML. -{{% admonition type="warning" %}} +{{< admonition type="warning" >}} By default, all instance configuration files that read credentials from a file on disk will be rejected. This prevents malicious users from reading the contents of arbitrary files as passwords and sending their contents to fake remote_write endpoints. To change the behavior, set `dangerous_allow_reading_files` to true in the `scraping_service` block. -{{% /admonition %}} +{{< /admonition >}} Status code: 201 with a new config, 200 on updated config. Response on success: @@ -174,9 +174,9 @@ Response on success: GET /agent/api/v1/metrics/instances ``` -{{% admonition type="note" %}} +{{< admonition type="note" >}} The deprecated alias is `/agent/api/v1/instances` -{{% /admonition %}} +{{< /admonition >}} Status code: 200 on success. Response on success: @@ -196,9 +196,9 @@ Response on success: GET /agent/api/v1/metrics/targets ``` -{{% admonition type="note" %}} +{{< admonition type="note" >}} The deprecated alias is `/agent/api/v1/targets` -{{% /admonition %}} +{{< /admonition >}} This endpoint collects all metrics subsystem targets known to the Agent across all running instances. Only targets being scraped from the local Agent will be returned. If diff --git a/docs/sources/static/configuration/_index.md b/docs/sources/static/configuration/_index.md index 92dc9a452bbd..fa1a195bd638 100644 --- a/docs/sources/static/configuration/_index.md +++ b/docs/sources/static/configuration/_index.md @@ -137,9 +137,9 @@ The following flags will configure basic auth for requests made to HTTP/S remote - `-config.url.basic-auth-user `: the basic auth username - `-config.url.basic-auth-password-file `: path to a file containing the basic auth password -{{% admonition type="note" %}} +{{< admonition type="note" >}} This beta feature is subject to change in future releases. -{{% /admonition %}} +{{< /admonition >}} {{% docs/reference %}} [flags]: "/docs/agent/ -> /docs/agent//static/configuration/flags" diff --git a/docs/sources/static/configuration/integrations/snmp-config.md b/docs/sources/static/configuration/integrations/snmp-config.md index 893348006f92..c9c4f910f908 100644 --- a/docs/sources/static/configuration/integrations/snmp-config.md +++ b/docs/sources/static/configuration/integrations/snmp-config.md @@ -14,9 +14,9 @@ The `snmp` block configures the `snmp` integration, which is an embedded version of [`snmp_exporter`](https://github.com/prometheus/snmp_exporter). This allows collection of SNMP metrics from the network devices with ease. -{{% admonition type="note" %}} +{{< admonition type="note" >}} `snmp config` uses the latest configuration introduced in version 0.23 of the Prometheus `snmp_exporter`. -{{% /admonition %}} +{{< /admonition >}} ## Quick configuration example diff --git a/docs/sources/static/configuration/traces-config.md b/docs/sources/static/configuration/traces-config.md index 8ede4e9eb94e..4ff3bfc85e2a 100644 --- a/docs/sources/static/configuration/traces-config.md +++ b/docs/sources/static/configuration/traces-config.md @@ -17,11 +17,11 @@ configures its own tracing pipeline. Having multiple configs allows you to configure multiple distinct pipelines, each of which collects spans and sends them to a different location. -{{% admonition type="note" %}} +{{< admonition type="note" >}} If you are using multiple configs, you must manually set port numbers for each receiver, otherwise they will all try to use the same port and fail to start. -{{% /admonition %}} +{{< /admonition >}} ```yaml configs: diff --git a/docs/sources/static/release-notes.md b/docs/sources/static/release-notes.md index ad01a1fb4404..90afd41dfc42 100644 --- a/docs/sources/static/release-notes.md +++ b/docs/sources/static/release-notes.md @@ -46,9 +46,9 @@ that supports OTLP. ### Breaking change: The default value of `retry_on_http_429` is overriden to `true` for the `queue_config` in `remote_write` in `metrics` config. -{{% admonition type="note" %}} +{{< admonition type="note" >}} The default set by Grafana Agent Static Mode is different than the default set by Prometheus. -{{% /admonition %}} +{{< /admonition >}} The Prometheus default value for `retry_on_http_429` is set to `true` for the `queue_config` in `remote_write`. This changed default setting allows the agent to retry sending data when it receives an HTTP 429 error and helps avoid losing data in metric pipelines. diff --git a/docs/sources/static/set-up/install/_index.md b/docs/sources/static/set-up/install/_index.md index bafe6e563041..3e62fdbdf80d 100644 --- a/docs/sources/static/set-up/install/_index.md +++ b/docs/sources/static/set-up/install/_index.md @@ -22,15 +22,15 @@ The following architectures are supported: - macOS: AMD64 (Intel), ARM64 (Apple Silicon) - FreeBSD: AMD64 -{{% admonition type="note" %}} +{{< admonition type="note" >}} ppc64le builds are considered secondary release targets and do not have the same level of support and testing as other platforms. -{{% /admonition %}} +{{< /admonition >}} {{< section >}} -{{% admonition type="note" %}} +{{< admonition type="note" >}} Installing Grafana Agent on other operating systems is possible, but is not recommended or supported. -{{% /admonition %}} +{{< /admonition >}} ## Grafana Cloud diff --git a/docs/sources/static/set-up/install/install-agent-binary.md b/docs/sources/static/set-up/install/install-agent-binary.md index 82e14c59119a..8d53d8376821 100644 --- a/docs/sources/static/set-up/install/install-agent-binary.md +++ b/docs/sources/static/set-up/install/install-agent-binary.md @@ -19,9 +19,9 @@ Grafana Agent is distributed as a standalone binary for the following operating * macOS: AMD64, (Intel), ARM64 (Apple Silicon) * Windows: AMD64 -{{% admonition type="note" %}} +{{< admonition type="note" >}} ppc64le builds are considered secondary release targets and do not have the same level of support and testing as other platforms. -{{% /admonition %}} +{{< /admonition >}} The binary executable will run Grafana Agent in standalone mode. If you want to run Grafana Agent as a service, refer to the installation instructions for: diff --git a/docs/sources/static/set-up/install/install-agent-docker.md b/docs/sources/static/set-up/install/install-agent-docker.md index ad563251c2ae..bece55596635 100644 --- a/docs/sources/static/set-up/install/install-agent-docker.md +++ b/docs/sources/static/set-up/install/install-agent-docker.md @@ -41,9 +41,9 @@ docker run \ Replace `CONFIG_FILE_PATH` with the configuration file path on your Linux host system. -{{% admonition type="note" %}} +{{< admonition type="note" >}} For the flags to work correctly, you must expose the paths on your Linux host to the Docker container through a bind mount. -{{%/admonition %}} +{{< /admonition >}} ## Run a Windows Docker container @@ -61,9 +61,9 @@ Replace the following: * `CONFIG_FILE_PATH`: The configuration file path on your Windows host system. * `WAL_DATA_DIRECTORY`: the directory used to store your metrics before sending them to Prometheus. Old WAL data is cleaned up every hour and is used for recovery if the process crashes. -{{% admonition type="note" %}} +{{< admonition type="note" >}} For the flags to work correctly, you must expose the paths on your Windows host to the Docker container through a bind mount. -{{%/admonition %}} +{{< /admonition >}} ## Next steps diff --git a/docs/sources/static/set-up/install/install-agent-kubernetes.md b/docs/sources/static/set-up/install/install-agent-kubernetes.md index 95fdd5597b53..d55a7d9af2a5 100644 --- a/docs/sources/static/set-up/install/install-agent-kubernetes.md +++ b/docs/sources/static/set-up/install/install-agent-kubernetes.md @@ -23,10 +23,10 @@ You can use the Helm chart for Grafana Agent to deploy Grafana Agent in static m ## Deploy -{{% admonition type="note" %}} +{{< admonition type="note" >}} These instructions show you how to install the generic [Helm chart](https://github.com/grafana/agent/tree/main/operations/helm/charts/grafana-agent) for Grafana Agent. You can deploy Grafana Agent in static mode or flow mode. The Helm chart deploys flow mode by default. -{{% /admonition %}} +{{< /admonition >}} To deploy Grafana Agent in static mode on Kubernetes using Helm, run the following commands in a terminal window: @@ -52,10 +52,10 @@ To deploy Grafana Agent in static mode on Kubernetes using Helm, run the followi - _``_: The name to use for your Grafana Agent installation, such as `grafana-agent`. - {{% admonition type="warning" %}} + {{< admonition type="warning" >}} Always pass `--set agent.mode=static` in `helm install` or `helm upgrade` commands to ensure Grafana Agent gets installed in static mode. Alternatively, set `agent.mode` to `static` in your values.yaml file. - {{% /admonition %}} + {{< /admonition >}} For more information on the Grafana Agent Helm chart, refer to the Helm chart documentation on [Artifact Hub][]. diff --git a/docs/sources/static/set-up/install/install-agent-macos.md b/docs/sources/static/set-up/install/install-agent-macos.md index 48f383ee6b7d..c23bd59ec52b 100644 --- a/docs/sources/static/set-up/install/install-agent-macos.md +++ b/docs/sources/static/set-up/install/install-agent-macos.md @@ -19,9 +19,9 @@ You can install Grafana Agent in static mode on macOS with Homebrew. Install [Homebrew][] on your computer. -{{% admonition type="note" %}} +{{< admonition type="note" >}} The default prefix for Homebrew on Intel is `/usr/local`. The default prefix for Homebrew on Apple Silicon is `/opt/Homebrew`. To verify the default prefix for Homebrew on your computer, open a terminal window and type `brew --prefix`. -{{% /admonition %}} +{{< /admonition >}} [Homebrew]: https://brew.sh @@ -76,9 +76,9 @@ brew uninstall grafana-agent 1. Edit `$(brew --prefix)/etc/grafana-agent/config.yml` and add the configuration blocks for your specific telemetry needs. Refer to [Configure Grafana Agent][configure] for more information. -{{% admonition type="note" %}} +{{< admonition type="note" >}} To send your data to Grafana Cloud, set up Grafana Agent using the Grafana Cloud integration. Refer to [how to install an integration](/docs/grafana-cloud/data-configuration/integrations/install-and-manage-integrations/) and [macOS integration](/docs/grafana-cloud/data-configuration/integrations/integration-reference/integration-macos-node/). -{{%/admonition %}} +{{< /admonition >}} ## Next steps