From ac9f4fd21dbf6860733b6113ce0bae371958e626 Mon Sep 17 00:00:00 2001 From: Clayton Cornell Date: Wed, 27 Mar 2024 12:29:22 -0700 Subject: [PATCH] Remove beta label and add public preview badge --- docs/sources/reference/cli/convert.md | 4 ++-- docs/sources/reference/components/discovery.kubelet.md | 4 ++-- docs/sources/reference/components/discovery.process.md | 6 +++--- docs/sources/reference/components/loki.echo.md | 6 +++--- .../sources/reference/components/mimir.rules.kubernetes.md | 6 +++--- .../reference/components/otelcol.exporter.loadbalancing.md | 6 +++--- .../components/otelcol.processor.resourcedetection.md | 6 +++--- .../components/otelcol.processor.tail_sampling.md | 6 +++--- docs/sources/reference/components/otelcol.receiver.loki.md | 6 +++--- .../reference/components/otelcol.receiver.prometheus.md | 6 +++--- .../reference/components/prometheus.exporter.postgres.md | 4 ++-- .../components/prometheus.operator.podmonitors.md | 6 +++--- .../reference/components/prometheus.operator.probes.md | 7 ++++--- .../components/prometheus.operator.servicemonitors.md | 6 +++--- docs/sources/reference/components/pyroscope.ebpf.md | 6 +++--- docs/sources/reference/components/pyroscope.java.md | 2 +- docs/sources/reference/components/pyroscope.scrape.md | 6 +++--- docs/sources/reference/components/pyroscope.write.md | 6 +++--- docs/sources/reference/config-blocks/import.file.md | 6 +++--- 19 files changed, 53 insertions(+), 52 deletions(-) diff --git a/docs/sources/reference/cli/convert.md b/docs/sources/reference/cli/convert.md index 893df15820..40693c9427 100644 --- a/docs/sources/reference/cli/convert.md +++ b/docs/sources/reference/cli/convert.md @@ -3,13 +3,13 @@ aliases: - ./reference/cli/convert/ canonical: https://grafana.com/docs/alloy/latest/reference/cli/convert/ description: Learn about the convert command -labels: - stage: beta menuTitle: convert title: The convert command weight: 100 --- +Public preview + # The convert command The `convert` command converts a supported configuration format to the {{< param "PRODUCT_NAME" >}} configuration format. diff --git a/docs/sources/reference/components/discovery.kubelet.md b/docs/sources/reference/components/discovery.kubelet.md index 0ed182e6d7..b1ccb6eca7 100644 --- a/docs/sources/reference/components/discovery.kubelet.md +++ b/docs/sources/reference/components/discovery.kubelet.md @@ -1,11 +1,11 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.kubelet/ description: Learn about discovery.kubelet -labels: - stage: beta title: discovery.kubelet --- +Public preview + # discovery.kubelet `discovery.kubelet` discovers Kubernetes pods running on the specified Kubelet and exposes them as scrape targets. diff --git a/docs/sources/reference/components/discovery.process.md b/docs/sources/reference/components/discovery.process.md index 7a26243dd6..895cdada65 100644 --- a/docs/sources/reference/components/discovery.process.md +++ b/docs/sources/reference/components/discovery.process.md @@ -2,13 +2,13 @@ canonical: https://grafana.com/docs/alloy/latest/reference/components/discovery.process/ description: Learn about discovery.process title: discovery.process -labels: - stage: beta --- +Public preview + # discovery.process -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} `discovery.process` discovers processes running on the local Linux OS. diff --git a/docs/sources/reference/components/loki.echo.md b/docs/sources/reference/components/loki.echo.md index f238ba01bd..3cd8c26b86 100644 --- a/docs/sources/reference/components/loki.echo.md +++ b/docs/sources/reference/components/loki.echo.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/loki.echo/ description: Learn about loki.echo -labels: - stage: beta title: loki.echo --- +Public preview + # loki.echo -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} `loki.echo` receives log entries from other `loki` components and prints them to the process' standard output (stdout). diff --git a/docs/sources/reference/components/mimir.rules.kubernetes.md b/docs/sources/reference/components/mimir.rules.kubernetes.md index b61dd33f62..5a8c10c418 100644 --- a/docs/sources/reference/components/mimir.rules.kubernetes.md +++ b/docs/sources/reference/components/mimir.rules.kubernetes.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/mimir.rules.kubernetes/ description: Learn about mimir.rules.kubernetes -labels: - stage: beta title: mimir.rules.kubernetes --- +Public preview + # mimir.rules.kubernetes -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} `mimir.rules.kubernetes` discovers `PrometheusRule` Kubernetes resources and loads them into a Mimir instance. diff --git a/docs/sources/reference/components/otelcol.exporter.loadbalancing.md b/docs/sources/reference/components/otelcol.exporter.loadbalancing.md index 6c07015236..f69a1e863c 100644 --- a/docs/sources/reference/components/otelcol.exporter.loadbalancing.md +++ b/docs/sources/reference/components/otelcol.exporter.loadbalancing.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.exporter.loadbalancing/ description: Learn about otelcol.exporter.loadbalancing -labels: - stage: beta title: otelcol.exporter.loadbalancing --- +Public preview + # otelcol.exporter.loadbalancing -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} diff --git a/docs/sources/reference/components/otelcol.processor.resourcedetection.md b/docs/sources/reference/components/otelcol.processor.resourcedetection.md index 5f8d6705fd..305bf07726 100644 --- a/docs/sources/reference/components/otelcol.processor.resourcedetection.md +++ b/docs/sources/reference/components/otelcol.processor.resourcedetection.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.resourcedetection/ -labels: - stage: beta title: otelcol.processor.resourcedetection description: Learn about otelcol.processor.resourcedetection --- +Public preview + # otelcol.processor.resourcedetection -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="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. diff --git a/docs/sources/reference/components/otelcol.processor.tail_sampling.md b/docs/sources/reference/components/otelcol.processor.tail_sampling.md index b0872b2738..6c300158ca 100644 --- a/docs/sources/reference/components/otelcol.processor.tail_sampling.md +++ b/docs/sources/reference/components/otelcol.processor.tail_sampling.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.tail_sampling/ description: Learn about otelcol.processor.tail_sampling -labels: - stage: beta title: otelcol.processor.tail_sampling --- +Public preview + # otelcol.processor.tail_sampling -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="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 diff --git a/docs/sources/reference/components/otelcol.receiver.loki.md b/docs/sources/reference/components/otelcol.receiver.loki.md index 30d7a53d7e..06beab8a4b 100644 --- a/docs/sources/reference/components/otelcol.receiver.loki.md +++ b/docs/sources/reference/components/otelcol.receiver.loki.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.receiver.loki/ description: Learn about otelcol.receiver.loki -labels: - stage: beta title: otelcol.receiver.loki --- +Public preview + # otelcol.receiver.loki -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="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 index 58da159f4e..5dccc0b99d 100644 --- a/docs/sources/reference/components/otelcol.receiver.prometheus.md +++ b/docs/sources/reference/components/otelcol.receiver.prometheus.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.receiver.prometheus/ description: Learn about otelcol.receiver.prometheus -labels: - stage: beta title: otelcol.receiver.prometheus --- +Public preview + # otelcol.receiver.prometheus -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} `otelcol.receiver.prometheus` receives Prometheus metrics, converts them to the OpenTelemetry metrics format, and forwards them to other `otelcol.*` diff --git a/docs/sources/reference/components/prometheus.exporter.postgres.md b/docs/sources/reference/components/prometheus.exporter.postgres.md index 5c12182702..ae124cdd03 100644 --- a/docs/sources/reference/components/prometheus.exporter.postgres.md +++ b/docs/sources/reference/components/prometheus.exporter.postgres.md @@ -1,11 +1,11 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/prometheus.exporter.postgres/ description: Learn about prometheus.exporter.postgres -labels: - stage: beta title: prometheus.exporter.postgres --- +Public preview + # 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 index 2266778d49..d9aedf7dd3 100644 --- a/docs/sources/reference/components/prometheus.operator.podmonitors.md +++ b/docs/sources/reference/components/prometheus.operator.podmonitors.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/prometheus.operator.podmonitors/ description: Learn about prometheus.operator.podmonitors -labels: - stage: beta title: prometheus.operator.podmonitors --- +Public preview + # prometheus.operator.podmonitors -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="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: diff --git a/docs/sources/reference/components/prometheus.operator.probes.md b/docs/sources/reference/components/prometheus.operator.probes.md index 4f5923a232..67e6d14188 100644 --- a/docs/sources/reference/components/prometheus.operator.probes.md +++ b/docs/sources/reference/components/prometheus.operator.probes.md @@ -1,14 +1,15 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/prometheus.operator.probes/ description: Learn about prometheus.operator.probes -labels: - stage: beta + title: prometheus.operator.probes --- +Public preview + # prometheus.operator.probes -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="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 index 096c40b463..693edb062a 100644 --- a/docs/sources/reference/components/prometheus.operator.servicemonitors.md +++ b/docs/sources/reference/components/prometheus.operator.servicemonitors.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/prometheus.operator.servicemonitors/ description: Learn about prometheus.operator.servicemonitors -labels: - stage: beta title: prometheus.operator.servicemonitors --- +Public preview + # prometheus.operator.servicemonitors -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="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: diff --git a/docs/sources/reference/components/pyroscope.ebpf.md b/docs/sources/reference/components/pyroscope.ebpf.md index b03a555706..708d9ac407 100644 --- a/docs/sources/reference/components/pyroscope.ebpf.md +++ b/docs/sources/reference/components/pyroscope.ebpf.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/pyroscope.ebpf/ description: Learn about pyroscope.ebpf -labels: - stage: beta title: pyroscope.ebpf --- +Public preview + # pyroscope.ebpf -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} `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`. diff --git a/docs/sources/reference/components/pyroscope.java.md b/docs/sources/reference/components/pyroscope.java.md index 701b5c8823..96f5ffc10f 100644 --- a/docs/sources/reference/components/pyroscope.java.md +++ b/docs/sources/reference/components/pyroscope.java.md @@ -6,7 +6,7 @@ title: pyroscope.java # pyroscope.java -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} `pyroscope.java` continuously profiles Java processes running on the local Linux OS using [async-profiler](https://github.com/async-profiler/async-profiler). diff --git a/docs/sources/reference/components/pyroscope.scrape.md b/docs/sources/reference/components/pyroscope.scrape.md index fc161f1a6b..ccdccf0785 100644 --- a/docs/sources/reference/components/pyroscope.scrape.md +++ b/docs/sources/reference/components/pyroscope.scrape.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/pyroscope.scrape/ description: Learn about pyroscope.scrape -labels: - stage: beta title: pyroscope.scrape --- +Public preview + # pyroscope.scrape -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} `pyroscope.scrape` collects [pprof] performance profiles for a given set of HTTP `targets`. diff --git a/docs/sources/reference/components/pyroscope.write.md b/docs/sources/reference/components/pyroscope.write.md index 90d29eaea6..98f34a1b5d 100644 --- a/docs/sources/reference/components/pyroscope.write.md +++ b/docs/sources/reference/components/pyroscope.write.md @@ -1,14 +1,14 @@ --- canonical: https://grafana.com/docs/alloy/latest/reference/components/pyroscope.write/ description: Learn about pyroscope.write -labels: - stage: beta title: pyroscope.write --- +Public preview + # pyroscope.write -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} `pyroscope.write` receives performance profiles from other components and forwards them to a series of user-supplied endpoints using [Pyroscope' Push API](/oss/pyroscope/). diff --git a/docs/sources/reference/config-blocks/import.file.md b/docs/sources/reference/config-blocks/import.file.md index 7038848c93..9a8abc53d2 100644 --- a/docs/sources/reference/config-blocks/import.file.md +++ b/docs/sources/reference/config-blocks/import.file.md @@ -3,14 +3,14 @@ aliases: - ./reference/config-blocks/import.file/ canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/import.file/ description: Learn about the import.file configuration block -labels: - stage: beta title: import.file --- +Public preview + # import.file -{{< docs/shared lookup="stability/public-preview.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} The `import.file` block imports custom components from a file or a directory and exposes them to the importer. `import.file` blocks must be given a label that determines the namespace where custom components are exposed.