diff --git a/receiver/postgresqlreceiver/README.md b/receiver/postgresqlreceiver/README.md index 834e273dc8b67..b936efafbc45e 100644 --- a/receiver/postgresqlreceiver/README.md +++ b/receiver/postgresqlreceiver/README.md @@ -1,6 +1,9 @@ + # PostgreSQL Receiver - +This receiver queries the PostgreSQL [statistics collector](https://www.postgresql.org/docs/13/monitoring-stats.html). + + | Status | | | ------------- |-----------| | Stability | [development]: logs | @@ -16,8 +19,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -This receiver queries the PostgreSQL [statistics collector](https://www.postgresql.org/docs/13/monitoring-stats.html). - ## Prerequisites See PostgreSQL documentation for [supported versions](https://www.postgresql.org/support/versioning). diff --git a/receiver/postgresqlreceiver/metadata.yaml b/receiver/postgresqlreceiver/metadata.yaml index 6ebeec8a7bfb2..f1073ef2a4de9 100644 --- a/receiver/postgresqlreceiver/metadata.yaml +++ b/receiver/postgresqlreceiver/metadata.yaml @@ -1,5 +1,9 @@ +display_name: PostgreSQL Receiver type: postgresql +description: | + This receiver queries the PostgreSQL [statistics collector](https://www.postgresql.org/docs/13/monitoring-stats.html). + status: class: receiver stability: diff --git a/receiver/pprofreceiver/README.md b/receiver/pprofreceiver/README.md index 8d3c345c338ee..11bdd685d879e 100644 --- a/receiver/pprofreceiver/README.md +++ b/receiver/pprofreceiver/README.md @@ -1,6 +1,9 @@ + # Pprof Receiver - +The Pprof Receiver collects profiles from files specified with a glob pattern. + + | Status | | | ------------- |-----------| | Stability | [development]: profiles | @@ -12,8 +15,6 @@ [development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development -Collects profiles from files specified with a glob pattern. - ## Configuration - `include` (required): The glob path for files to watch - `collection_interval` (default = `1m`): The interval at which metrics are emitted by this receiver. diff --git a/receiver/pprofreceiver/metadata.yaml b/receiver/pprofreceiver/metadata.yaml index fe4953f440487..63492707b90de 100644 --- a/receiver/pprofreceiver/metadata.yaml +++ b/receiver/pprofreceiver/metadata.yaml @@ -1,5 +1,9 @@ +display_name: Pprof Receiver type: pprof +description: | + The Pprof Receiver collects profiles from files specified with a glob pattern. + status: class: receiver stability: diff --git a/receiver/prometheusreceiver/README.md b/receiver/prometheusreceiver/README.md index d715984800b3e..883d31ab57f05 100644 --- a/receiver/prometheusreceiver/README.md +++ b/receiver/prometheusreceiver/README.md @@ -1,6 +1,9 @@ + # Prometheus Receiver - +The Prometheus Receiver receives metric data in [Prometheus](https://prometheus.io/) format. + + | Status | | | ------------- |-----------| | Stability | [beta]: metrics | @@ -15,8 +18,7 @@ [k8s]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s -Receives metric data in [Prometheus](https://prometheus.io/) format. See the -[Design](DESIGN.md) for additional information on this receiver. +See the [Design](DESIGN.md) for additional information on this receiver. ## ⚠️ Warning diff --git a/receiver/prometheusreceiver/metadata.yaml b/receiver/prometheusreceiver/metadata.yaml index af267c9b56313..0e299a30b9c59 100644 --- a/receiver/prometheusreceiver/metadata.yaml +++ b/receiver/prometheusreceiver/metadata.yaml @@ -1,5 +1,9 @@ +display_name: Prometheus Receiver type: prometheus +description: | + The Prometheus Receiver receives metric data in [Prometheus](https://prometheus.io/) format. + status: class: receiver stability: diff --git a/receiver/prometheusremotewritereceiver/README.md b/receiver/prometheusremotewritereceiver/README.md index 5c48ddd5cc747..6bff66f25338a 100644 --- a/receiver/prometheusremotewritereceiver/README.md +++ b/receiver/prometheusremotewritereceiver/README.md @@ -1,6 +1,10 @@ + # Prometheus Remote Write Receiver - +This receiver implements the +[Prometheus Remote Write 2.0 protocol](https://prometheus.io/docs/specs/prw/remote_write_spec_2_0/). + + | Status | | | ------------- |-----------| | Stability | [alpha]: metrics | @@ -15,7 +19,8 @@ ## Prometheus Compatibility -This receiver implements the [Prometheus Remote Write 2.0 protocol](https://prometheus.io/docs/specs/prw/remote_write_spec_2_0/), which is still evolving. As the protocol specification changes, we update our implementation to match, which can affect compatibility with different Prometheus versions. +The [Prometheus Remote Write 2.0 protocol](https://prometheus.io/docs/specs/prw/remote_write_spec_2_0/) is still evolving. +As the protocol specification changes, we update our implementation to match, which can affect compatibility with different Prometheus versions. | OTel Collector Contrib Version | Compatible Prometheus Versions | |-------------------------------|-------------------------------| diff --git a/receiver/prometheusremotewritereceiver/metadata.yaml b/receiver/prometheusremotewritereceiver/metadata.yaml index c713f86217283..e1e19eca86053 100644 --- a/receiver/prometheusremotewritereceiver/metadata.yaml +++ b/receiver/prometheusremotewritereceiver/metadata.yaml @@ -1,5 +1,10 @@ +display_name: Prometheus Remote Write Receiver type: prometheusremotewrite +description: | + This receiver implements the + [Prometheus Remote Write 2.0 protocol](https://prometheus.io/docs/specs/prw/remote_write_spec_2_0/). + status: class: receiver stability: diff --git a/receiver/pulsarreceiver/README.md b/receiver/pulsarreceiver/README.md index 36f3ae0f2e42b..f1a1f1484268d 100644 --- a/receiver/pulsarreceiver/README.md +++ b/receiver/pulsarreceiver/README.md @@ -1,6 +1,9 @@ + # Pulsar Receiver - +The Pulsar Receiver receives logs, metrics, and traces from [Apache Pulsar](https://pulsar.apache.org/). + + | Status | | | ------------- |-----------| | Stability | [alpha]: metrics, traces, logs | @@ -14,8 +17,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -Pulsar receiver receives logs, metrics, and traces from [Apache Pulsar](https://pulsar.apache.org/). - ## Getting Started The following settings can be optionally configured: diff --git a/receiver/pulsarreceiver/metadata.yaml b/receiver/pulsarreceiver/metadata.yaml index 62fed2e6d9633..a4b43da58d5eb 100644 --- a/receiver/pulsarreceiver/metadata.yaml +++ b/receiver/pulsarreceiver/metadata.yaml @@ -1,5 +1,9 @@ +display_name: Pulsar Receiver type: pulsar +description: | + The Pulsar Receiver receives logs, metrics, and traces from [Apache Pulsar](https://pulsar.apache.org/). + status: class: receiver stability: diff --git a/receiver/purefareceiver/README.md b/receiver/purefareceiver/README.md index a8eb30fb3b273..027fb49da1f43 100644 --- a/receiver/purefareceiver/README.md +++ b/receiver/purefareceiver/README.md @@ -1,6 +1,9 @@ + # Pure Storage FlashArray Receiver - +The Pure Storage FlashArray Receiver receives metrics from the Pure Storage FlashArray. + + | Status | | | ------------- |-----------| | Stability | [alpha]: metrics | @@ -14,8 +17,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -The Pure Storage FlashArray receiver, receives metrics from the Pure Storage FlashArray. - ## Configuration The following settings are required: diff --git a/receiver/purefareceiver/metadata.yaml b/receiver/purefareceiver/metadata.yaml index 05f50f3f958f6..b97c3a37aa3ff 100644 --- a/receiver/purefareceiver/metadata.yaml +++ b/receiver/purefareceiver/metadata.yaml @@ -1,5 +1,9 @@ +display_name: Pure Storage FlashArray Receiver type: purefa +description: | + The Pure Storage FlashArray Receiver receives metrics from the Pure Storage FlashArray. + status: class: receiver stability: diff --git a/receiver/purefbreceiver/README.md b/receiver/purefbreceiver/README.md index 28beb793daba8..0ee7ba0533685 100644 --- a/receiver/purefbreceiver/README.md +++ b/receiver/purefbreceiver/README.md @@ -1,6 +1,10 @@ + # Pure Storage FlashBlade Receiver - +The Pure Storage FlashBlade receiver, receives metrics from Pure Storage FlashBlade via the +[Pure Storage FlashBlade OpenMetrics Exporter](https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter) + + | Status | | | ------------- |-----------| | Stability | [alpha]: metrics | @@ -14,8 +18,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -The Pure Storage FlashBlade receiver, receives metrics from Pure Storage FlashBlade via the [Pure Storage FlashBlade OpenMetrics Exporter](https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter) - ## Configuration The following settings are required: diff --git a/receiver/purefbreceiver/metadata.yaml b/receiver/purefbreceiver/metadata.yaml index 71f985a1a8f6d..700caee30be91 100644 --- a/receiver/purefbreceiver/metadata.yaml +++ b/receiver/purefbreceiver/metadata.yaml @@ -1,5 +1,11 @@ +display_name: Pure Storage FlashBlade Receiver type: purefb +description: | + The Pure Storage FlashBlade receiver, receives metrics from Pure Storage FlashBlade via the + [Pure Storage FlashBlade OpenMetrics Exporter](https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter) + + status: class: receiver stability: diff --git a/receiver/rabbitmqreceiver/README.md b/receiver/rabbitmqreceiver/README.md index a61d03c1738f7..a5a6417d81599 100644 --- a/receiver/rabbitmqreceiver/README.md +++ b/receiver/rabbitmqreceiver/README.md @@ -1,6 +1,9 @@ + # RabbitMQ Receiver - +This receiver fetches stats from a RabbitMQ node using the [RabbitMQ Management Plugin](https://www.rabbitmq.com/management.html). + + | Status | | | ------------- |-----------| | Stability | [beta]: metrics | @@ -14,8 +17,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -This receiver fetches stats from a RabbitMQ node using the [RabbitMQ Management Plugin](https://www.rabbitmq.com/management.html). - ## Prerequisites This receiver supports RabbitMQ versions `3.8` and `3.9`. diff --git a/receiver/rabbitmqreceiver/metadata.yaml b/receiver/rabbitmqreceiver/metadata.yaml index 240f5d4361974..3c3b00ed6804e 100644 --- a/receiver/rabbitmqreceiver/metadata.yaml +++ b/receiver/rabbitmqreceiver/metadata.yaml @@ -1,5 +1,9 @@ +display_name: RabbitMQ Receiver type: rabbitmq +description: | + This receiver fetches stats from a RabbitMQ node using the [RabbitMQ Management Plugin](https://www.rabbitmq.com/management.html). + tests: # generated_component_test.go looking for test.config from metadata.yaml config: endpoint: "http://localhost:15672" diff --git a/receiver/receivercreator/README.md b/receiver/receivercreator/README.md index ce6fde1578c54..eba9f3ad551b3 100644 --- a/receiver/receivercreator/README.md +++ b/receiver/receivercreator/README.md @@ -1,6 +1,9 @@ + # Receiver Creator - +This receiver can instantiate other receivers at runtime based on whether observed endpoints match a configured rule. + + | Status | | | ------------- |-----------| | Stability | [alpha]: logs, traces | @@ -17,9 +20,7 @@ [k8s]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s -This receiver can instantiate other receivers at runtime based on whether -observed endpoints match a configured rule. To use the receiver creator, you -must first configure one or more +To use the receiver creator, you must first configure one or more [observers](../../extension/observer/README.md) that will discover networked endpoints that you may be interested in. The configured rules will be evaluated for each endpoint discovered. If the rule evaluates to true then diff --git a/receiver/receivercreator/metadata.yaml b/receiver/receivercreator/metadata.yaml index c8602a16b727b..f06efc91806dd 100644 --- a/receiver/receivercreator/metadata.yaml +++ b/receiver/receivercreator/metadata.yaml @@ -1,5 +1,9 @@ +display_name: Receiver Creator type: receiver_creator +description: | + This receiver can instantiate other receivers at runtime based on whether observed endpoints match a configured rule. + status: class: receiver stability: diff --git a/receiver/redfishreceiver/README.md b/receiver/redfishreceiver/README.md index cd322a0b2ae31..d612fc24b6ae7 100644 --- a/receiver/redfishreceiver/README.md +++ b/receiver/redfishreceiver/README.md @@ -1,6 +1,10 @@ + # Redfish Receiver - +This receiver fetches metrics for a server running a [Redfish](https://en.wikipedia.org/wiki/Redfish_(specification)) +API. + + | Status | | | ------------- |-----------| | Stability | [development]: metrics | @@ -12,8 +16,6 @@ [development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development -This receiver fetches metrics for a server running a [Redfish](https://en.wikipedia.org/wiki/Redfish_(specification)) API. - ## Purpose The purpose of this component is to monitor devices running a Redfish API which is quite often a BMC (Baseboard Management Controller) such as; Dell iDRAC, HPE iLO, etc. diff --git a/receiver/redfishreceiver/metadata.yaml b/receiver/redfishreceiver/metadata.yaml index 212797d0b2859..b2dd477f6baa5 100644 --- a/receiver/redfishreceiver/metadata.yaml +++ b/receiver/redfishreceiver/metadata.yaml @@ -1,5 +1,10 @@ +display_name: Redfish Receiver type: redfish +description: | + This receiver fetches metrics for a server running a [Redfish](https://en.wikipedia.org/wiki/Redfish_(specification)) + API. + status: class: receiver stability: diff --git a/receiver/redisreceiver/README.md b/receiver/redisreceiver/README.md index 89aa9fe636686..37479e07acb5b 100644 --- a/receiver/redisreceiver/README.md +++ b/receiver/redisreceiver/README.md @@ -1,6 +1,11 @@ + # Redis Receiver - +The Redis Receiver is designed to retrieve Redis INFO data from a single Redis +instance, build metrics from that data, and send them to the next consumer at a +configurable interval. + + | Status | | | ------------- |-----------| | Stability | [beta]: metrics | @@ -13,10 +18,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -The Redis receiver is designed to retrieve Redis INFO data from a single Redis -instance, build metrics from that data, and send them to the next consumer at a -configurable interval. - ## Details The Redis INFO command returns information and statistics about a Redis diff --git a/receiver/redisreceiver/metadata.yaml b/receiver/redisreceiver/metadata.yaml index 39c113026559b..b2e8b5cf6ad44 100644 --- a/receiver/redisreceiver/metadata.yaml +++ b/receiver/redisreceiver/metadata.yaml @@ -1,5 +1,11 @@ +display_name: Redis Receiver type: redis +description: | + The Redis Receiver is designed to retrieve Redis INFO data from a single Redis + instance, build metrics from that data, and send them to the next consumer at a + configurable interval. + reaggregation_enabled: true status: diff --git a/receiver/riakreceiver/README.md b/receiver/riakreceiver/README.md index ef0032583ba60..3ccbb3e3a0a13 100644 --- a/receiver/riakreceiver/README.md +++ b/receiver/riakreceiver/README.md @@ -1,6 +1,5 @@ -# Riak Receiver - +# Riak Receiver | Status | | | ------------- |-----------| | Stability | [beta]: metrics | diff --git a/receiver/riakreceiver/metadata.yaml b/receiver/riakreceiver/metadata.yaml index 2c5d3aacbd417..2f79abeb80e5d 100644 --- a/receiver/riakreceiver/metadata.yaml +++ b/receiver/riakreceiver/metadata.yaml @@ -1,3 +1,4 @@ +display_name: Riak Receiver type: riak status: