Skip to content

Commit 7320bd4

Browse files
clayton-cornellCopilot
clayton-cornell
and
Copilot
authored
docs: Clean up the community component docs (#5307)
Clean up the community component doc metadata and add links * Removed `stage: experimental` metadata line * Removed shared text element for "Experimental" * Added link to Community components docs in the shared text block for community contributions Other changes: * Removed some empty spaces at the end of lines, in tables, and empty lines in code samples * Formatted some table spacing * Fixed the status of `otel.receiver.promethus` * The `prometheus.go` file says `Stability: featuregate.StabilityGenerallyAvailable`, on line 34. Updated docs to state GA. * Line 136 in `prometheus.go` says `enableNativeHistograms = c.opts.MinStability.Permits(featuregate.StabilityPublicPreview)`. Updated note to state Public Preview flag is needed to enable this feature * Added a `debug_metrics` block to the Block documentaiton section because of line 49 in `prometheus.go` which states `DebugMetrics otelcolCfg.DebugMetricsArguments alloy:"debug_metrics,block,optional"` ## Not done: * Add community content owners to CODEOWNERS Fixes: #5168 --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 9eef001 commit 7320bd4

5 files changed

Lines changed: 44 additions & 47 deletions

File tree

‎docs/sources/reference/components/otelcol/otelcol.receiver.awsecscontainermetrics.md‎

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,14 @@ labels:
55
stage: experimental
66
products:
77
- oss
8-
tags:
9-
- text: Community
10-
tooltip: This component is developed, maintained, and supported by the Alloy user community.
118
title: otelcol.receiver.awsecscontainermetrics
129
---
1310

1411
# `otelcol.receiver.awsecscontainermetrics`
1512

16-
{{< docs/shared lookup="stability/community.md" source="alloy" version="<ALLOY_VERSION>" >}}
13+
{{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
1714

18-
{{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
19-
20-
`otelcol.receiver.awsecscontainermetrics` reads AWS ECS task- and container-level metadata, and resource usage metrics such as CPU, memory, network, and disk, and forwards them to other `otelcol.*` components.
15+
`otelcol.receiver.awsecscontainermetrics` reads AWS ECS task- and container-level metadata, and resource usage metrics such as CPU, memory, network, and disk, and forwards them to other `otelcol.*` components.
2116

2217
{{< admonition type="note" >}}
2318
`otelcol.receiver.awsecscontainermetrics` is a wrapper over the upstream OpenTelemetry Collector [`awsecscontainermetrics`][] receiver.
@@ -26,7 +21,7 @@ Bug reports or feature requests will be redirected to the upstream repository, i
2621
[`awsecscontainermetrics`]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/{{< param "OTEL_VERSION" >}}/receiver/awsecscontainermetricsreceiver
2722
{{< /admonition >}}
2823

29-
This receiver supports ECS Fargate and ECS on EC2. It uses [ECS Task Metadata Endpoint V4](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-metadata-endpoint-v4.html) which is automatically available within the task's containers. Therefore, you should run the {{< param "PRODUCT_NAME" >}} collector using this receiver as a sidecar within the task you want to monitor. Refer to the upstream [`awsecscontainermetrics`][] receiver documentation for more details.
24+
This receiver supports ECS Fargate and ECS on EC2. It uses [ECS Task Metadata Endpoint V4](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-metadata-endpoint-v4.html) which is automatically available within the task's containers. Therefore, you should run the {{< param "PRODUCT_NAME" >}} collector using this receiver as a sidecar within the task you want to monitor. Refer to the upstream [`awsecscontainermetrics`][] receiver documentation for more details.
3025

3126
You can specify multiple `otelcol.receiver.awsecscontainermetrics` components by giving them different labels.
3227

@@ -46,16 +41,16 @@ otelcol.receiver.awsecscontainermetrics "<LABEL>" {
4641

4742
You can use the following arguments with `otelcol.receiver.awsecscontainermetrics`:
4843

49-
| Name | Type | Description | Default | Required |
50-
|-----------------|----------------------------|--------------------------------------------------------------------------|---------|----------|
51-
| `collection_interval` | `duration` | How frequently to collect and emit metrics. | "20s" | no |
44+
| Name | Type | Description | Default | Required |
45+
| --------------------- | ---------- | ------------------------------------------- | ------- | -------- |
46+
| `collection_interval` | `duration` | How frequently to collect and emit metrics. | "20s" | no |
5247

5348
## Blocks
5449

5550
You can use the following blocks with `otelcol.receiver.awsecscontainermetrics`:
5651

5752
| Block | Description | Required |
58-
|----------------------------------|----------------------------------------------------------------------------|----------|
53+
| -------------------------------- | -------------------------------------------------------------------------- | -------- |
5954
| [`output`][output] | Configures where to send received telemetry data. | yes |
6055
| [`debug_metrics`][debug_metrics] | Configures the metrics that this component generates to monitor its state. | no |
6156

@@ -86,7 +81,7 @@ You can use the following blocks with `otelcol.receiver.awsecscontainermetrics`:
8681

8782
## Example
8883

89-
The following example collects eight task-level metrics from the 52 metrics available in an ECS task and forwards them to a filter processor.
84+
The following example collects eight task-level metrics from the 52 metrics available in an ECS task and forwards them to a filter processor.
9085

9186
```alloy
9287
otelcol.receiver.awsecscontainermetrics "default" {

‎docs/sources/reference/components/otelcol/otelcol.receiver.googlecloudpubsub.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
canonical: https://grafana.com/docs/alloy/latest/reference/components/otelcol/otelcol.receiver.googlecloudpubsub/
33
description: Learn about otelcol.receiver.googlecloudpubsub
44
labels:
5-
stage: experimental
65
products:
76
- oss
87
tags:
@@ -45,7 +44,7 @@ otelcol.receiver.googlecloudpubsub "<LABEL>" {
4544
You can use the following arguments with `otelcol.receiver.googlecloudpubsub`:
4645

4746
| Name | Type | Description | Default | Required |
48-
|-------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| -------- |
47+
| ----------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- |
4948
| `subscription` | `string` | The subscription name to receive OTLP data from. The subscription name should be a fully qualified resource name, for example: `projects/otel-project/subscriptions/otlp`. | `""` | yes |
5049
| `compression` | `string` | The compression used on data received from the subscription. Only `gzip` is supported. This is only used when no content-encoding attribute is present. | `""` | no |
5150
| `encoding` | `string` | The encoding used to receive data from the subscription. This can either be `otlp_proto_trace`, `otlp_proto_metric`, `otlp_proto_log` or an encoding extension. This is only used when no media type attribute is present. | `""` | no |
@@ -62,7 +61,7 @@ You can use the following arguments with `otelcol.receiver.googlecloudpubsub`:
6261
You can use the following blocks with `otelcol.receiver.googlecloudpubsub`:
6362

6463
| Block | Description | Required |
65-
|----------------------------------|----------------------------------------------------------------------------|----------|
64+
| -------------------------------- | -------------------------------------------------------------------------- | -------- |
6665
| [`output`][output] | Configures where to send received telemetry data. | yes |
6766
| [`debug_metrics`][debug_metrics] | Configures the metrics that this component generates to monitor its state. | no |
6867

‎docs/sources/reference/components/otelcol/otelcol.receiver.prometheus.md‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@ aliases:
44
- ../otelcol.receiver.prometheus/ # /docs/alloy/latest/reference/otelcol.receiver.prometheus/
55
description: Learn about otelcol.receiver.prometheus
66
labels:
7-
stage: public-preview
7+
stage: general-availability
88
products:
99
- oss
1010
title: otelcol.receiver.prometheus
1111
---
1212

1313
# `otelcol.receiver.prometheus`
1414

15-
{{< docs/shared lookup="stability/public_preview.md" source="alloy" version="<ALLOY_VERSION>" >}}
16-
1715
`otelcol.receiver.prometheus` receives Prometheus metrics, converts them to the OpenTelemetry metrics format, and forwards them to other `otelcol.*` components.
16+
This is a custom component built on a fork of the upstream OpenTelemetry Collector receiver.
1817

1918
You can specify multiple `otelcol.receiver.prometheus` components by giving them different labels.
2019

2120
{{< admonition type="note" >}}
22-
`otelcol.receiver.prometheus` is a custom component built on a fork of the upstream OpenTelemetry receiver.
21+
Support for translating Prometheus native histograms into OTLP exponential histograms is a public preview feature.
22+
To enable native histogram translation, run {{< param "PRODUCT_NAME" >}} with the `--stability.level=public-preview` configuration flag.
2323
{{< /admonition >}}
2424

2525
{{< admonition type="note" >}}
@@ -54,26 +54,32 @@ The `otelcol.receiver.prometheus` component doesn't support any arguments. You c
5454

5555
## Blocks
5656

57-
You can use the following block with `otelcol.receiver.prometheus`:
57+
You can use the following blocks with `otelcol.receiver.prometheus`:
5858

59-
| Block | Description | Required |
60-
|--------------------|---------------------------------------------------|----------|
61-
| [`output`][output] | Configures where to send received telemetry data. | yes |
59+
| Block | Description | Required |
60+
| -------------------------------- | -------------------------------------------------------------------------- | -------- |
61+
| [`output`][output] | Configures where to send received telemetry data. | yes |
62+
| [`debug_metrics`][debug_metrics] | Configures the metrics that this component generates to monitor its state. | no |
6263

6364
[output]: #output
65+
[debug_metrics]: #debug_metrics
6466

6567
### `output`
6668

6769
{{< badge text="Required" >}}
6870

6971
{{< docs/shared lookup="reference/components/output-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
7072

73+
### `debug_metrics`
74+
75+
{{< docs/shared lookup="reference/components/otelcol-debug-metrics-block.md" source="alloy" version="<ALLOY_VERSION>" >}}
76+
7177
## Exported fields
7278

73-
The following fields are exported and can be referenced by other components:
79+
This component exports the following fields that other components can reference:
7480

7581
| Name | Type | Description |
76-
|------------|-------------------|----------------------------------------------------------------------|
82+
| ---------- | ----------------- | -------------------------------------------------------------------- |
7783
| `receiver` | `MetricsReceiver` | A value that other components can use to send Prometheus metrics to. |
7884

7985
## Component health
@@ -88,7 +94,7 @@ The following fields are exported and can be referenced by other components:
8894

8995
This example uses the `otelcol.receiver.prometheus` component as a bridge between the Prometheus and OpenTelemetry ecosystems.
9096
The component exposes a receiver which the `prometheus.scrape` component uses to send Prometheus metric data to.
91-
The metrics are converted to the OTLP format before they're forwarded to the `otelcol.exporter.otlp` component to be sent to an OTLP-capable endpoint:
97+
The receiver converts the metrics to OTLP format and forwards them to the `otelcol.exporter.otlp` component, which sends them to an OTLP-capable endpoint:
9298

9399
```alloy
94100
prometheus.scrape "default" {

‎docs/sources/reference/components/pyroscope/pyroscope.enrich.md‎

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,11 @@ labels:
55
stage: experimental
66
products:
77
- oss
8-
tags:
9-
- text: Community
10-
tooltip: This component is developed, maintained, and supported by the Alloy user community.
118
title: pyroscope.enrich
129
---
1310

1411
# `pyroscope.enrich`
1512

16-
{{< docs/shared lookup="stability/community.md" source="alloy" version="<ALLOY_VERSION>" >}}
17-
1813
{{< docs/shared lookup="stability/experimental.md" source="alloy" version="<ALLOY_VERSION>" >}}
1914

2015
`pyroscope.enrich` enriches profiles with additional labels from service discovery targets.
@@ -34,13 +29,13 @@ pyroscope.enrich "<LABEL>" {
3429

3530
You can use the following arguments with `pyroscope.enrich`:
3631

37-
| Name | Type | Description | Default | Required |
38-
| ---------------------- | ------------------------ | --------------------------------------------------------------------------------------------- | ------- | -------- |
39-
| `forward_to` | `list(ProfilesReceiver)` | List of receivers to send enriched profiles to. | | yes |
40-
| `target_match_label` | `string` | The label from discovered targets to match against. | | yes |
41-
| `targets` | `list(Target)` | List of targets from a discovery component. | | yes |
42-
| `labels_to_copy` | `list(string)` | List of labels to copy from discovered targets to profiles. If empty, all labels are copied. | | no |
43-
| `profiles_match_label` | `string` | The label from incoming profiles to match against discovered targets. | | no |
32+
| Name | Type | Description | Default | Required |
33+
| ---------------------- | ------------------------ | -------------------------------------------------------------------------------------------- | ------- | -------- |
34+
| `forward_to` | `list(ProfilesReceiver)` | List of receivers to send enriched profiles to. | | yes |
35+
| `target_match_label` | `string` | The label from discovered targets to match against. | | yes |
36+
| `targets` | `list(Target)` | List of targets from a discovery component. | | yes |
37+
| `labels_to_copy` | `list(string)` | List of labels to copy from discovered targets to profiles. If empty, all labels are copied. | | no |
38+
| `profiles_match_label` | `string` | The label from incoming profiles to match against discovered targets. | | no |
4439

4540
If `profiles_match_label` isn't provided, the component uses `target_match_label` for matching profile labels.
4641

@@ -53,9 +48,9 @@ Configure this component with arguments.
5348

5449
The following fields are exported and can be referenced by other components:
5550

56-
| Name | Type | Description |
57-
| ---------- | -------------------- | ----------------------------------- |
58-
| `receiver` | `ProfilesReceiver` | The receiver for profiles. |
51+
| Name | Type | Description |
52+
| ---------- | ------------------ | -------------------------- |
53+
| `receiver` | `ProfilesReceiver` | The receiver for profiles. |
5954

6055
## Component health
6156

@@ -82,27 +77,27 @@ discovery.kubernetes "pods" {
8277
// Add custom labels from Kubernetes metadata
8378
discovery.relabel "pods" {
8479
targets = discovery.kubernetes.pods.targets
85-
80+
8681
rule {
8782
source_labels = ["__meta_kubernetes_namespace"]
8883
target_label = "namespace"
8984
}
90-
85+
9186
rule {
9287
source_labels = ["__meta_kubernetes_pod_node_name"]
9388
target_label = "node"
9489
}
95-
90+
9691
rule {
9792
source_labels = ["__meta_kubernetes_pod_label_app"]
9893
target_label = "app"
9994
}
100-
95+
10196
rule {
10297
source_labels = ["__meta_kubernetes_pod_label_environment"]
10398
target_label = "environment"
10499
}
105-
100+
106101
rule {
107102
source_labels = ["__meta_kubernetes_pod_ip"]
108103
target_label = "pod_ip"

‎docs/sources/shared/stability/community.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,7 @@ headless: true
77
> **Community**: This component is developed, maintained, and supported by the Alloy user community.
88
> Grafana doesn't offer commercial support for this component.
99
> To enable and use community components, you must set the `--feature.community-components.enabled` [flag][] to `true`.
10+
>
11+
> Refer to [Community components](../../../../get-started/components/community-components/) for more information.
1012
1113
[flag]: https://grafana.com/docs/alloy/<ALLOY_VERSION>/reference/cli/run/

0 commit comments

Comments
 (0)