From f71fe2757f054dd36f97cdf01784f1429e053ec9 Mon Sep 17 00:00:00 2001 From: Antoine Toulme Date: Fri, 14 Feb 2025 03:00:42 -0800 Subject: [PATCH] [chore] fix metadata.yaml (#12387) #### Description fix metadata.yaml github_project, add a go:generate instruction to confmap and a banner to README --- confmap/README.md | 14 ++++++++++++-- confmap/confmap.go | 2 ++ .../{package_test.go => generated_package_test.go} | 3 +-- confmap/metadata.yaml | 7 +++++-- connector/xconnector/metadata.yaml | 1 + consumer/xconsumer/metadata.yaml | 1 + docs/rfcs/metadata.yaml | 1 + .../exporterhelper/xexporterhelper/metadata.yaml | 1 + exporter/xexporter/metadata.yaml | 1 + extension/xextension/metadata.yaml | 1 + pdata/pprofile/metadata.yaml | 1 + processor/processorhelper/metadata.yaml | 1 + processor/xprocessor/metadata.yaml | 1 + receiver/xreceiver/metadata.yaml | 1 + service/internal/graph/metadata.yaml | 1 + 15 files changed, 31 insertions(+), 6 deletions(-) rename confmap/{package_test.go => generated_package_test.go} (61%) diff --git a/confmap/README.md b/confmap/README.md index 40c6b1a40b..9a3f35fbda 100644 --- a/confmap/README.md +++ b/confmap/README.md @@ -1,6 +1,16 @@ -# High Level Design +# Confmap -This document is work in progress. + +| Status | | +| ------------- |-----------| +| Stability | [stable]: logs, metrics, traces | +| Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector?query=is%3Aissue%20is%3Aopen%20label%3Apkg%2Fconfmap%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector/issues?q=is%3Aopen+is%3Aissue+label%3Apkg%2Fconfmap) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector?query=is%3Aissue%20is%3Aclosed%20label%3Apkg%2Fconfmap%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector/issues?q=is%3Aclosed+is%3Aissue+label%3Apkg%2Fconfmap) | +| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@mx-psi](https://www.github.com/mx-psi), [@evan-bradley](https://www.github.com/evan-bradley) | + +[stable]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#stable + + +# High Level Design ## Conf diff --git a/confmap/confmap.go b/confmap/confmap.go index b60634ade6..3fac0c1462 100644 --- a/confmap/confmap.go +++ b/confmap/confmap.go @@ -1,6 +1,8 @@ // Copyright The OpenTelemetry Authors // SPDX-License-Identifier: Apache-2.0 +//go:generate mdatagen metadata.yaml + package confmap // import "go.opentelemetry.io/collector/confmap" import ( diff --git a/confmap/package_test.go b/confmap/generated_package_test.go similarity index 61% rename from confmap/package_test.go rename to confmap/generated_package_test.go index ad90b74890..2957869c00 100644 --- a/confmap/package_test.go +++ b/confmap/generated_package_test.go @@ -1,5 +1,4 @@ -// Copyright The OpenTelemetry Authors -// SPDX-License-Identifier: Apache-2.0 +// Code generated by mdatagen. DO NOT EDIT. package confmap diff --git a/confmap/metadata.yaml b/confmap/metadata.yaml index 9dbaf048e6..d250015098 100644 --- a/confmap/metadata.yaml +++ b/confmap/metadata.yaml @@ -1,8 +1,11 @@ -type: nop +type: confmap +github_project: open-telemetry/opentelemetry-collector status: codeowners: active: - mx-psi - evan-bradley - class: confmap + class: pkg + stability: + stable: [logs, metrics, traces] diff --git a/connector/xconnector/metadata.yaml b/connector/xconnector/metadata.yaml index 6b4b96842a..2a4e17b017 100644 --- a/connector/xconnector/metadata.yaml +++ b/connector/xconnector/metadata.yaml @@ -1,4 +1,5 @@ type: xconnector +github_project: open-telemetry/opentelemetry-collector status: class: connector diff --git a/consumer/xconsumer/metadata.yaml b/consumer/xconsumer/metadata.yaml index 8c35cb3340..2c7615d959 100644 --- a/consumer/xconsumer/metadata.yaml +++ b/consumer/xconsumer/metadata.yaml @@ -1,4 +1,5 @@ type: xconsumer +github_project: open-telemetry/opentelemetry-collector status: class: consumer diff --git a/docs/rfcs/metadata.yaml b/docs/rfcs/metadata.yaml index 63ff8aa81d..5ba4f01034 100644 --- a/docs/rfcs/metadata.yaml +++ b/docs/rfcs/metadata.yaml @@ -1,4 +1,5 @@ type: rfcs +github_project: open-telemetry/opentelemetry-collector status: class: docs diff --git a/exporter/exporterhelper/xexporterhelper/metadata.yaml b/exporter/exporterhelper/xexporterhelper/metadata.yaml index a744ab91d3..3fba414bb0 100644 --- a/exporter/exporterhelper/xexporterhelper/metadata.yaml +++ b/exporter/exporterhelper/xexporterhelper/metadata.yaml @@ -1,4 +1,5 @@ type: xexporterhelper +github_project: open-telemetry/opentelemetry-collector status: class: exporter diff --git a/exporter/xexporter/metadata.yaml b/exporter/xexporter/metadata.yaml index 9ee56341be..129e1eb0e0 100644 --- a/exporter/xexporter/metadata.yaml +++ b/exporter/xexporter/metadata.yaml @@ -1,4 +1,5 @@ type: xexporter +github_project: open-telemetry/opentelemetry-collector status: class: exporter diff --git a/extension/xextension/metadata.yaml b/extension/xextension/metadata.yaml index 7a86a03e60..54634a117c 100644 --- a/extension/xextension/metadata.yaml +++ b/extension/xextension/metadata.yaml @@ -1,4 +1,5 @@ type: xextension +github_project: open-telemetry/opentelemetry-collector status: class: extension diff --git a/pdata/pprofile/metadata.yaml b/pdata/pprofile/metadata.yaml index 3c4bd0dca7..a08638c2cb 100644 --- a/pdata/pprofile/metadata.yaml +++ b/pdata/pprofile/metadata.yaml @@ -1,4 +1,5 @@ type: pprofile +github_project: open-telemetry/opentelemetry-collector status: class: pdata diff --git a/processor/processorhelper/metadata.yaml b/processor/processorhelper/metadata.yaml index 32ae7621b1..bd1dd0f229 100644 --- a/processor/processorhelper/metadata.yaml +++ b/processor/processorhelper/metadata.yaml @@ -1,4 +1,5 @@ type: processorhelper +github_project: open-telemetry/opentelemetry-collector status: class: processor diff --git a/processor/xprocessor/metadata.yaml b/processor/xprocessor/metadata.yaml index bc13ced4a6..d4f5d0e1c4 100644 --- a/processor/xprocessor/metadata.yaml +++ b/processor/xprocessor/metadata.yaml @@ -1,4 +1,5 @@ type: xprocessor +github_project: open-telemetry/opentelemetry-collector status: class: processor diff --git a/receiver/xreceiver/metadata.yaml b/receiver/xreceiver/metadata.yaml index ac1b25b161..acaad4e8e9 100644 --- a/receiver/xreceiver/metadata.yaml +++ b/receiver/xreceiver/metadata.yaml @@ -1,4 +1,5 @@ type: xreceiver +github_project: open-telemetry/opentelemetry-collector status: class: receiver diff --git a/service/internal/graph/metadata.yaml b/service/internal/graph/metadata.yaml index 957a86c6c9..c6a249946e 100644 --- a/service/internal/graph/metadata.yaml +++ b/service/internal/graph/metadata.yaml @@ -1,4 +1,5 @@ type: graph +github_project: open-telemetry/opentelemetry-collector status: class: service