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.

Sign up for GitHub

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

Jump to bottom

First step to change release life cycle info #93

Merged
merged 7 commits into from
Mar 27, 2024
Merged

First step to change release life cycle info #93

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1cbc1d7
First step to change release life cycle info
clayton-cornell Mar 27, 2024
cd74dd5
Update shared link
clayton-cornell Mar 27, 2024
ac9f4fd
Remove beta label and add public preview badge
clayton-cornell Mar 27, 2024
96944f8
Add missing beta shared element and remove extra aliases
clayton-cornell Mar 27, 2024
a83f050
Update beta references and remove redundant aliases
clayton-cornell Mar 27, 2024
4d2141b
Fix bad metadata and remove redundant stability topic
clayton-cornell Mar 27, 2024
9e94fa2
Fix bad copy paste
clayton-cornell Mar 27, 2024
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
10 changes: 5 additions & 5 deletions docs/sources/concepts/clustering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 0 additions & 2 deletions docs/sources/reference/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
aliases:
- ./reference/
canonical: https://grafana.com/docs/alloy/latest/reference/
description: The reference-level documentaiton for Grafana Aloy
menuTitle: Reference
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/cli/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/sources/reference/cli/convert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# The convert command

{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}

The `convert` command converts a supported configuration format to the {{< param "PRODUCT_NAME" >}} configuration format.

## Usage
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/cli/fmt.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/sources/reference/cli/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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="<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.
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/cli/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/sources/reference/compatibility/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 4 additions & 2 deletions docs/sources/reference/components/discovery.kubelet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<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
6 changes: 3 additions & 3 deletions docs/sources/reference/components/discovery.process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# discovery.process

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}

`discovery.process` discovers processes running on the local Linux OS.

Expand Down
7 changes: 4 additions & 3 deletions docs/sources/reference/components/loki.echo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
canonical: https://grafana.com/docs/alloy/latest/reference/components/loki.echo/
description: Learn about loki.echo
labels:
stage: beta
title: loki.echo
---

<span class="aliases:
- ./reference/stdlib/trim/ docs-labels__stage docs-labels__item">Public preview</span>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bad paste here I think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed


# loki.echo

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< 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).

Expand Down
6 changes: 3 additions & 3 deletions docs/sources/reference/components/mimir.rules.kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# mimir.rules.kubernetes

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< 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
6 changes: 3 additions & 3 deletions docs/sources/reference/components/otelcol.exporter.loadbalancing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# otelcol.exporter.loadbalancing

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}

<!-- Include a picture of the LB architecture? -->

Expand Down
1 change: 0 additions & 1 deletion docs/sources/reference/components/otelcol.processor.discovery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/sources/reference/components/otelcol.processor.resourcedetection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# otelcol.processor.resourcedetection

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<AGENT VERSION>" >}}
{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<AGENT 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.

Expand Down
6 changes: 3 additions & 3 deletions docs/sources/reference/components/otelcol.processor.tail_sampling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# otelcol.processor.tail_sampling

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< 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
Expand Down
6 changes: 3 additions & 3 deletions docs/sources/reference/components/otelcol.receiver.loki.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# otelcol.receiver.loki

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< 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
6 changes: 3 additions & 3 deletions docs/sources/reference/components/otelcol.receiver.prometheus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# otelcol.receiver.prometheus

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}

`otelcol.receiver.prometheus` receives Prometheus metrics, converts them to the
OpenTelemetry metrics format, and forwards them to other `otelcol.*`
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/reference/components/prometheus.exporter.postgres.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# prometheus.exporter.postgres

The `prometheus.exporter.postgres` component embeds
Expand Down
10 changes: 5 additions & 5 deletions docs/sources/reference/components/prometheus.operator.podmonitors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# prometheus.operator.podmonitors

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< 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:

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
---- | ---- | ----------- | ------- | --------
Expand Down
10 changes: 5 additions & 5 deletions docs/sources/reference/components/prometheus.operator.probes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# prometheus.operator.probes

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< 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 Expand Up @@ -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
---- | ---- | ----------- | ------- | --------
Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/sources/reference/components/prometheus.operator.servicemonitors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# prometheus.operator.servicemonitors

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< 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:

Expand Down
6 changes: 3 additions & 3 deletions docs/sources/reference/components/pyroscope.ebpf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
---

<span class="badge docs-labels__stage docs-labels__item">Public preview</span>

# pyroscope.ebpf

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<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`.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/reference/components/pyroscope.java.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: pyroscope.java

# pyroscope.java

{{< docs/shared lookup="stability/beta.md" source="alloy" version="<ALLOY_VERSION>" >}}
{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}

`pyroscope.java` continuously profiles Java processes running on the local Linux OS
using [async-profiler](https://github.com/async-profiler/async-profiler).
Expand Down
Loading
Loading