[chore] Add display names for receivers - batch 5 (#46539)

jaydeluca · web-flow · commit 20c53d97c535 · 2026-03-03T11:58:28.000+10:30
**Description** Uses the new [display_name](open-telemetry/opentelemetry-collector#14115) and description fields for components. I am breaking up the receivers into batches since there are so many Related to open-telemetry/opentelemetry-collector#14114 and open-telemetry/opentelemetry-collector#14400 Continuation from #45537 #45554 #45599 #45647 #45722 #45883 #45950 #46035 #46055 #46216 #46339 #46472
diff --git a/receiver/kafkametricsreceiver/README.md b/receiver/kafkametricsreceiver/README.md
@@ -1,6 +1,10 @@
+<!-- status autogenerated section -->
 # Kafka Metrics Receiver
 
-<!-- status autogenerated section -->
+The Kafka Metrics Receiver collects kafka metrics (brokers, topics, partitions, consumer groups) from a kafka server,
+and converts them into otlp.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [beta]: metrics   |
@@ -13,9 +17,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-Kafka metrics receiver collects kafka metrics (brokers, topics, partitions, consumer groups) from kafka server,
-converting into otlp.
-
 ## Prerequisites
 
 This receiver supports Kafka versions:
diff --git a/receiver/kafkametricsreceiver/metadata.yaml b/receiver/kafkametricsreceiver/metadata.yaml
@@ -1,5 +1,10 @@
+display_name: Kafka Metrics Receiver
 type: kafkametrics
 
+description: |
+  The Kafka Metrics Receiver collects kafka metrics (brokers, topics, partitions, consumer groups) from a kafka server,
+  and converts them into otlp.
+
 status:
   class: receiver
   stability:
diff --git a/receiver/kafkareceiver/README.md b/receiver/kafkareceiver/README.md
@@ -1,6 +1,11 @@
+<!-- status autogenerated section -->
 # Kafka Receiver
 
-<!-- status autogenerated section -->
+The Kafka Receiver receives telemetry data from Kafka, with configurable topics and encodings. If used in conjunction
+with the `kafkaexporter` configured with `include_metadata_keys`, The Kafka Receiver will also propagate the Kafka
+headers to the downstream pipeline, giving access to the rest of the pipeline to arbitrary metadata keys and values.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [development]: profiles   |
@@ -16,10 +21,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-Kafka receiver receives telemetry data from Kafka, with configurable topics and encodings.
-
-If used in conjunction with the `kafkaexporter` configured with `include_metadata_keys`. The Kafka receiver will also propagate the Kafka headers to the downstream pipeline, giving access to the rest of the pipeline to arbitrary metadata keys and values.
-
 ## Getting Started
 
 > [!NOTE]
diff --git a/receiver/kafkareceiver/metadata.yaml b/receiver/kafkareceiver/metadata.yaml
@@ -1,5 +1,11 @@
+display_name: Kafka Receiver
 type: kafka
 
+description: |
+  The Kafka Receiver receives telemetry data from Kafka, with configurable topics and encodings. If used in conjunction
+  with the `kafkaexporter` configured with `include_metadata_keys`, The Kafka Receiver will also propagate the Kafka
+  headers to the downstream pipeline, giving access to the rest of the pipeline to arbitrary metadata keys and values.
+
 status:
   class: receiver
   stability:
diff --git a/receiver/kubeletstatsreceiver/README.md b/receiver/kubeletstatsreceiver/README.md
@@ -1,6 +1,10 @@
+<!-- status autogenerated section -->
 # Kubelet Stats Receiver
 
-<!-- status autogenerated section -->
+The Kubelet Stats Receiver pulls node, pod, container, and volume metrics from the API server on a kubelet
+and sends it down the metric pipeline for further processing.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [beta]: metrics   |
@@ -14,9 +18,6 @@
 [k8s]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s
 <!-- end autogenerated section -->
 
-The Kubelet Stats Receiver pulls node, pod, container, and volume metrics from the API server on a kubelet
-and sends it down the metric pipeline for further processing.
-
 ## Metrics
 
 Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml) with further documentation in [documentation.md](./documentation.md)
diff --git a/receiver/kubeletstatsreceiver/metadata.yaml b/receiver/kubeletstatsreceiver/metadata.yaml
@@ -1,5 +1,10 @@
+display_name: Kubelet Stats Receiver
 type: kubeletstats
 
+description: |
+  The Kubelet Stats Receiver pulls node, pod, container, and volume metrics from the API server on a kubelet
+  and sends it down the metric pipeline for further processing.
+
 status:
   class: receiver
   stability:
diff --git a/receiver/libhoneyreceiver/README.md b/receiver/libhoneyreceiver/README.md
@@ -1,5 +1,10 @@
-# Libhoney Receiver
 <!-- status autogenerated section -->
+# Libhoney Receiver
+
+The Libhoney Receiver will accept Trace and Logs signals that are emitted from applications that are
+instrumented using [Libhoney](https://docs.honeycomb.io/send-data/logs/structured/libhoney/) libraries.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [alpha]: traces, logs   |
@@ -12,11 +17,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-### The purpose and use-cases of the new component
-
-The Libhoney receiver will accept data for either Trace or Logs signals that are emitted from applications that were
-instrumented using [Libhoney](https://docs.honeycomb.io/send-data/logs/structured/libhoney/) libraries.
-
 ## Configuration
 
 The configuration has 2 parts, One is the HTTP receiver configuration and the rest is about mapping attributes from the
diff --git a/receiver/libhoneyreceiver/metadata.yaml b/receiver/libhoneyreceiver/metadata.yaml
@@ -1,5 +1,10 @@
+display_name: Libhoney Receiver
 type: libhoney
 
+description: |
+  The Libhoney Receiver will accept Trace and Logs signals that are emitted from applications that are
+  instrumented using [Libhoney](https://docs.honeycomb.io/send-data/logs/structured/libhoney/) libraries.
+
 status:
   class: receiver
   stability:
diff --git a/receiver/lokireceiver/README.md b/receiver/lokireceiver/README.md
@@ -1,6 +1,13 @@
+<!-- status autogenerated section -->
 # Loki Receiver
 
-<!-- status autogenerated section -->
+The Loki receiver implements the [Loki push api](https://grafana.com/docs/loki/latest/clients/promtail/#loki-push-api)
+as specified in [Loki HTTP API: Ingest logs](https://grafana.com/docs/loki/latest/reference/loki-http-api/#ingest-logs).
+It allows Promtail instances to specify the open telemetry collector as their lokiAddress.
+
+This receiver runs HTTP and GRPC servers to ingest log entries in Loki format.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [alpha]: logs   |
@@ -13,11 +20,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-The Loki receiver implements the [Loki push api](https://grafana.com/docs/loki/latest/clients/promtail/#loki-push-api) as specified in [Loki HTTP API: Ingest logs](https://grafana.com/docs/loki/latest/reference/loki-http-api/#ingest-logs).
-It allows Promtail instances to specify the open telemetry collector as their lokiAddress.
-
-This receiver runs HTTP and GRPC servers to ingest log entries in Loki format.
-
 ## Getting Started
 
 The settings are:
diff --git a/receiver/lokireceiver/metadata.yaml b/receiver/lokireceiver/metadata.yaml
@@ -1,5 +1,13 @@
+display_name: Loki Receiver
 type: loki
 
+description: |
+  The Loki receiver implements the [Loki push api](https://grafana.com/docs/loki/latest/clients/promtail/#loki-push-api)
+  as specified in [Loki HTTP API: Ingest logs](https://grafana.com/docs/loki/latest/reference/loki-http-api/#ingest-logs).
+  It allows Promtail instances to specify the open telemetry collector as their lokiAddress.
+  
+  This receiver runs HTTP and GRPC servers to ingest log entries in Loki format.
+
 status:
   class: receiver
   stability:
diff --git a/receiver/macosunifiedloggingreceiver/README.md b/receiver/macosunifiedloggingreceiver/README.md
@@ -1,6 +1,10 @@
+<!-- status autogenerated section -->
 # macOS Unified Logging Receiver
 
-<!-- status autogenerated section -->
+The macOS Unified Logging Receiver collects logs from macOS systems using the native `log` command. This receiver
+supports both live system logs and archived log files (`.logarchive`).
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [alpha]: logs   |
@@ -14,8 +18,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-The macOS Unified Logging Receiver collects logs from macOS systems using the native `log` command. This receiver supports both live system logs and archived log files (`.logarchive`).
-
 ## Requirements
 
 - macOS 10.12 (Sierra) or later
diff --git a/receiver/macosunifiedloggingreceiver/metadata.yaml b/receiver/macosunifiedloggingreceiver/metadata.yaml
@@ -1,5 +1,10 @@
+display_name: macOS Unified Logging Receiver
 type: macosunifiedlogging
 
+description: |
+  The macOS Unified Logging Receiver collects logs from macOS systems using the native `log` command. This receiver
+  supports both live system logs and archived log files (`.logarchive`).
+
 status:
   class: receiver
   stability:
diff --git a/receiver/memcachedreceiver/README.md b/receiver/memcachedreceiver/README.md
@@ -1,6 +1,12 @@
+<!-- status autogenerated section -->
 # Memcached Receiver
 
-<!-- status autogenerated section -->
+This receiver can fetch stats from a Memcached instance using the [stats
+command](https://github.com/memcached/memcached/wiki/Commands#statistics). A
+detailed description of all the stats available is at
+https://github.com/memcached/memcached/blob/master/doc/protocol.txt#L1159.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [beta]: metrics   |
@@ -14,13 +20,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 Memcached instance using the [stats
-command](https://github.com/memcached/memcached/wiki/Commands#statistics). A
-detailed description of all the stats available is at
-https://github.com/memcached/memcached/blob/master/doc/protocol.txt#L1159.
-
-## Details
-
 ## Configuration
 
 The following settings are required:
diff --git a/receiver/memcachedreceiver/metadata.yaml b/receiver/memcachedreceiver/metadata.yaml
@@ -1,5 +1,12 @@
+display_name: Memcached Receiver
 type: memcached
 
+description: |
+  This receiver can fetch stats from a Memcached instance using the [stats
+  command](https://github.com/memcached/memcached/wiki/Commands#statistics). A
+  detailed description of all the stats available is at
+  https://github.com/memcached/memcached/blob/master/doc/protocol.txt#L1159.
+
 status:
   class: receiver
   stability:
diff --git a/receiver/mongodbatlasreceiver/README.md b/receiver/mongodbatlasreceiver/README.md
@@ -1,6 +1,12 @@
+<!-- status autogenerated section -->
 # MongoDB Atlas Receiver
 
-<!-- status autogenerated section -->
+The MongoDB Atlas Receiver receives metrics from [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) 
+via their [monitoring APIs](https://docs.atlas.mongodb.com/reference/api/monitoring-and-logs/),
+as well as alerts via a configured [webhook](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/)
+and events from [events APIs](https://www.mongodb.com/docs/atlas/reference/api/events/).
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [beta]: metrics, logs   |
@@ -13,11 +19,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-Receives metrics from [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) 
-via their [monitoring APIs](https://docs.atlas.mongodb.com/reference/api/monitoring-and-logs/),
-as well as alerts via a configured [webhook](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/)
-and events from [events APIs](https://www.mongodb.com/docs/atlas/reference/api/events/).
-
 ## Getting Started
 
 The MongoDB Atlas receiver takes the following parameters. `public_key` and 
diff --git a/receiver/mongodbatlasreceiver/metadata.yaml b/receiver/mongodbatlasreceiver/metadata.yaml
@@ -1,5 +1,12 @@
+display_name: MongoDB Atlas Receiver
 type: mongodb_atlas
 
+description: |
+  The MongoDB Atlas Receiver receives metrics from [MongoDB Atlas](https://www.mongodb.com/cloud/atlas) 
+  via their [monitoring APIs](https://docs.atlas.mongodb.com/reference/api/monitoring-and-logs/),
+  as well as alerts via a configured [webhook](https://www.mongodb.com/docs/atlas/tutorial/third-party-service-integrations/)
+  and events from [events APIs](https://www.mongodb.com/docs/atlas/reference/api/events/).
+
 status:
   class: receiver
   stability:
diff --git a/receiver/mongodbreceiver/README.md b/receiver/mongodbreceiver/README.md
@@ -1,6 +1,11 @@
+<!-- status autogenerated section -->
 # MongoDB Receiver
 
-<!-- status autogenerated section -->
+This receiver fetches stats from a MongoDB instance using the 
+[golang mongo driver](https://github.com/mongodb/mongo-go-driver). Stats are collected via MongoDB's `dbStats` and
+`serverStatus` commands.
+
+
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [beta]: metrics   |
@@ -13,10 +18,6 @@
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
 <!-- end autogenerated section -->
 
-This receiver fetches stats from a MongoDB instance using the [golang
-mongo driver](https://github.com/mongodb/mongo-go-driver). Stats are collected
-via MongoDB's `dbStats` and `serverStatus` commands.
-
 ## Purpose
 
 The purpose of this receiver is to allow users to monitor metrics from standalone MongoDB clusters. This includes non-Atlas managed MongoDB Servers.
diff --git a/receiver/mongodbreceiver/metadata.yaml b/receiver/mongodbreceiver/metadata.yaml
@@ -1,5 +1,11 @@
+display_name: MongoDB Receiver
 type: mongodb
 
+description: |
+  This receiver fetches stats from a MongoDB instance using the 
+  [golang mongo driver](https://github.com/mongodb/mongo-go-driver). Stats are collected via MongoDB's `dbStats` and
+  `serverStatus` commands.
+
 status:
   class: receiver
   stability:
diff --git a/receiver/mysqlreceiver/README.md b/receiver/mysqlreceiver/README.md
@@ -1,6 +1,5 @@
-# MySQL Receiver
-
 <!-- status autogenerated section -->
+# MySQL Receiver
 | Status        |           |
 | ------------- |-----------|
 | Stability     | [development]: logs   |
@@ -19,7 +18,7 @@
 This receiver queries MySQL's global status and InnoDB tables.
 
 Some metrics will not appear if their corresponding feature is inactive.  
-There are also optional metrics that you must specify in your configuration to collect,  listed in [documentation.md](./documentation.md) 
+There are also optional metrics that you must specify in your configuration to collect, listed in [documentation.md](./documentation.md) 
 
 ## Prerequisites
 
diff --git a/receiver/mysqlreceiver/metadata.yaml b/receiver/mysqlreceiver/metadata.yaml
@@ -1,3 +1,4 @@
+display_name: MySQL Receiver
 type: mysql
 
 status:
