diff --git a/receiver/flinkmetricsreceiver/README.md b/receiver/flinkmetricsreceiver/README.md index 8ee0281e87eb3..555fdfc6926bd 100644 --- a/receiver/flinkmetricsreceiver/README.md +++ b/receiver/flinkmetricsreceiver/README.md @@ -1,6 +1,10 @@ + # FlinkMetrics Receiver - +This receiver uses Flink's [REST API](https://nightlies.apache.org/flink/flink-docs-release-1.14/docs/ops/metrics/#rest-api-integration) +to collect Jobmanager, Taskmanager, Job, Task and Operator metrics. + + | Status | | | ------------- |-----------| | Stability | [alpha]: metrics | @@ -13,8 +17,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -This receiver uses Flink's [REST API](https://nightlies.apache.org/flink/flink-docs-release-1.14/docs/ops/metrics/#rest-api-integration) to collect Jobmanager, Taskmanager, Job, Task and Operator metrics. - ## Prerequisites This receiver supports Apache Flink versions `1.13.6` and `1.14.4`. diff --git a/receiver/flinkmetricsreceiver/metadata.yaml b/receiver/flinkmetricsreceiver/metadata.yaml index 0723469236fbf..29b9897cb59a1 100644 --- a/receiver/flinkmetricsreceiver/metadata.yaml +++ b/receiver/flinkmetricsreceiver/metadata.yaml @@ -1,5 +1,10 @@ +display_name: FlinkMetrics Receiver type: flinkmetrics +description: | + This receiver uses Flink's [REST API](https://nightlies.apache.org/flink/flink-docs-release-1.14/docs/ops/metrics/#rest-api-integration) + to collect Jobmanager, Taskmanager, Job, Task and Operator metrics. + status: class: receiver stability: diff --git a/receiver/fluentforwardreceiver/README.md b/receiver/fluentforwardreceiver/README.md index 4dfbfd34b991a..d9196ab443934 100644 --- a/receiver/fluentforwardreceiver/README.md +++ b/receiver/fluentforwardreceiver/README.md @@ -1,6 +1,10 @@ + # Fluent Forward Receiver - +This receiver runs a TCP server that accepts events via the +[Fluent Forward protocol](https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1). + + | Status | | | ------------- |-----------| | Stability | [beta]: logs | @@ -14,9 +18,6 @@ [k8s]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s -This receiver runs a TCP server that accepts events via the [Fluent Forward -protocol](https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1). - This receiver: - Does **not** support TLS or the handshake portion of the Forward protocol. diff --git a/receiver/fluentforwardreceiver/metadata.yaml b/receiver/fluentforwardreceiver/metadata.yaml index 82a3306c73186..4fa335e11dc76 100644 --- a/receiver/fluentforwardreceiver/metadata.yaml +++ b/receiver/fluentforwardreceiver/metadata.yaml @@ -1,5 +1,10 @@ +display_name: Fluent Forward Receiver type: fluentforward +description: | + This receiver runs a TCP server that accepts events via the + [Fluent Forward protocol](https://github.com/fluent/fluentd/wiki/Forward-Protocol-Specification-v1). + status: class: receiver stability: diff --git a/receiver/githubreceiver/README.md b/receiver/githubreceiver/README.md index 8c41ecf088201..e399423c2a4e5 100644 --- a/receiver/githubreceiver/README.md +++ b/receiver/githubreceiver/README.md @@ -1,6 +1,5 @@ -# GitHub Receiver - +# GitHub Receiver | Status | | | ------------- |-----------| | Stability | [development]: traces | diff --git a/receiver/githubreceiver/metadata.yaml b/receiver/githubreceiver/metadata.yaml index ce54d19fb8a5e..ac7628b08528f 100644 --- a/receiver/githubreceiver/metadata.yaml +++ b/receiver/githubreceiver/metadata.yaml @@ -1,3 +1,4 @@ +display_name: GitHub Receiver type: github sem_conv_version: 1.38.0 diff --git a/receiver/gitlabreceiver/README.md b/receiver/gitlabreceiver/README.md index dcf99eb28c583..6b1dcbda9887d 100644 --- a/receiver/gitlabreceiver/README.md +++ b/receiver/gitlabreceiver/README.md @@ -1,6 +1,5 @@ -# GitLab Receiver - +# GitLab Receiver | Status | | | ------------- |-----------| | Stability | [alpha]: traces | diff --git a/receiver/gitlabreceiver/metadata.yaml b/receiver/gitlabreceiver/metadata.yaml index d502e8adea012..24588a6b441d6 100644 --- a/receiver/gitlabreceiver/metadata.yaml +++ b/receiver/gitlabreceiver/metadata.yaml @@ -1,3 +1,4 @@ +display_name: GitLab Receiver type: gitlab status: diff --git a/receiver/googlecloudmonitoringreceiver/README.md b/receiver/googlecloudmonitoringreceiver/README.md index fe0d614af35be..cd7b66cfe85c0 100644 --- a/receiver/googlecloudmonitoringreceiver/README.md +++ b/receiver/googlecloudmonitoringreceiver/README.md @@ -1,6 +1,10 @@ + # Google Cloud Monitoring Receiver - +The primary objective of the Google Cloud Monitoring Receiver is to gather time series metrics data from all Google +services and convert this data into a pipeline format that facilitates further use. + + | Status | | | ------------- |-----------| | Stability | [alpha]: metrics | @@ -14,8 +18,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -The primary objective of the Google Cloud Monitoring Receiver is to gather time series metrics data from all Google services and convert this data into a pipeline format that facilitates further use. - This receiver gets GCP (Google Cloud Platform) metrics from [GCP Monitoring REST API] via the [Google SDK for GCP Metrics] and then convert those timeseries data into OTel Format [Pipeline Data]. [GCP Monitoring REST API]: https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list diff --git a/receiver/googlecloudmonitoringreceiver/metadata.yaml b/receiver/googlecloudmonitoringreceiver/metadata.yaml index c89ad4afe10f6..d4754a20e0ac6 100644 --- a/receiver/googlecloudmonitoringreceiver/metadata.yaml +++ b/receiver/googlecloudmonitoringreceiver/metadata.yaml @@ -1,5 +1,11 @@ +display_name: Google Cloud Monitoring Receiver type: googlecloudmonitoring +description: | + The primary objective of the Google Cloud Monitoring Receiver is to gather time series metrics data from all Google + services and convert this data into a pipeline format that facilitates further use. + + status: class: receiver stability: diff --git a/receiver/googlecloudpubsubpushreceiver/README.md b/receiver/googlecloudpubsubpushreceiver/README.md index fa69c9b89e370..ae1bb77a36fea 100644 --- a/receiver/googlecloudpubsubpushreceiver/README.md +++ b/receiver/googlecloudpubsubpushreceiver/README.md @@ -1,6 +1,5 @@ -# Google Pub Sub Push Receiver - +# Google Pub/Sub Push Receiver | Status | | | ------------- |-----------| | Stability | [development]: logs | diff --git a/receiver/googlecloudpubsubpushreceiver/metadata.yaml b/receiver/googlecloudpubsubpushreceiver/metadata.yaml index cfdbe8ea23efe..10f218591196d 100644 --- a/receiver/googlecloudpubsubpushreceiver/metadata.yaml +++ b/receiver/googlecloudpubsubpushreceiver/metadata.yaml @@ -1,3 +1,4 @@ +display_name: Google Pub/Sub Push Receiver type: googlecloudpubsubpush status: diff --git a/receiver/googlecloudpubsubreceiver/README.md b/receiver/googlecloudpubsubreceiver/README.md index e881e967b4d51..26b95c208e9a3 100644 --- a/receiver/googlecloudpubsubreceiver/README.md +++ b/receiver/googlecloudpubsubreceiver/README.md @@ -1,6 +1,9 @@ -# Google Pubsub Receiver - +# Google Pub/Sub Receiver + +This receiver gets OTLP messages from a Google Cloud [Pubsub](https://cloud.google.com/pubsub) subscription. + + | Status | | | ------------- |-----------| | Stability | [beta]: traces, logs, metrics | @@ -15,8 +18,6 @@ > ⚠️ This is a community-provided module. It has been developed and extensively tested at Collibra, but it is not officially supported by GCP. -This receiver gets OTLP messages from a Google Cloud [Pubsub](https://cloud.google.com/pubsub) subscription. - The following configuration options are supported: * `project` (Optional): The Google Cloud Project of the client connects to. diff --git a/receiver/googlecloudpubsubreceiver/metadata.yaml b/receiver/googlecloudpubsubreceiver/metadata.yaml index 6faa6f0c421b5..84b7723fb6885 100644 --- a/receiver/googlecloudpubsubreceiver/metadata.yaml +++ b/receiver/googlecloudpubsubreceiver/metadata.yaml @@ -1,5 +1,9 @@ +display_name: Google Pub/Sub Receiver type: googlecloudpubsub +description: | + This receiver gets OTLP messages from a Google Cloud [Pubsub](https://cloud.google.com/pubsub) subscription. + status: class: receiver stability: diff --git a/receiver/googlecloudspannerreceiver/README.md b/receiver/googlecloudspannerreceiver/README.md index 3103cd2fd9ec4..fea6e485b38ea 100644 --- a/receiver/googlecloudspannerreceiver/README.md +++ b/receiver/googlecloudspannerreceiver/README.md @@ -1,6 +1,5 @@ -# Google Cloud Spanner Receiver - +# Google Cloud Spanner Receiver | Status | | | ------------- |-----------| | Stability | [beta]: metrics | diff --git a/receiver/googlecloudspannerreceiver/metadata.yaml b/receiver/googlecloudspannerreceiver/metadata.yaml index 6e2a43e66a17b..f9375a38a9ec1 100644 --- a/receiver/googlecloudspannerreceiver/metadata.yaml +++ b/receiver/googlecloudspannerreceiver/metadata.yaml @@ -1,3 +1,4 @@ +display_name: Google Cloud Spanner Receiver type: googlecloudspanner status: diff --git a/receiver/haproxyreceiver/README.md b/receiver/haproxyreceiver/README.md index a4c564db26634..7f356e5f33942 100644 --- a/receiver/haproxyreceiver/README.md +++ b/receiver/haproxyreceiver/README.md @@ -1,6 +1,9 @@ + # HAProxy Receiver - +The HAProxy receiver generates metrics by polling periodically the HAProxy process through a dedicated socket or HTTP URL. + + | Status | | | ------------- |-----------| | Stability | [beta]: metrics | @@ -13,8 +16,6 @@ [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib -The HAProxy receiver generates metrics by polling periodically the HAProxy process through a dedicated socket or HTTP URL. - ## Getting Started ## Configuration diff --git a/receiver/haproxyreceiver/metadata.yaml b/receiver/haproxyreceiver/metadata.yaml index 78494e124c66e..779f75b3eac79 100644 --- a/receiver/haproxyreceiver/metadata.yaml +++ b/receiver/haproxyreceiver/metadata.yaml @@ -1,5 +1,9 @@ +display_name: HAProxy Receiver type: haproxy +description: | + The HAProxy receiver generates metrics by polling periodically the HAProxy process through a dedicated socket or HTTP URL. + status: class: receiver stability: diff --git a/receiver/hostmetricsreceiver/README.md b/receiver/hostmetricsreceiver/README.md index fce21572ee80e..f96276f9be010 100644 --- a/receiver/hostmetricsreceiver/README.md +++ b/receiver/hostmetricsreceiver/README.md @@ -1,6 +1,11 @@ + # Host Metrics Receiver - +The Host Metrics receiver generates metrics about the host system scraped +from various sources and host entity event as log. This is intended to be +used when the collector is deployed as an agent. + + | Status | | | ------------- |-----------| | Stability | [development]: logs | @@ -17,10 +22,6 @@ [k8s]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s -The Host Metrics receiver generates metrics about the host system scraped -from various sources and host entity event as log. This is intended to be -used when the collector is deployed as an agent. - ## Getting Started The collection interval, root path, the categories of metrics, and individual diff --git a/receiver/hostmetricsreceiver/metadata.yaml b/receiver/hostmetricsreceiver/metadata.yaml index 38f5bf3ba8890..56f7d5fade760 100644 --- a/receiver/hostmetricsreceiver/metadata.yaml +++ b/receiver/hostmetricsreceiver/metadata.yaml @@ -1,5 +1,11 @@ +display_name: Host Metrics Receiver type: hostmetrics +description: | + The Host Metrics receiver generates metrics about the host system scraped + from various sources and host entity event as log. This is intended to be + used when the collector is deployed as an agent. + status: class: receiver stability: diff --git a/receiver/httpcheckreceiver/README.md b/receiver/httpcheckreceiver/README.md index c511617c32574..bc72f07ee8882 100644 --- a/receiver/httpcheckreceiver/README.md +++ b/receiver/httpcheckreceiver/README.md @@ -1,6 +1,9 @@ + # HTTP Check Receiver - +The HTTP Check Receiver can be used for synthetic checks against HTTP endpoints. + + | Status | | | ------------- |-----------| | Stability | [alpha]: metrics | @@ -15,7 +18,7 @@ [k8s]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-k8s -The HTTP Check Receiver can be used for synthetic checks against HTTP endpoints. This receiver will make a request to the specified `endpoint` using the +This receiver will make a request to the specified `endpoint` using the configured `method`. This scraper generates a metric with a label for each HTTP response status class with a value of `1` if the status code matches the class. For example, the following metrics will be generated if the endpoint returned a `200`: diff --git a/receiver/httpcheckreceiver/metadata.yaml b/receiver/httpcheckreceiver/metadata.yaml index 62f91a7049d79..157c6ff2e2702 100644 --- a/receiver/httpcheckreceiver/metadata.yaml +++ b/receiver/httpcheckreceiver/metadata.yaml @@ -1,5 +1,9 @@ +display_name: HTTP Check Receiver type: httpcheck +description: | + The HTTP Check Receiver can be used for synthetic checks against HTTP endpoints. + status: class: receiver stability: diff --git a/receiver/huaweicloudcesreceiver/README.md b/receiver/huaweicloudcesreceiver/README.md index 422f86f4a5305..a691484d3ef1b 100644 --- a/receiver/huaweicloudcesreceiver/README.md +++ b/receiver/huaweicloudcesreceiver/README.md @@ -1,6 +1,12 @@ + # Huawei Cloud CES Receiver - +This receiver contains the implementation of the Huawei Cloud +[Cloud Eye Service](https://www.huaweicloud.com/intl/en-us/product/ces.html) (CES) receiver for the OpenTelemetry +Collector. The receiver collects metrics from Huawei Cloud's CES service and sends them to the OpenTelemetry Collector +for processing and exporting. + + | Status | | | ------------- |-----------| | Stability | [alpha]: metrics | @@ -12,8 +18,6 @@ [alpha]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#alpha -This receiver contains the implementation of the Huawei Cloud [Cloud Eye Service](https://www.huaweicloud.com/intl/en-us/product/ces.html) (CES) receiver for the OpenTelemetry Collector. The receiver collects metrics from Huawei Cloud's CES service and sends them to the OpenTelemetry Collector for processing and exporting. - ## Configuration The following settings are required: diff --git a/receiver/huaweicloudcesreceiver/metadata.yaml b/receiver/huaweicloudcesreceiver/metadata.yaml index 8abc5d5c84df2..3adcfeab070a1 100644 --- a/receiver/huaweicloudcesreceiver/metadata.yaml +++ b/receiver/huaweicloudcesreceiver/metadata.yaml @@ -1,5 +1,13 @@ +display_name: Huawei Cloud CES Receiver type: huaweicloudcesreceiver +description: | + This receiver contains the implementation of the Huawei Cloud + [Cloud Eye Service](https://www.huaweicloud.com/intl/en-us/product/ces.html) (CES) receiver for the OpenTelemetry + Collector. The receiver collects metrics from Huawei Cloud's CES service and sends them to the OpenTelemetry Collector + for processing and exporting. + + status: class: receiver stability: