docs: correct component stability in documentation (#130)

* docs: correct component stability in documentation Also changes documentation pages to be consistent where the `stage` label is no longer used in favor of an HTML element for the current stability. The list of components by stability is as follows: ``` beyla.ebpf public-preview discovery.azure generally-available discovery.consul generally-available discovery.consulagent generally-available discovery.digitalocean generally-available discovery.dns generally-available discovery.docker generally-available discovery.dockerswarm generally-available discovery.ec2 generally-available discovery.eureka generally-available discovery.file generally-available discovery.gce generally-available discovery.hetzner generally-available discovery.http generally-available discovery.ionos generally-available discovery.kubelet generally-available discovery.kubernetes generally-available discovery.kuma generally-available discovery.lightsail generally-available discovery.linode generally-available discovery.marathon generally-available discovery.nerve generally-available discovery.nomad generally-available discovery.openstack generally-available discovery.ovhcloud generally-available discovery.process public-preview discovery.puppetdb generally-available discovery.relabel generally-available discovery.scaleway generally-available discovery.serverset generally-available discovery.triton generally-available discovery.uyuni generally-available faro.receiver generally-available local.file generally-available local.file_match generally-available loki.echo generally-available loki.process generally-available loki.relabel generally-available loki.rules.kubernetes generally-available loki.source.api generally-available loki.source.awsfirehose generally-available loki.source.azure_event_hubs generally-available loki.source.cloudflare generally-available loki.source.docker generally-available loki.source.file generally-available loki.source.gcplog generally-available loki.source.gelf generally-available loki.source.heroku generally-available loki.source.journal generally-available loki.source.kafka generally-available loki.source.kubernetes generally-available loki.source.kubernetes_events generally-available loki.source.podlogs generally-available loki.source.syslog generally-available loki.source.windowsevent generally-available loki.write generally-available mimir.rules.kubernetes generally-available otelcol.auth.basic generally-available otelcol.auth.bearer generally-available otelcol.auth.headers generally-available otelcol.auth.oauth2 generally-available otelcol.auth.sigv4 generally-available otelcol.connector.host_info generally-available otelcol.connector.servicegraph generally-available otelcol.connector.spanlogs generally-available otelcol.connector.spanmetrics generally-available otelcol.exporter.loadbalancing generally-available otelcol.exporter.logging generally-available otelcol.exporter.loki generally-available otelcol.exporter.otlp generally-available otelcol.exporter.otlphttp generally-available otelcol.exporter.prometheus generally-available otelcol.extension.jaeger_remote_samplinggenerally-available otelcol.processor.attributes generally-available otelcol.processor.batch generally-available otelcol.processor.discovery generally-available otelcol.processor.filter generally-available otelcol.processor.k8sattributes generally-available otelcol.processor.memory_limiter generally-available otelcol.processor.probabilistic_sampler generally-available otelcol.processor.resourcedetection generally-available otelcol.processor.span generally-available otelcol.processor.tail_sampling generally-available otelcol.processor.transform generally-available otelcol.receiver.jaeger generally-available otelcol.receiver.kafka generally-available otelcol.receiver.loki generally-available otelcol.receiver.opencensus generally-available otelcol.receiver.otlp generally-available otelcol.receiver.prometheus generally-available otelcol.receiver.vcenter experimental otelcol.receiver.zipkin generally-available prometheus.exporter.apache generally-available prometheus.exporter.azure generally-available prometheus.exporter.blackbox generally-available prometheus.exporter.cadvisor generally-available prometheus.exporter.cloudwatch generally-available prometheus.exporter.consul generally-available prometheus.exporter.dnsmasq generally-available prometheus.exporter.elasticsearch generally-available prometheus.exporter.gcp generally-available prometheus.exporter.github generally-available prometheus.exporter.kafka generally-available prometheus.exporter.memcached generally-available prometheus.exporter.mongodb generally-available prometheus.exporter.mssql generally-available prometheus.exporter.mysql generally-available prometheus.exporter.oracledb generally-available prometheus.exporter.postgres generally-available prometheus.exporter.process generally-available prometheus.exporter.redis generally-available prometheus.exporter.self generally-available prometheus.exporter.snmp generally-available prometheus.exporter.snowflake generally-available prometheus.exporter.squid generally-available prometheus.exporter.statsd generally-available prometheus.exporter.unix generally-available prometheus.exporter.windows generally-available prometheus.operator.podmonitors generally-available prometheus.operator.probes generally-available prometheus.operator.servicemonitors generally-available prometheus.receive_http generally-available prometheus.relabel generally-available prometheus.remote_write generally-available prometheus.scrape generally-available pyroscope.ebpf public-preview pyroscope.java public-preview pyroscope.scrape public-preview pyroscope.write public-preview remote.http generally-available remote.kubernetes.configmap generally-available remote.kubernetes.secret generally-available remote.s3 generally-available remote.vault generally-available ``` * update remotecfg too * listcomponents: fix output The longest component name was missing a separator between itself and the stability.
grafana · Apr 5, 2024 · 6136c83 · 6136c83
1 parent 8a9a157
commit 6136c83
Show file tree

Hide file tree

Showing 27 changed files with 24 additions and 98 deletions.
diff --git a/docs/sources/reference/components/discovery.kubelet.md b/docs/sources/reference/components/discovery.kubelet.md
@@ -4,12 +4,8 @@ description: Learn about discovery.kubelet
 title: discovery.kubelet
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # discovery.kubelet
 
-{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `discovery.kubelet` discovers Kubernetes pods running on the specified Kubelet and exposes them as scrape targets.
 
 ## Usage

diff --git a/docs/sources/reference/components/loki.echo.md b/docs/sources/reference/components/loki.echo.md
@@ -4,12 +4,8 @@ description: Learn about loki.echo
 title: loki.echo
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # loki.echo
 
-{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `loki.echo` receives log entries from other `loki` components and prints them to the process' standard output (stdout).
 
 Multiple `loki.echo` components can be specified by giving them different labels.

diff --git a/docs/sources/reference/components/loki.rules.kubernetes.md b/docs/sources/reference/components/loki.rules.kubernetes.md
@@ -1,14 +1,10 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/loki.rules.kubernetes/
 title: loki.rules.kubernetes
-labels:
-  stage: experimental
 ---
 
 # loki.rules.kubernetes
 
-{{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `loki.rules.kubernetes` discovers `PrometheusRule` Kubernetes resources and
 loads them into a Loki instance.
 

diff --git a/docs/sources/reference/components/loki.source.kubernetes.md b/docs/sources/reference/components/loki.source.kubernetes.md
@@ -1,15 +1,11 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/loki.source.kubernetes/
 description: Learn about loki.source.kubernetes
-labels:
-  stage: experimental
 title: loki.source.kubernetes
 ---
 
 # loki.source.kubernetes
 
-{{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `loki.source.kubernetes` tails logs from Kubernetes containers using the
 Kubernetes API. It has the following benefits over `loki.source.file`:
 

diff --git a/docs/sources/reference/components/loki.source.podlogs.md b/docs/sources/reference/components/loki.source.podlogs.md
@@ -1,15 +1,11 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/loki.source.podlogs/
 description: Learn about loki.source.podlogs
-labels:
-  stage: experimental
 title: loki.source.podlogs
 ---
 
 # loki.source.podlogs
 
-{{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `loki.source.podlogs` discovers `PodLogs` resources on Kubernetes and, using
 the Kubernetes API, tails logs from Kubernetes containers of Pods specified by
 the discovered them.

diff --git a/docs/sources/reference/components/mimir.rules.kubernetes.md b/docs/sources/reference/components/mimir.rules.kubernetes.md
@@ -4,12 +4,8 @@ description: Learn about mimir.rules.kubernetes
 title: mimir.rules.kubernetes
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # mimir.rules.kubernetes
 
-{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `mimir.rules.kubernetes` discovers `PrometheusRule` Kubernetes resources and
 loads them into a Mimir instance.
 

diff --git a/docs/sources/reference/components/otelcol.connector.host_info.md b/docs/sources/reference/components/otelcol.connector.host_info.md
@@ -1,8 +1,6 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.connector.host_info/
 description: Learn about otelcol.connector.host_info
-labels:
-  stage: stable
 title: otelcol.connector.host_info
 ---
 

diff --git a/docs/sources/reference/components/otelcol.connector.servicegraph.md b/docs/sources/reference/components/otelcol.connector.servicegraph.md
@@ -1,8 +1,6 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.connector.servicegraph/
 description: Learn about otelcol.connector.servicegraph
-labels:
-  stage: stable
 title: otelcol.connector.servicegraph
 ---
 

diff --git a/docs/sources/reference/components/otelcol.connector.spanmetrics.md b/docs/sources/reference/components/otelcol.connector.spanmetrics.md
@@ -1,8 +1,6 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.connector.spanmetrics/
 description: Learn about otelcol.connector.spanmetrics
-labels:
-  stage: stable
 title: otelcol.connector.spanmetrics
 ---
 

diff --git a/docs/sources/reference/components/otelcol.exporter.loadbalancing.md b/docs/sources/reference/components/otelcol.exporter.loadbalancing.md
@@ -4,12 +4,8 @@ description: Learn about otelcol.exporter.loadbalancing
 title: otelcol.exporter.loadbalancing
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # otelcol.exporter.loadbalancing
 
-{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 <!-- Include a picture of the LB architecture? -->
 
 `otelcol.exporter.loadbalancing` accepts logs and traces from other `otelcol` components

diff --git a/docs/sources/reference/components/otelcol.extension.jaeger_remote_sampling.md b/docs/sources/reference/components/otelcol.extension.jaeger_remote_sampling.md
@@ -1,15 +1,11 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.extension.jaeger_remote_sampling/
 description: Learn about otelcol.extension.jaeger_remote_sampling
-label:
-  stage: experimental
 title: otelcol.extension.jaeger_remote_sampling
 ---
 
 # otelcol.extension.jaeger_remote_sampling
 
-{{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `otelcol.extension.jaeger_remote_sampling` serves a specified Jaeger remote sampling document.
 
 {{< admonition type="note" >}}

diff --git a/docs/sources/reference/components/otelcol.processor.filter.md b/docs/sources/reference/components/otelcol.processor.filter.md
@@ -1,8 +1,6 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.filter/
 description: Learn about otelcol.processor.filter
-labels:
-  stage: stable
 title: otelcol.processor.filter
 ---
 

diff --git a/docs/sources/reference/components/otelcol.processor.probabilistic_sampler.md b/docs/sources/reference/components/otelcol.processor.probabilistic_sampler.md
@@ -1,15 +1,11 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.probabilistic_sampler/
 description: Learn about telcol.processor.probabilistic_sampler
-labels:
-  stage: experimental
 title: otelcol.processor.probabilistic_sampler
 ---
 
 # otelcol.processor.probabilistic_sampler
 
-{{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `otelcol.processor.probabilistic_sampler` accepts logs and traces data from other otelcol components and applies probabilistic sampling based on configuration options.
 
 {{< admonition type="note" >}}
@@ -156,4 +152,4 @@ Connecting some components may not be sensible or components may require further
 Refer to the linked documentation for more details.
 {{< /admonition >}}
 
-<!-- END GENERATED COMPATIBLE COMPONENTS -->
+<!-- END GENERATED COMPATIBLE COMPONENTS -->
diff --git a/docs/sources/reference/components/otelcol.processor.resourcedetection.md b/docs/sources/reference/components/otelcol.processor.resourcedetection.md
@@ -4,12 +4,8 @@ title: otelcol.processor.resourcedetection
 description: Learn about otelcol.processor.resourcedetection
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # otelcol.processor.resourcedetection
 
-{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `otelcol.processor.resourcedetection` detects resource information from the host in a format that conforms to the [OpenTelemetry resource semantic conventions][], and appends or overrides the resource values in the telemetry data with this information.
 
 [OpenTelemetry resource semantic conventions]: https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions/

diff --git a/docs/sources/reference/components/otelcol.processor.span.md b/docs/sources/reference/components/otelcol.processor.span.md
@@ -1,15 +1,11 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.span/
 description: Learn about otelcol.processor.span
-labels:
-  stage: experimental
 title: otelcol.processor.span
 ---
 
 # otelcol.processor.span
 
-{{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `otelcol.processor.span` accepts traces telemetry data from other `otelcol` components and modifies the names and attributes of the spans.
 It also supports the ability to filter input data to determine if it should be included or excluded from this processor.
 

diff --git a/docs/sources/reference/components/otelcol.processor.tail_sampling.md b/docs/sources/reference/components/otelcol.processor.tail_sampling.md
@@ -4,12 +4,8 @@ description: Learn about otelcol.processor.tail_sampling
 title: otelcol.processor.tail_sampling
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # otelcol.processor.tail_sampling
 
-{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `otelcol.processor.tail_sampling` samples traces based on a set of defined
 policies. All spans for a given trace *must* be received by the same collector
 instance for effective sampling decisions.

diff --git a/docs/sources/reference/components/otelcol.processor.transform.md b/docs/sources/reference/components/otelcol.processor.transform.md
@@ -1,8 +1,6 @@
 ---
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.transform/
 description: Learn about otelcol.processor.transform
-labels:
-  stage: stable
 title: otelcol.processor.transform
 ---
 

diff --git a/docs/sources/reference/components/otelcol.receiver.loki.md b/docs/sources/reference/components/otelcol.receiver.loki.md
@@ -4,12 +4,8 @@ description: Learn about otelcol.receiver.loki
 title: otelcol.receiver.loki
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # otelcol.receiver.loki
 
-{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `otelcol.receiver.loki` receives Loki log entries, converts them to the
 OpenTelemetry logs format, and forwards them to other `otelcol.*` components.
 

diff --git a/docs/sources/reference/components/otelcol.receiver.prometheus.md b/docs/sources/reference/components/otelcol.receiver.prometheus.md
@@ -4,8 +4,6 @@ description: Learn about otelcol.receiver.prometheus
 title: otelcol.receiver.prometheus
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # otelcol.receiver.prometheus
 
 {{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
@@ -111,4 +109,4 @@ Connecting some components may not be sensible or components may require further
 Refer to the linked documentation for more details.
 {{< /admonition >}}
 
-<!-- END GENERATED COMPATIBLE COMPONENTS -->
+<!-- END GENERATED COMPATIBLE COMPONENTS -->
diff --git a/docs/sources/reference/components/otelcol.receiver.vcenter.md b/docs/sources/reference/components/otelcol.receiver.vcenter.md
@@ -2,15 +2,15 @@
 canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.receiver.vcenter/
 title: otelcol.receiver.vcenter
 description: Learn about otelcol.receiver.vcenter
-labels:
-  stage: experimental
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Experimental</span>
+
 # otelcol.receiver.vcenter
 
 {{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
-`otelcol.receiver.vcenter` accepts metrics from a 
+`otelcol.receiver.vcenter` accepts metrics from a
 vCenter or ESXi host running VMware vSphere APIs and
 forwards it to other `otelcol.*` components.
 
@@ -231,4 +231,4 @@ Connecting some components may not be sensible or components may require further
 Refer to the linked documentation for more details.
 {{< /admonition >}}
 
-<!-- END GENERATED COMPATIBLE COMPONENTS -->
+<!-- END GENERATED COMPATIBLE COMPONENTS -->
diff --git a/docs/sources/reference/components/prometheus.exporter.postgres.md b/docs/sources/reference/components/prometheus.exporter.postgres.md
@@ -4,8 +4,6 @@ description: Learn about prometheus.exporter.postgres
 title: prometheus.exporter.postgres
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # prometheus.exporter.postgres
 
 The `prometheus.exporter.postgres` component embeds

diff --git a/docs/sources/reference/components/prometheus.operator.podmonitors.md b/docs/sources/reference/components/prometheus.operator.podmonitors.md
@@ -4,12 +4,8 @@ description: Learn about prometheus.operator.podmonitors
 title: prometheus.operator.podmonitors
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # prometheus.operator.podmonitors
 
-{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `prometheus.operator.podmonitors` discovers [PodMonitor](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.PodMonitor) resources in your kubernetes cluster and scrapes the targets they reference. This component performs three main functions:
 
 1. Discover PodMonitor resources from your Kubernetes cluster.
@@ -271,4 +267,4 @@ Connecting some components may not be sensible or components may require further
 Refer to the linked documentation for more details.
 {{< /admonition >}}
 
-<!-- END GENERATED COMPATIBLE COMPONENTS -->
+<!-- END GENERATED COMPATIBLE COMPONENTS -->
diff --git a/docs/sources/reference/components/prometheus.operator.probes.md b/docs/sources/reference/components/prometheus.operator.probes.md
@@ -4,12 +4,8 @@ description: Learn about prometheus.operator.probes
 title: prometheus.operator.probes
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # prometheus.operator.probes
 
-{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `prometheus.operator.probes` discovers [Probe](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.Probe) resources in your Kubernetes cluster and scrapes the targets they reference.
  This component performs three main functions:
 

diff --git a/docs/sources/reference/components/prometheus.operator.servicemonitors.md b/docs/sources/reference/components/prometheus.operator.servicemonitors.md
@@ -4,12 +4,8 @@ description: Learn about prometheus.operator.servicemonitors
 title: prometheus.operator.servicemonitors
 ---
 
-<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
-
 # prometheus.operator.servicemonitors
 
-{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
-
 `prometheus.operator.servicemonitors` discovers [ServiceMonitor](https://prometheus-operator.dev/docs/operator/api/#monitoring.coreos.com/v1.ServiceMonitor) resources in your kubernetes cluster and scrapes the targets they reference. This component performs three main functions:
 
 1. Discover ServiceMonitor resources from your Kubernetes cluster.
@@ -273,4 +269,4 @@ Connecting some components may not be sensible or components may require further
 Refer to the linked documentation for more details.
 {{< /admonition >}}
 
-<!-- END GENERATED COMPATIBLE COMPONENTS -->
+<!-- END GENERATED COMPATIBLE COMPONENTS -->
diff --git a/docs/sources/reference/components/pyroscope.java.md b/docs/sources/reference/components/pyroscope.java.md
@@ -4,6 +4,8 @@ description: Learn about pyroscope.java
 title: pyroscope.java
 ---
 
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
 # pyroscope.java
 
 {{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
@@ -171,4 +173,4 @@ Connecting some components may not be sensible or components may require further
 Refer to the linked documentation for more details.
 {{< /admonition >}}
 
-<!-- END GENERATED COMPATIBLE COMPONENTS -->
+<!-- END GENERATED COMPATIBLE COMPONENTS -->
diff --git a/docs/sources/reference/config-blocks/remotecfg.md b/docs/sources/reference/config-blocks/remotecfg.md
@@ -5,7 +5,9 @@ menuTitle: remotecfg
 title: remotecfg block
 ---
 
-# remotecfg block (public preview)
+<span class="badge docs-labels__stage docs-labels__item">Public preview</span>
+
+# remotecfg block
 
 {{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
 
@@ -18,15 +20,15 @@ The [API definition][] for managing and fetching configuration that the `remotec
 
 ```alloy
 remotecfg {
-	url = "SERVICE_URL"
-	basic_auth {
-		username      = "USERNAME"
-		password_file = "PASSWORD_FILE"
-	}
-
-	id             = constants.hostname
-	metadata       = {"cluster" = "dev", "namespace" = "otlp-dev"}
-	poll_frequency = "5m"
+    url = "SERVICE_URL"
+    basic_auth {
+        username      = "USERNAME"
+        password_file = "PASSWORD_FILE"
+    }
+
+    id             = constants.hostname
+    metadata       = {"cluster" = "dev", "namespace" = "otlp-dev"}
+    poll_frequency = "5m"
 }
 ```