Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: correct component stability in documentation #130

Merged
merged 3 commits into from
Apr 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions docs/sources/reference/components/discovery.kubelet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 0 additions & 4 deletions docs/sources/reference/components/loki.echo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 0 additions & 4 deletions docs/sources/reference/components/loki.rules.kubernetes.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 0 additions & 4 deletions docs/sources/reference/components/loki.source.kubernetes.md
Original file line number Diff line number Diff line change
@@ -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`:

Expand Down
4 changes: 0 additions & 4 deletions docs/sources/reference/components/loki.source.podlogs.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 0 additions & 4 deletions docs/sources/reference/components/mimir.rules.kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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" >}}
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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" >}}
Expand Down Expand Up @@ -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 -->
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
4 changes: 0 additions & 4 deletions docs/sources/reference/components/otelcol.processor.span.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
4 changes: 0 additions & 4 deletions docs/sources/reference/components/otelcol.receiver.loki.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>" >}}
Expand Down Expand Up @@ -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 -->
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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 -->
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 -->
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 -->
4 changes: 3 additions & 1 deletion docs/sources/reference/components/pyroscope.java.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>" >}}
Expand Down Expand Up @@ -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 -->
22 changes: 12 additions & 10 deletions docs/sources/reference/config-blocks/remotecfg.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>" >}}

Expand All @@ -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"
}
```

Expand Down
Loading
Loading