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/cli/run.md b/docs/sources/reference/cli/run.md index 2158dc7973..f91ff7eafd 100644 --- a/docs/sources/reference/cli/run.md +++ b/docs/sources/reference/cli/run.md @@ -126,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/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/loki.echo.md b/docs/sources/reference/components/loki.echo.md index 3cd8c26b86..b54408fe78 100644 --- a/docs/sources/reference/components/loki.echo.md +++ b/docs/sources/reference/components/loki.echo.md @@ -4,7 +4,8 @@ description: Learn about loki.echo title: loki.echo --- -Public preview +Public preview # loki.echo 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/prometheus.operator.podmonitors.md b/docs/sources/reference/components/prometheus.operator.podmonitors.md index d9aedf7dd3..b1fc4c413c 100644 --- a/docs/sources/reference/components/prometheus.operator.podmonitors.md +++ b/docs/sources/reference/components/prometheus.operator.podmonitors.md @@ -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 334cab8bca..c9d1d89276 100644 --- a/docs/sources/reference/components/prometheus.operator.probes.md +++ b/docs/sources/reference/components/prometheus.operator.probes.md @@ -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/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.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..afc85b493a 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/ 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/stability.md b/docs/sources/stability.md index ab8ab7bb90..20da5017b2 100644 --- a/docs/sources/stability.md +++ b/docs/sources/stability.md @@ -1,6 +1,6 @@ --- canonical: https://grafana.com/docs/alloy/latest/stability/ -description: Alloy features fall into one of three stability categories, experimental, beta, or stable +description: Alloy features fall into one of three stability categories, experimental, public preview, or generally available title: Stability weight: 600 _build: @@ -15,11 +15,11 @@ Stability of functionality usually refers to the stability of a _use case,_ such 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. +* **Public preview**: Functionality covering a use case is being matured. +* **Generally available**: 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. +Features are explicitly marked as experimental or public preview if they aren't stable. ## Experimental @@ -30,21 +30,21 @@ exploring a new use case, and would like feedback. * 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. +Unless removed, experimental features eventually graduate to public preview. -## Beta +## Public preview -The **beta** stability category is used to denote a feature which is being matured. +The **public preview** 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. +Unless replaced with equivalent functionality, public preview features eventually graduate to generally available. -## Stable +## Generally available -The **stable** stability category is used to denote a feature as stable. +The **generally available** 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. 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