From 20ae511cea84bc676b23d9978e80d633d40531d5 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Fri, 5 May 2023 15:53:52 -0700 Subject: [PATCH] [receiver/nginx] use generated status header This PR updates the component to generate the status table using mdatagen. Questions to the code owners: Does this component require any of the standard warnings? See list: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/standard-warnings.md See related issue: https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/19172 Signed-off-by: Alex Boten --- receiver/nginxreceiver/README.md | 17 +++++++++-------- receiver/nginxreceiver/factory.go | 5 ++--- .../internal/metadata/generated_status.go | 12 ++++++++++++ receiver/nginxreceiver/metadata.yaml | 6 ++++++ 4 files changed, 29 insertions(+), 11 deletions(-) create mode 100644 receiver/nginxreceiver/internal/metadata/generated_status.go diff --git a/receiver/nginxreceiver/README.md b/receiver/nginxreceiver/README.md index ab97f3dd2a2f..3a1fb9769bb4 100644 --- a/receiver/nginxreceiver/README.md +++ b/receiver/nginxreceiver/README.md @@ -1,10 +1,14 @@ # Nginx Receiver -| Status | | -| ------------------------ |-----------| -| Stability | [beta] | -| Supported pipeline types | metrics | -| Distributions | [contrib] | + +| Status | | +| ------------- |-----------| +| Stability | [beta]: metrics | +| Distributions | [contrib] | + +[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta +[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib + This receiver can fetch stats from a Nginx instance using a mod_status endpoint. @@ -46,6 +50,3 @@ receivers: The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). - -[beta]:https://github.com/open-telemetry/opentelemetry-collector#beta -[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib diff --git a/receiver/nginxreceiver/factory.go b/receiver/nginxreceiver/factory.go index 00c9e76ecabd..abfc931d1ec8 100644 --- a/receiver/nginxreceiver/factory.go +++ b/receiver/nginxreceiver/factory.go @@ -28,8 +28,7 @@ import ( ) const ( - typeStr = "nginx" - stability = component.StabilityLevelBeta + typeStr = "nginx" ) // NewFactory creates a factory for nginx receiver. @@ -37,7 +36,7 @@ func NewFactory() receiver.Factory { return receiver.NewFactory( typeStr, createDefaultConfig, - receiver.WithMetrics(createMetricsReceiver, stability)) + receiver.WithMetrics(createMetricsReceiver, metadata.MetricsStability)) } func createDefaultConfig() component.Config { diff --git a/receiver/nginxreceiver/internal/metadata/generated_status.go b/receiver/nginxreceiver/internal/metadata/generated_status.go new file mode 100644 index 000000000000..da1e99085123 --- /dev/null +++ b/receiver/nginxreceiver/internal/metadata/generated_status.go @@ -0,0 +1,12 @@ +// Code generated by mdatagen. DO NOT EDIT. + +package metadata + +import ( + "go.opentelemetry.io/collector/component" +) + +const ( + Type = "nginxreceiver" + MetricsStability = component.StabilityLevelBeta +) diff --git a/receiver/nginxreceiver/metadata.yaml b/receiver/nginxreceiver/metadata.yaml index 253ac22d7ba7..6426cd0e885a 100644 --- a/receiver/nginxreceiver/metadata.yaml +++ b/receiver/nginxreceiver/metadata.yaml @@ -1,5 +1,11 @@ type: nginxreceiver +status: + class: receiver + stability: + beta: [metrics] + distributions: [contrib] + attributes: state: description: The state of a connection