From f3a27d792b44fb38b7b5d1e0e8fefc844f5cbee5 Mon Sep 17 00:00:00 2001 From: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> Date: Wed, 27 Mar 2024 15:20:02 -0700 Subject: [PATCH] First step to change release life cycle info (#93) * First step to change release life cycle info * Update shared link * Remove beta label and add public preview badge * Add missing beta shared element and remove extra aliases * Update beta references and remove redundant aliases * Fix bad metadata and remove redundant stability topic * Fix bad copy paste --- docs/sources/concepts/clustering.md | 10 ++-- docs/sources/reference/_index.md | 2 - docs/sources/reference/cli/_index.md | 2 - docs/sources/reference/cli/convert.md | 8 +-- docs/sources/reference/cli/fmt.md | 2 - docs/sources/reference/cli/run.md | 6 +-- docs/sources/reference/cli/tools.md | 2 - .../sources/reference/compatibility/_index.md | 2 - .../reference/components/discovery.kubelet.md | 6 ++- .../reference/components/discovery.process.md | 6 +-- .../sources/reference/components/loki.echo.md | 6 +-- .../components/loki.rules.kubernetes.md | 1 + .../components/mimir.rules.kubernetes.md | 6 +-- .../otelcol.exporter.loadbalancing.md | 6 +-- .../components/otelcol.processor.discovery.md | 1 - .../otelcol.processor.resourcedetection.md | 6 +-- .../otelcol.processor.tail_sampling.md | 6 +-- .../components/otelcol.receiver.loki.md | 6 +-- .../components/otelcol.receiver.prometheus.md | 6 +-- .../prometheus.exporter.postgres.md | 4 +- .../prometheus.operator.podmonitors.md | 10 ++-- .../components/prometheus.operator.probes.md | 10 ++-- .../prometheus.operator.servicemonitors.md | 6 +-- .../reference/components/pyroscope.ebpf.md | 6 +-- .../reference/components/pyroscope.java.md | 2 +- .../reference/components/pyroscope.scrape.md | 6 +-- .../reference/components/pyroscope.write.md | 6 +-- .../sources/reference/config-blocks/_index.md | 2 - .../reference/config-blocks/argument.md | 2 - .../reference/config-blocks/declare.md | 2 - .../sources/reference/config-blocks/export.md | 2 - docs/sources/reference/config-blocks/http.md | 2 - .../reference/config-blocks/import.file.md | 8 ++- .../reference/config-blocks/import.git.md | 2 - .../reference/config-blocks/import.http.md | 2 - .../reference/config-blocks/import.string.md | 2 - .../reference/config-blocks/logging.md | 2 - .../reference/config-blocks/remotecfg.md | 12 ++--- .../reference/config-blocks/tracing.md | 2 - docs/sources/reference/stdlib/_index.md | 2 - docs/sources/reference/stdlib/coalesce.md | 2 - docs/sources/reference/stdlib/concat.md | 2 - docs/sources/reference/stdlib/constants.md | 2 - docs/sources/reference/stdlib/env.md | 2 - docs/sources/reference/stdlib/format.md | 2 - docs/sources/reference/stdlib/join.md | 2 - docs/sources/reference/stdlib/json_decode.md | 2 - docs/sources/reference/stdlib/json_path.md | 2 - docs/sources/reference/stdlib/nonsensitive.md | 2 - docs/sources/reference/stdlib/replace.md | 2 - docs/sources/reference/stdlib/split.md | 2 - docs/sources/reference/stdlib/to_lower.md | 2 - docs/sources/reference/stdlib/to_upper.md | 2 - docs/sources/reference/stdlib/trim.md | 2 - docs/sources/reference/stdlib/trim_prefix.md | 2 - docs/sources/reference/stdlib/trim_space.md | 2 - docs/sources/reference/stdlib/trim_suffix.md | 2 - docs/sources/shared/stability/beta.md | 11 ---- docs/sources/shared/stability/experimental.md | 2 +- .../shared/stability/public_preview.md | 10 ++++ docs/sources/stability.md | 51 ------------------- .../tasks/configure-alloy-clustering.md | 1 - 62 files changed, 84 insertions(+), 207 deletions(-) delete mode 100644 docs/sources/shared/stability/beta.md create mode 100644 docs/sources/shared/stability/public_preview.md delete mode 100644 docs/sources/stability.md diff --git a/docs/sources/concepts/clustering.md b/docs/sources/concepts/clustering.md index 129a96eb00..231cdd2d08 100644 --- a/docs/sources/concepts/clustering.md +++ b/docs/sources/concepts/clustering.md @@ -58,10 +58,10 @@ Refer to component reference documentation to discover whether it supports clust You can use the {{< param "PRODUCT_NAME" >}} UI [clustering page][] to monitor your cluster status. Refer to [Debugging clustering issues][debugging] for additional troubleshooting information. -[run]: ../../reference/cli/run/#clustering-beta -[prometheus.scrape]: ../../reference/components/prometheus.scrape/#clustering-beta -[pyroscope.scrape]: ../../reference/components/pyroscope.scrape/#clustering-beta -[prometheus.operator.podmonitors]: ../../reference/components/prometheus.operator.podmonitors/#clustering-beta -[prometheus.operator.servicemonitors]: ../../reference/components/prometheus.operator.servicemonitors/#clustering-beta +[run]: ../../reference/cli/run/#clustering +[prometheus.scrape]: ../../reference/components/prometheus.scrape/#clustering-block +[pyroscope.scrape]: ../../reference/components/pyroscope.scrape/#clustering-block +[prometheus.operator.podmonitors]: ../../reference/components/prometheus.operator.podmonitors/#clustering-block +[prometheus.operator.servicemonitors]: ../../reference/components/prometheus.operator.servicemonitors/#clustering-block [clustering page]: ../../tasks/debug/#clustering-page [debugging]: ../../tasks/debug/#debugging-clustering-issues diff --git a/docs/sources/reference/_index.md b/docs/sources/reference/_index.md index 6845cd1220..131f8cd275 100644 --- a/docs/sources/reference/_index.md +++ b/docs/sources/reference/_index.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/ canonical: https://grafana.com/docs/alloy/latest/reference/ description: The reference-level documentaiton for Grafana Aloy menuTitle: Reference diff --git a/docs/sources/reference/cli/_index.md b/docs/sources/reference/cli/_index.md index cc04418d16..d4a109eb4f 100644 --- a/docs/sources/reference/cli/_index.md +++ b/docs/sources/reference/cli/_index.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/cli/ canonical: https://grafana.com/docs/alloy/latest/reference/cli/ description: Learn about the Grafana Alloy command line interface menuTitle: Command-line interface diff --git a/docs/sources/reference/cli/convert.md b/docs/sources/reference/cli/convert.md index 893df15820..8c1a72a316 100644 --- a/docs/sources/reference/cli/convert.md +++ b/docs/sources/reference/cli/convert.md @@ -1,17 +1,17 @@ --- -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 +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} + The `convert` command converts a supported configuration format to the {{< param "PRODUCT_NAME" >}} configuration format. ## Usage diff --git a/docs/sources/reference/cli/fmt.md b/docs/sources/reference/cli/fmt.md index 20981499d1..aa79986388 100644 --- a/docs/sources/reference/cli/fmt.md +++ b/docs/sources/reference/cli/fmt.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/cli/fmt/ canonical: https://grafana.com/docs/alloy/latest/reference/cli/fmt/ description: Learn about the fmt command menuTitle: fmt diff --git a/docs/sources/reference/cli/run.md b/docs/sources/reference/cli/run.md index b2a15111cd..f91ff7eafd 100644 --- a/docs/sources/reference/cli/run.md +++ b/docs/sources/reference/cli/run.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/cli/run/ canonical: https://grafana.com/docs/alloy/latest/reference/cli/run/ description: Learn about the run command menuTitle: run @@ -128,7 +126,9 @@ Each {{< param "PRODUCT_NAME" >}} then transitions to the terminating state when The current state of a clustered {{< param "PRODUCT_NAME" >}} is shown on the clustering page in the [UI][]. -## Configuration conversion (beta) +## Configuration conversion + +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} When you use the `--config.format` command-line argument with a value other than `alloy`, {{< param "PRODUCT_NAME" >}} converts the configuration file from the source format to {{< param "PRODUCT_NAME" >}} and immediately starts running with the new configuration. This conversion uses the converter API described in the [alloy convert][] docs. diff --git a/docs/sources/reference/cli/tools.md b/docs/sources/reference/cli/tools.md index e19b339558..bf4cba90dc 100644 --- a/docs/sources/reference/cli/tools.md +++ b/docs/sources/reference/cli/tools.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/cli/tools/ canonical: https://grafana.com/docs/aalloyent/latest/reference/cli/tools/ description: Learn about the tools command menuTitle: tools diff --git a/docs/sources/reference/compatibility/_index.md b/docs/sources/reference/compatibility/_index.md index c34d9281bf..34019927ca 100644 --- a/docs/sources/reference/compatibility/_index.md +++ b/docs/sources/reference/compatibility/_index.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/compatibility/ canonical: https://grafana.com/docs/alloy/latest/reference/compatibility/ description: Learn about which components are compatible with each other in Grafana Alloy title: Compatible components diff --git a/docs/sources/reference/components/discovery.kubelet.md b/docs/sources/reference/components/discovery.kubelet.md index 0ed182e6d7..d642f39d0d 100644 --- a/docs/sources/reference/components/discovery.kubelet.md +++ b/docs/sources/reference/components/discovery.kubelet.md @@ -1,13 +1,15 @@ --- 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 +{{< docs/shared lookup="stability/public_preview.md" source="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/discovery.process.md b/docs/sources/reference/components/discovery.process.md index 042d410f92..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/beta.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 675c2ef3ce..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/beta.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/loki.rules.kubernetes.md b/docs/sources/reference/components/loki.rules.kubernetes.md index ccb822271d..89f74c541a 100644 --- a/docs/sources/reference/components/loki.rules.kubernetes.md +++ b/docs/sources/reference/components/loki.rules.kubernetes.md @@ -1,4 +1,5 @@ --- +canonical: https://grafana.com/docs/alloy/latest/reference/components/loki.rules.kubernetes/ title: loki.rules.kubernetes labels: stage: experimental diff --git a/docs/sources/reference/components/mimir.rules.kubernetes.md b/docs/sources/reference/components/mimir.rules.kubernetes.md index 13fce5feec..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/beta.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 cb47e44532..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/beta.md" source="alloy" version="" >}} +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} diff --git a/docs/sources/reference/components/otelcol.processor.discovery.md b/docs/sources/reference/components/otelcol.processor.discovery.md index 4ce4b76e70..16be8a5e71 100644 --- a/docs/sources/reference/components/otelcol.processor.discovery.md +++ b/docs/sources/reference/components/otelcol.processor.discovery.md @@ -1,5 +1,4 @@ --- -aliases: canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.discovery/ description: Learn about otelcol.processor.discovery title: otelcol.processor.discovery diff --git a/docs/sources/reference/components/otelcol.processor.resourcedetection.md b/docs/sources/reference/components/otelcol.processor.resourcedetection.md index 94c719c25e..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/beta.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 e301d11816..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/beta.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 539e42e5cc..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/beta.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 79a2dfe11e..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/beta.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 cbd00b0d8d..b1fc4c413c 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/beta.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: @@ -68,7 +68,7 @@ inside a `client` block. [match_expression]: #match_expression-block [rule]: #rule-block [scrape]: #scrape-block -[clustering]: #clustering-beta +[clustering]: #clustering-block ### client block @@ -158,7 +158,7 @@ The `operator` argument must be one of the following strings: If there are multiple `match_expressions` blocks inside of a `selector` block, they are combined together with AND clauses. -### clustering (beta) +### clustering block Name | Type | Description | Default | Required ---- | ---- | ----------- | ------- | -------- diff --git a/docs/sources/reference/components/prometheus.operator.probes.md b/docs/sources/reference/components/prometheus.operator.probes.md index 5b60d54edf..c9d1d89276 100644 --- a/docs/sources/reference/components/prometheus.operator.probes.md +++ b/docs/sources/reference/components/prometheus.operator.probes.md @@ -1,14 +1,14 @@ --- 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/beta.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: @@ -160,7 +160,7 @@ The `operator` argument must be one of the following strings: If there are multiple `match_expressions` blocks inside of a `selector` block, they are combined together with AND clauses. -### clustering (experimental) +### clustering block Name | Type | Description | Default | Required ---- | ---- | ----------- | ------- | -------- @@ -188,7 +188,7 @@ fully consistent like hashmod sharding is). If {{< param "PRODUCT_NAME" >}} is _not_ running in clustered mode, then the block is a no-op, and `prometheus.operator.probes` scrapes every target it receives in its arguments. -[clustered mode]: ../../cli/run/#clustering-beta +[clustered mode]: ../../cli/run/#clustering ## Exported fields diff --git a/docs/sources/reference/components/prometheus.operator.servicemonitors.md b/docs/sources/reference/components/prometheus.operator.servicemonitors.md index 7032c0e7f1..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/beta.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 913dd765dd..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/beta.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 e9c47c5c04..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/beta.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 e89faea9a4..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/beta.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 d08735e216..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/beta.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/_index.md b/docs/sources/reference/config-blocks/_index.md index e3ac635534..fdda4857f0 100644 --- a/docs/sources/reference/config-blocks/_index.md +++ b/docs/sources/reference/config-blocks/_index.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/config-blocks/ canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/ description: Learn about configuration blocks title: Configuration blocks diff --git a/docs/sources/reference/config-blocks/argument.md b/docs/sources/reference/config-blocks/argument.md index 56676ee6f7..21b5ef9793 100644 --- a/docs/sources/reference/config-blocks/argument.md +++ b/docs/sources/reference/config-blocks/argument.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/config-blocks/argument/ canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/argument/ description: Learn about the argument configuration block menuTitle: argument diff --git a/docs/sources/reference/config-blocks/declare.md b/docs/sources/reference/config-blocks/declare.md index d8f8179eee..7f711644fe 100644 --- a/docs/sources/reference/config-blocks/declare.md +++ b/docs/sources/reference/config-blocks/declare.md @@ -1,6 +1,4 @@ --- -aliases: -- ./flow/reference/config-blocks/declare/ canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/declare/ description: Learn about the declare configuration block menuTitle: declare diff --git a/docs/sources/reference/config-blocks/export.md b/docs/sources/reference/config-blocks/export.md index 72d365be27..109e6792c9 100644 --- a/docs/sources/reference/config-blocks/export.md +++ b/docs/sources/reference/config-blocks/export.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/config-blocks/export/ canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/export/ description: Learn about the export configuration block menuTitle: export diff --git a/docs/sources/reference/config-blocks/http.md b/docs/sources/reference/config-blocks/http.md index c0718a760f..c994465970 100644 --- a/docs/sources/reference/config-blocks/http.md +++ b/docs/sources/reference/config-blocks/http.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/config-blocks/http/ canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/http/ description: Learn about the http configuration block menuTitle: http diff --git a/docs/sources/reference/config-blocks/import.file.md b/docs/sources/reference/config-blocks/import.file.md index 005f1055f9..bf6788733d 100644 --- a/docs/sources/reference/config-blocks/import.file.md +++ b/docs/sources/reference/config-blocks/import.file.md @@ -1,16 +1,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/beta.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. diff --git a/docs/sources/reference/config-blocks/import.git.md b/docs/sources/reference/config-blocks/import.git.md index 800a1859e2..5117dee0d8 100644 --- a/docs/sources/reference/config-blocks/import.git.md +++ b/docs/sources/reference/config-blocks/import.git.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/config-blocks/import.git/ canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/import.git/ description: Learn about the import.git configuration block title: import.git diff --git a/docs/sources/reference/config-blocks/import.http.md b/docs/sources/reference/config-blocks/import.http.md index 004d461440..43c9bc0dcd 100644 --- a/docs/sources/reference/config-blocks/import.http.md +++ b/docs/sources/reference/config-blocks/import.http.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/config-blocks/import.http/ canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/import.http/ description: Learn about the import.http configuration block title: import.http diff --git a/docs/sources/reference/config-blocks/import.string.md b/docs/sources/reference/config-blocks/import.string.md index 29e59d81a4..b90953e82b 100644 --- a/docs/sources/reference/config-blocks/import.string.md +++ b/docs/sources/reference/config-blocks/import.string.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/config-blocks/import.string/ canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/import.string/ description: Learn about the import.string configuration block title: import.string diff --git a/docs/sources/reference/config-blocks/logging.md b/docs/sources/reference/config-blocks/logging.md index 090cd64ecc..4240f604eb 100644 --- a/docs/sources/reference/config-blocks/logging.md +++ b/docs/sources/reference/config-blocks/logging.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/config-blocks/logging/ canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/logging/ description: Learn about the logging configuration block menuTitle: logging diff --git a/docs/sources/reference/config-blocks/remotecfg.md b/docs/sources/reference/config-blocks/remotecfg.md index 8b5ce6a1e5..b5766b1563 100644 --- a/docs/sources/reference/config-blocks/remotecfg.md +++ b/docs/sources/reference/config-blocks/remotecfg.md @@ -1,22 +1,19 @@ --- -aliases: -- ./reference/config-blocks/remotecfg/ -canonical: remotecfgs://grafana.com/docs/alloy/latest/reference/config-blocks/remotecfg/ +canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/remotecfg/ description: Learn about the remotecfg configuration block menuTitle: remotecfg title: remotecfg block --- -# remotecfg block (beta) +# remotecfg block (public preview) + +{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="" >}} `remotecfg` is an optional configuration block that enables {{< param "PRODUCT_NAME" >}} to fetch and load the configuration from a remote endpoint. `remotecfg` is specified without a label and can only be provided once per configuration file. The [API definition][] for managing and fetching configuration that the `remotecfg` block uses is available under the Apache 2.0 license. -> **BETA**: The `remotecfg` enables [beta][] functionality. -> Beta features are subject to breaking changes, and may be replaced with equivalent functionality that cover the same use case. - ## Example ```river @@ -83,7 +80,6 @@ For example, `oauth2 > tls_config` refers to a `tls_config` block defined inside {{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="" >}} [API definition]: https://github.com/grafana/alloy-remote-config -[beta]: ../../../stability/#beta [basic_auth]: #basic_auth-block [authorization]: #authorization-block [oauth2]: #oauth2-block diff --git a/docs/sources/reference/config-blocks/tracing.md b/docs/sources/reference/config-blocks/tracing.md index c6d058af4c..5365368dbb 100644 --- a/docs/sources/reference/config-blocks/tracing.md +++ b/docs/sources/reference/config-blocks/tracing.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/config-blocks/tracing/ canonical: https://grafana.com/docs/alloy/latest/reference/config-blocks/tracing/ description: Learn about the tracing configuration block menuTitle: tracing diff --git a/docs/sources/reference/stdlib/_index.md b/docs/sources/reference/stdlib/_index.md index 489dfadadb..1ce00e6dd9 100644 --- a/docs/sources/reference/stdlib/_index.md +++ b/docs/sources/reference/stdlib/_index.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/ description: The standard library is a list of functions used in expressions when assigning values to attributes title: Standard library diff --git a/docs/sources/reference/stdlib/coalesce.md b/docs/sources/reference/stdlib/coalesce.md index a089644c90..e65213e36a 100644 --- a/docs/sources/reference/stdlib/coalesce.md +++ b/docs/sources/reference/stdlib/coalesce.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/coalesce/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/coalesce/ description: Learn about coalesce title: coalesce diff --git a/docs/sources/reference/stdlib/concat.md b/docs/sources/reference/stdlib/concat.md index c233fbaa2c..55b5386716 100644 --- a/docs/sources/reference/stdlib/concat.md +++ b/docs/sources/reference/stdlib/concat.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/concat/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/concat/ description: Learn about concat title: concat diff --git a/docs/sources/reference/stdlib/constants.md b/docs/sources/reference/stdlib/constants.md index 3e9e394af2..94cbf42bba 100644 --- a/docs/sources/reference/stdlib/constants.md +++ b/docs/sources/reference/stdlib/constants.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/constants/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/constants/ description: Learn about constants title: constants diff --git a/docs/sources/reference/stdlib/env.md b/docs/sources/reference/stdlib/env.md index 48cc6e2712..f37eea84d3 100644 --- a/docs/sources/reference/stdlib/env.md +++ b/docs/sources/reference/stdlib/env.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/env/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/env/ description: Learn about env title: env diff --git a/docs/sources/reference/stdlib/format.md b/docs/sources/reference/stdlib/format.md index 4f5d227cd8..27c06834d2 100644 --- a/docs/sources/reference/stdlib/format.md +++ b/docs/sources/reference/stdlib/format.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/format/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/format/ description: Learn about format title: format diff --git a/docs/sources/reference/stdlib/join.md b/docs/sources/reference/stdlib/join.md index fdec1cbf0e..c1385c1a89 100644 --- a/docs/sources/reference/stdlib/join.md +++ b/docs/sources/reference/stdlib/join.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/join/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/join/ description: Learn about join title: join diff --git a/docs/sources/reference/stdlib/json_decode.md b/docs/sources/reference/stdlib/json_decode.md index af2cd366e1..3b1f6c2479 100644 --- a/docs/sources/reference/stdlib/json_decode.md +++ b/docs/sources/reference/stdlib/json_decode.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/json_decode/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/json_decode/ description: Learn about json_decode title: json_decode diff --git a/docs/sources/reference/stdlib/json_path.md b/docs/sources/reference/stdlib/json_path.md index cca63b8492..5b7b23b79e 100644 --- a/docs/sources/reference/stdlib/json_path.md +++ b/docs/sources/reference/stdlib/json_path.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/json_path/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/json_path/ description: Learn about json_path title: json_path diff --git a/docs/sources/reference/stdlib/nonsensitive.md b/docs/sources/reference/stdlib/nonsensitive.md index bacea7271e..d593c496b2 100644 --- a/docs/sources/reference/stdlib/nonsensitive.md +++ b/docs/sources/reference/stdlib/nonsensitive.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/nonsensitive/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/nonsensitive/ description: Learn about nonsensitive title: nonsensitive diff --git a/docs/sources/reference/stdlib/replace.md b/docs/sources/reference/stdlib/replace.md index 89722e6364..dc400e9168 100644 --- a/docs/sources/reference/stdlib/replace.md +++ b/docs/sources/reference/stdlib/replace.md @@ -1,6 +1,4 @@ --- -aliases: -- .reference/stdlib/replace/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/replace/ description: Learn about replace title: replace diff --git a/docs/sources/reference/stdlib/split.md b/docs/sources/reference/stdlib/split.md index c033739f90..e56b471235 100644 --- a/docs/sources/reference/stdlib/split.md +++ b/docs/sources/reference/stdlib/split.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/split/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/split/ description: Learn about split title: split diff --git a/docs/sources/reference/stdlib/to_lower.md b/docs/sources/reference/stdlib/to_lower.md index 27af0825fb..1945b1b2cd 100644 --- a/docs/sources/reference/stdlib/to_lower.md +++ b/docs/sources/reference/stdlib/to_lower.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/to_lower/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/to_lower/ description: Learn about to_lower title: to_lower diff --git a/docs/sources/reference/stdlib/to_upper.md b/docs/sources/reference/stdlib/to_upper.md index ee8c1509bf..23ec80d309 100644 --- a/docs/sources/reference/stdlib/to_upper.md +++ b/docs/sources/reference/stdlib/to_upper.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/to_upper/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/to_upper/ description: Learn about to_upper title: to_upper diff --git a/docs/sources/reference/stdlib/trim.md b/docs/sources/reference/stdlib/trim.md index 5f904df6a4..15370a5e67 100644 --- a/docs/sources/reference/stdlib/trim.md +++ b/docs/sources/reference/stdlib/trim.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/trim/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/trim/ description: Learn about trim title: trim diff --git a/docs/sources/reference/stdlib/trim_prefix.md b/docs/sources/reference/stdlib/trim_prefix.md index 6bb900f2dd..28bc8235a1 100644 --- a/docs/sources/reference/stdlib/trim_prefix.md +++ b/docs/sources/reference/stdlib/trim_prefix.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/trim_prefix/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/trim_prefix/ description: Learn about trim_prefix title: trim_prefix diff --git a/docs/sources/reference/stdlib/trim_space.md b/docs/sources/reference/stdlib/trim_space.md index 06646e56af..7c3ffece95 100644 --- a/docs/sources/reference/stdlib/trim_space.md +++ b/docs/sources/reference/stdlib/trim_space.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/trim_space/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/trim_space/ description: Learn about trim_space title: trim_space diff --git a/docs/sources/reference/stdlib/trim_suffix.md b/docs/sources/reference/stdlib/trim_suffix.md index d13c596230..ba855204d9 100644 --- a/docs/sources/reference/stdlib/trim_suffix.md +++ b/docs/sources/reference/stdlib/trim_suffix.md @@ -1,6 +1,4 @@ --- -aliases: -- ./reference/stdlib/trim_suffix/ canonical: https://grafana.com/docs/alloy/latest/reference/stdlib/trim_suffix/ description: Learn about trim_suffix title: trim_suffix diff --git a/docs/sources/shared/stability/beta.md b/docs/sources/shared/stability/beta.md deleted file mode 100644 index 0935e5b70d..0000000000 --- a/docs/sources/shared/stability/beta.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -canonical: https://grafana.com/docs/alloy/latest/shared/stability/beta/ -description: Shared content, beta -headless: true ---- - -> **BETA**: This is a [beta][] component. Beta components are subject to breaking -> changes, and may be replaced with equivalent functionality that cover the -> same use case. - -[beta]: ../../../stability/#beta diff --git a/docs/sources/shared/stability/experimental.md b/docs/sources/shared/stability/experimental.md index 6028ba3cdd..ca64f2e8d6 100644 --- a/docs/sources/shared/stability/experimental.md +++ b/docs/sources/shared/stability/experimental.md @@ -8,4 +8,4 @@ headless: true > components are subject to frequent breaking changes, and may be removed with > no equivalent replacement. -[experimental]: ../../../stability/#experimental +[experimental]: https://grafana.com/docs/release-life-cycle/ diff --git a/docs/sources/shared/stability/public_preview.md b/docs/sources/shared/stability/public_preview.md new file mode 100644 index 0000000000..748b327a86 --- /dev/null +++ b/docs/sources/shared/stability/public_preview.md @@ -0,0 +1,10 @@ +--- +canonical: https://grafana.com/docs/alloy/latest/shared/stability/public_preview/ +description: Shared content, public preview +headless: true +--- + +> **Public preview**: This is a [public preview][] component. Public preview components are subject to breaking +> changes, and may be replaced with equivalent functionality that cover the same use case. + +[public preview]: https://grafana.com/docs/release-life-cycle/ diff --git a/docs/sources/stability.md b/docs/sources/stability.md deleted file mode 100644 index ab8ab7bb90..0000000000 --- a/docs/sources/stability.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -canonical: https://grafana.com/docs/alloy/latest/stability/ -description: Alloy features fall into one of three stability categories, experimental, beta, or stable -title: Stability -weight: 600 -_build: - list: false -noindex: true ---- - -# Stability - -Stability of functionality usually refers to the stability of a _use case,_ such as collecting and forwarding OpenTelemetry metrics. - -Features within the {{< param "FULL_PRODUCT_NAME" >}} project will fall into one of three stability categories: - -* **Experimental**: A new use case is being explored. -* **Beta**: Functionality covering a use case is being matured. -* **Stable**: Functionality covering a use case is believed to be stable. - -The default stability is stable. -Features are explicitly marked as experimental or beta if they aren't stable. - -## Experimental - -The **experimental** stability category is used to denote that maintainers are -exploring a new use case, and would like feedback. - -* Experimental features are subject to frequent breaking changes. -* Experimental features can be removed with no equivalent replacement. -* Experimental features may require enabling feature flags to use. - -Unless removed, experimental features eventually graduate to beta. - -## Beta - -The **beta** stability category is used to denote a feature which is being matured. - -* Beta features are subject to occasional breaking changes. -* Beta features can be replaced by equivalent functionality that covers the same use case. -* Beta features can be used without enabling feature flags. - -Unless replaced with equivalent functionality, beta features eventually graduate to stable. - -## Stable - -The **stable** stability category is used to denote a feature as stable. - -* Breaking changes to stable features are rare, and will be well-documented. -* If new functionality is introduced to replace existing stable functionality, deprecation and removal timeline will be well-documented. -* Stable features can be used without enabling feature flags. diff --git a/docs/sources/tasks/configure-alloy-clustering.md b/docs/sources/tasks/configure-alloy-clustering.md index f9afb90a29..3a59c1f0ce 100644 --- a/docs/sources/tasks/configure-alloy-clustering.md +++ b/docs/sources/tasks/configure-alloy-clustering.md @@ -49,6 +49,5 @@ To configure clustering: 1. Ensure that all expected nodes appear in the resulting table. [clustering]: ../../concepts/clustering/ -[beta]: ../../stability/#beta [install-helm]: ../../get-started/install/kubernetes/ [UI]: ../debug/#component-detail-page