open-telemetry · codeboten · Mar 3, 2026 · Mar 3, 2026
@@ -1,6 +1,9 @@
+<!-- status autogenerated section -->
 # Named Pipe Receiver
 
-<!-- status autogenerated section -->
+This receiver supports opening a Unix Named Pipe (aka FIFO), and reading logs from it.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [alpha]: logs   |
@@ -15,8 +18,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-This receiver supports opening a Unix Named Pipe (aka FIFO), and reading logs from it.
-
 ## Prerequisites
 
 Named pipes are only supported on Unix operating systems.

@@ -1,5 +1,9 @@
+display_name: Named Pipe Receiver
 type: namedpipe
 
+description: |
+  This receiver supports opening a Unix Named Pipe (aka FIFO), and reading logs from it.
+
 status:
   class: receiver
   stability:

@@ -1,5 +1,12 @@
-# Netflow receiver
 <!-- status autogenerated section -->
+# Netflow Receiver
+
+The Netflow Receiver can listen for [netflow](https://en.wikipedia.org/wiki/NetFlow),
+[sflow](https://en.wikipedia.org/wiki/SFlow), and [ipfix](https://en.wikipedia.org/wiki/IP_Flow_Information_Export)
+data and convert it to OpenTelemetry logs. The receiver is based on the
+[goflow2](https://github.com/netsampler/goflow2) project.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [alpha]: logs   |
@@ -12,9 +19,7 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-The netflow receiver can listen for [netflow](https://en.wikipedia.org/wiki/NetFlow), [sflow](https://en.wikipedia.org/wiki/SFlow), and [ipfix](https://en.wikipedia.org/wiki/IP_Flow_Information_Export) data and convert it to OpenTelemetry logs. The receiver is based on the [goflow2](https://github.com/netsampler/goflow2) project.
-
-This gives OpenTelemetry users the capability of monitoring network traffic, and answer questions like:
+This receiver gives OpenTelemetry users the capability of monitoring network traffic, and answer questions like:
 
 * Which protocols are passing through the network?
 * Which servers and clients are producing the highest amount of traffic?

@@ -1,6 +1,14 @@
+display_name: Netflow Receiver
 type: netflow
 scope_name: otelcol/netflowreceiver
 
+description: |
+  The Netflow Receiver can listen for [netflow](https://en.wikipedia.org/wiki/NetFlow),
+  [sflow](https://en.wikipedia.org/wiki/SFlow), and [ipfix](https://en.wikipedia.org/wiki/IP_Flow_Information_Export)
+  data and convert it to OpenTelemetry logs. The receiver is based on the
+  [goflow2](https://github.com/netsampler/goflow2) project.
+
+
 status:
   class: receiver
   stability:

@@ -1,6 +1,10 @@
+<!-- status autogenerated section -->
 # NGINX Receiver
 
-<!-- status autogenerated section -->
+This receiver can fetch stats from a NGINX instance using the `ngx_http_stub_status_module` module's `status`
+endpoint.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [beta]: metrics   |
@@ -14,8 +18,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-This receiver can fetch stats from a NGINX instance using the `ngx_http_stub_status_module` module's `status` endpoint.
-
 ## Configuration
 
 ### NGINX Module

@@ -1,5 +1,10 @@
+display_name: NGINX Receiver
 type: nginx
 
+description: |
+  This receiver can fetch stats from a NGINX instance using the `ngx_http_stub_status_module` module's `status`
+  endpoint.
+
 status:
   class: receiver
   stability:

@@ -1,6 +1,10 @@
+<!-- status autogenerated section -->
 # NSX-T Receiver
 
-<!-- status autogenerated section -->
+This receiver fetches metrics important to run virtual networking using NSX-T. The receiver ingests metrics via the
+[NSX Rest API](https://docs.vmware.com/en/VMware-NSX-Data-Center-for-vSphere/6.4/nsx_64_api.pdf).
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [alpha]: metrics   |
@@ -13,9 +17,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-This receiver fetches metrics important to run virtual networking using NSX-T. The receiver ingests metrics via the [NSX Rest API](https://docs.vmware.com/en/VMware-NSX-Data-Center-for-vSphere/6.4/nsx_64_api.pdf).
-
-
 > :construction: This receiver is in **ALPHA**. Configuration fields and metric data model are subject to change.
 
 ## Purpose

@@ -1,5 +1,10 @@
+display_name: NSX-T Receiver
 type: nsxt
 
+description: |
+  This receiver fetches metrics important to run virtual networking using NSX-T. The receiver ingests metrics via the
+  [NSX Rest API](https://docs.vmware.com/en/VMware-NSX-Data-Center-for-vSphere/6.4/nsx_64_api.pdf).
+
 status:
   class: receiver
   stability:

@@ -1,6 +1,9 @@
+<!-- status autogenerated section -->
 # NTP Receiver
 
-<!-- status autogenerated section -->
+This receiver periodically retrieves the clock offset from a NTP server.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [beta]: metrics   |
@@ -13,10 +16,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-## Purpose
-
-This receiver periodically retrieves the clock offset from a NTP server.
-
 ## Configuration
 
 - `endpoint`: (default = `pool.ntp.org:123`) Endpoint of the NTP server. Must be formatted as `{host}:{port}`. 

@@ -1,5 +1,9 @@
+display_name: NTP Receiver
 type: ntp
 
+description: |
+  This receiver periodically retrieves the clock offset from a NTP server.
+
 status:
   class: receiver
   stability:

@@ -1,6 +1,9 @@
-# Oracle DB receiver
-
 <!-- status autogenerated section -->
+# Oracle DB Receiver
+
+This receiver periodically queries an Oracle Database host to collect metrics.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [development]: logs   |
@@ -15,10 +18,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-This receiver collects metrics from an Oracle Database.
-
-The receiver connects to a database host and performs periodically queries.
-
 ## Getting Started
 
 To use the OracleDB receiver you must define how to connect to your DB. This can be done in two ways,

@@ -1,5 +1,9 @@
+display_name: Oracle DB Receiver
 type: oracledb
 
+description: |
+  This receiver periodically queries an Oracle Database host to collect metrics.
+
 reaggregation_enabled: true
 
 status:

@@ -1,5 +1,10 @@
-# osquery Receiver
 <!-- status autogenerated section -->
+# osquery Receiver
+
+The osquery Receiver runs queries run on an [osquery](https://osquery.io/)'s daemon on a schedule and converts the
+output to logs.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [development]: logs   |
@@ -12,8 +17,6 @@
 [development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
 <!-- end autogenerated section -->
 
-The osquery receiver runs queries run on an [osquery](https://osquery.io/)'s daemon on a schedule and converts the output to logs.
-
 ## Configuration
 
 The following settings are required:

@@ -1,5 +1,10 @@
+display_name: osquery Receiver
 type: osquery
 
+description: |
+  The osquery Receiver runs queries run on an [osquery](https://osquery.io/)'s daemon on a schedule and converts the
+  output to logs.
+
 status:
   class: receiver
   stability:

@@ -1,6 +1,13 @@
-# OpenTelemetry Protocol with Apache Arrow Receiver
-
 <!-- status autogenerated section -->
+# Apache Arrow OTLP Receiver
+
+Receives telemetry data using [OpenTelemetry Protocol with Apache
+Arrow](https://github.com/open-telemetry/otel-arrow) and standard
+[OTLP](
+https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md)
+protocol via gRPC.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [beta]: traces, metrics, logs   |
@@ -14,12 +21,6 @@
 [k8s]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s
 <!-- end autogenerated section -->
 
-Receives telemetry data using [OpenTelemetry Protocol with Apache
-Arrow](https://github.com/open-telemetry/otel-arrow) and standard
-[OTLP](
-https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md)
-protocol via gRPC.
-
 ## Getting Started
 
 The OpenTelemetry Protocol with Apache Arrow receiver is an extension

@@ -1,5 +1,13 @@
+display_name: Apache Arrow OTLP Receiver
 type: otelarrow
 
+description: |
+  Receives telemetry data using [OpenTelemetry Protocol with Apache
+  Arrow](https://github.com/open-telemetry/otel-arrow) and standard
+  [OTLP](
+  https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md)
+  protocol via gRPC.
+
 status:
   class: receiver
   stability:

@@ -1,6 +1,13 @@
+<!-- status autogenerated section -->
 # OTLP JSON File Receiver
 
-<!-- status autogenerated section -->
+This receiver will read pipeline data from JSON files. The data is written in
+[Protobuf JSON
+  encoding](https://developers.google.com/protocol-buffers/docs/proto3#json)
+using [OpenTelemetry
+protocol](https://github.com/open-telemetry/opentelemetry-proto).
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [development]: profiles   |
@@ -15,12 +22,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-This receiver will read pipeline data from JSON files. The data is written in
-[Protobuf JSON
-encoding](https://developers.google.com/protocol-buffers/docs/proto3#json)
-using [OpenTelemetry
-protocol](https://github.com/open-telemetry/opentelemetry-proto).
-
 The receiver will watch the directory and read files. If a file is updated or added,
 the receiver will read it in its entirety again.
 

@@ -1,5 +1,13 @@
+display_name: OTLP JSON File Receiver
 type: otlpjsonfile
 
+description: |
+  This receiver will read pipeline data from JSON files. The data is written in
+  [Protobuf JSON
+    encoding](https://developers.google.com/protocol-buffers/docs/proto3#json)
+  using [OpenTelemetry
+  protocol](https://github.com/open-telemetry/opentelemetry-proto).
+
 status:
   class: receiver
   stability:

@@ -1,6 +1,11 @@
+<!-- status autogenerated section -->
 # Podman Stats Receiver
 
-<!-- status autogenerated section -->
+The Podman Stats Receiver queries the Podman service API to fetch stats for all running containers 
+on a configured interval.  These stats are for container resource usage of cpu, memory, network, and
+the [blkio controller](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt).
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [alpha]: metrics   |
@@ -14,11 +19,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-The Podman Stats receiver queries the Podman service API to fetch stats for all running containers 
-on a configured interval.  These stats are for container
-resource usage of cpu, memory, network, and the
-[blkio controller](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt).
-
 > :information_source: Requires Podman API version 3.3.1+ and Windows is not supported.
 
 

@@ -1,5 +1,11 @@
+display_name: Podman Stats Receiver
 type: podman_stats
 
+description: |
+  The Podman Stats Receiver queries the Podman service API to fetch stats for all running containers 
+  on a configured interval.  These stats are for container resource usage of cpu, memory, network, and
+  the [blkio controller](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt).
+
 status:
   class: receiver
   stability: