From 32c08b4634c58f623b9c1afb3d36e5e62da06180 Mon Sep 17 00:00:00 2001 From: Jay DeLuca Date: Tue, 3 Mar 2026 13:33:59 -0500 Subject: [PATCH] Add display names for receivers part 6 --- receiver/namedpipereceiver/README.md | 7 ++++--- receiver/namedpipereceiver/metadata.yaml | 4 ++++ receiver/netflowreceiver/README.md | 13 +++++++++---- receiver/netflowreceiver/metadata.yaml | 8 ++++++++ receiver/nginxreceiver/README.md | 8 +++++--- receiver/nginxreceiver/metadata.yaml | 5 +++++ receiver/nsxtreceiver/README.md | 9 +++++---- receiver/nsxtreceiver/metadata.yaml | 5 +++++ receiver/ntpreceiver/README.md | 9 ++++----- receiver/ntpreceiver/metadata.yaml | 4 ++++ receiver/oracledbreceiver/README.md | 11 +++++------ receiver/oracledbreceiver/metadata.yaml | 4 ++++ receiver/osqueryreceiver/README.md | 9 ++++++--- receiver/osqueryreceiver/metadata.yaml | 5 +++++ receiver/otelarrowreceiver/README.md | 17 +++++++++-------- receiver/otelarrowreceiver/metadata.yaml | 8 ++++++++ receiver/otlpjsonfilereceiver/README.md | 15 ++++++++------- receiver/otlpjsonfilereceiver/metadata.yaml | 8 ++++++++ receiver/podmanreceiver/README.md | 12 ++++++------ receiver/podmanreceiver/metadata.yaml | 6 ++++++ 20 files changed, 118 insertions(+), 49 deletions(-) diff --git a/receiver/namedpipereceiver/README.md b/receiver/namedpipereceiver/README.md index 4952ac9be9c03..bbf5c014b511e 100644 --- a/receiver/namedpipereceiver/README.md +++ b/receiver/namedpipereceiver/README.md @@ -1,6 +1,9 @@ + # Named Pipe Receiver - +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 -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. diff --git a/receiver/namedpipereceiver/metadata.yaml b/receiver/namedpipereceiver/metadata.yaml index a9e22f71f6160..9c13af40ebec9 100644 --- a/receiver/namedpipereceiver/metadata.yaml +++ b/receiver/namedpipereceiver/metadata.yaml @@ -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: diff --git a/receiver/netflowreceiver/README.md b/receiver/netflowreceiver/README.md index 7e3f5c3d5f793..2be91a5f9e792 100644 --- a/receiver/netflowreceiver/README.md +++ b/receiver/netflowreceiver/README.md @@ -1,5 +1,12 @@ -# Netflow receiver +# 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 -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? diff --git a/receiver/netflowreceiver/metadata.yaml b/receiver/netflowreceiver/metadata.yaml index a2a56002b9858..5b5b8b18920e1 100644 --- a/receiver/netflowreceiver/metadata.yaml +++ b/receiver/netflowreceiver/metadata.yaml @@ -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: diff --git a/receiver/nginxreceiver/README.md b/receiver/nginxreceiver/README.md index 9046eb3cb5995..d9d512bbb7011 100644 --- a/receiver/nginxreceiver/README.md +++ b/receiver/nginxreceiver/README.md @@ -1,6 +1,10 @@ + # NGINX Receiver - +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 -This receiver can fetch stats from a NGINX instance using the `ngx_http_stub_status_module` module's `status` endpoint. - ## Configuration ### NGINX Module diff --git a/receiver/nginxreceiver/metadata.yaml b/receiver/nginxreceiver/metadata.yaml index ce689010e3378..71ae785506c7c 100644 --- a/receiver/nginxreceiver/metadata.yaml +++ b/receiver/nginxreceiver/metadata.yaml @@ -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: diff --git a/receiver/nsxtreceiver/README.md b/receiver/nsxtreceiver/README.md index ecd9ad3762fd1..27afe97ecab50 100644 --- a/receiver/nsxtreceiver/README.md +++ b/receiver/nsxtreceiver/README.md @@ -1,6 +1,10 @@ + # NSX-T Receiver - +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 -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 diff --git a/receiver/nsxtreceiver/metadata.yaml b/receiver/nsxtreceiver/metadata.yaml index 2f19be3bab301..84369e811c9e2 100644 --- a/receiver/nsxtreceiver/metadata.yaml +++ b/receiver/nsxtreceiver/metadata.yaml @@ -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: diff --git a/receiver/ntpreceiver/README.md b/receiver/ntpreceiver/README.md index 0706bec7bc640..17b65b6b4afc9 100644 --- a/receiver/ntpreceiver/README.md +++ b/receiver/ntpreceiver/README.md @@ -1,6 +1,9 @@ + # NTP Receiver - +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 -## 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}`. diff --git a/receiver/ntpreceiver/metadata.yaml b/receiver/ntpreceiver/metadata.yaml index dac42bcae0e27..54aaa2631a5d2 100644 --- a/receiver/ntpreceiver/metadata.yaml +++ b/receiver/ntpreceiver/metadata.yaml @@ -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: diff --git a/receiver/oracledbreceiver/README.md b/receiver/oracledbreceiver/README.md index 5e157eed495c1..375006802f568 100644 --- a/receiver/oracledbreceiver/README.md +++ b/receiver/oracledbreceiver/README.md @@ -1,6 +1,9 @@ -# Oracle DB receiver - +# 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 -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, diff --git a/receiver/oracledbreceiver/metadata.yaml b/receiver/oracledbreceiver/metadata.yaml index 7e8aa637f311f..31a1c2bac07b4 100644 --- a/receiver/oracledbreceiver/metadata.yaml +++ b/receiver/oracledbreceiver/metadata.yaml @@ -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: diff --git a/receiver/osqueryreceiver/README.md b/receiver/osqueryreceiver/README.md index d06a4b50b4a4c..a9d9b7d48fc0b 100644 --- a/receiver/osqueryreceiver/README.md +++ b/receiver/osqueryreceiver/README.md @@ -1,5 +1,10 @@ -# osquery Receiver +# 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 -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: diff --git a/receiver/osqueryreceiver/metadata.yaml b/receiver/osqueryreceiver/metadata.yaml index c17e1b141af1d..b81dec5e5e064 100644 --- a/receiver/osqueryreceiver/metadata.yaml +++ b/receiver/osqueryreceiver/metadata.yaml @@ -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: diff --git a/receiver/otelarrowreceiver/README.md b/receiver/otelarrowreceiver/README.md index f0cfafb4af306..c6b7d1ab33093 100644 --- a/receiver/otelarrowreceiver/README.md +++ b/receiver/otelarrowreceiver/README.md @@ -1,6 +1,13 @@ -# OpenTelemetry Protocol with Apache Arrow Receiver - +# 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 -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 diff --git a/receiver/otelarrowreceiver/metadata.yaml b/receiver/otelarrowreceiver/metadata.yaml index b9b3b23dcc04a..5187a6c876a06 100644 --- a/receiver/otelarrowreceiver/metadata.yaml +++ b/receiver/otelarrowreceiver/metadata.yaml @@ -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: diff --git a/receiver/otlpjsonfilereceiver/README.md b/receiver/otlpjsonfilereceiver/README.md index e47b8c3627c2a..b6fc439d9a5ed 100644 --- a/receiver/otlpjsonfilereceiver/README.md +++ b/receiver/otlpjsonfilereceiver/README.md @@ -1,6 +1,13 @@ + # OTLP JSON File Receiver - +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 -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. diff --git a/receiver/otlpjsonfilereceiver/metadata.yaml b/receiver/otlpjsonfilereceiver/metadata.yaml index b5300ce26b090..f324d44b89050 100644 --- a/receiver/otlpjsonfilereceiver/metadata.yaml +++ b/receiver/otlpjsonfilereceiver/metadata.yaml @@ -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: diff --git a/receiver/podmanreceiver/README.md b/receiver/podmanreceiver/README.md index 5539692fb4dd0..6aa720fe73301 100644 --- a/receiver/podmanreceiver/README.md +++ b/receiver/podmanreceiver/README.md @@ -1,6 +1,11 @@ + # Podman Stats Receiver - +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 -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. diff --git a/receiver/podmanreceiver/metadata.yaml b/receiver/podmanreceiver/metadata.yaml index b9fa5d8ebf5ee..2295476fe7c10 100644 --- a/receiver/podmanreceiver/metadata.yaml +++ b/receiver/podmanreceiver/metadata.yaml @@ -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: