[chore][receiver/carbon] create metadata (open-telemetry#21842)

fluxninja · May 11, 2023 · 4540dde · 4540dde
1 parent f319aa8
commit 4540dde
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 20 deletions.
diff --git a/receiver/carbonreceiver/README.md b/receiver/carbonreceiver/README.md
@@ -1,10 +1,14 @@
 # Carbon Receiver
 
-| Status | |
-| ------------------------ |------------|
-| Stability | [beta] |
-| Supported pipeline types | metrics |
-| Distributions | [contrib] |
+<!-- status autogenerated section -->
+| 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
+<!-- end autogenerated section -->
 
 The [Carbon](https://github.com/graphite-project/carbon) receiver supports
 Carbon's [plaintext
@@ -61,5 +65,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/carbonreceiver/config_test.go b/receiver/carbonreceiver/config_test.go
@@ -25,6 +25,7 @@ import (
  "go.opentelemetry.io/collector/config/confignet"
  "go.opentelemetry.io/collector/confmap/confmaptest"
 
+ "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/carbonreceiver/internal/metadata"
  "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/carbonreceiver/protocol"
 )
 
@@ -39,11 +40,11 @@ func TestLoadConfig(t *testing.T) {
  expected component.Config
  }{
  {
- id: component.NewIDWithName(typeStr, ""),
+ id: component.NewIDWithName(metadata.Type, ""),
  expected: createDefaultConfig(),
  },
  {
- id: component.NewIDWithName(typeStr, "receiver_settings"),
+ id: component.NewIDWithName(metadata.Type, "receiver_settings"),
  expected: &Config{
  NetAddr: confignet.NetAddr{
  Endpoint: "localhost:8080",
@@ -57,7 +58,7 @@ func TestLoadConfig(t *testing.T) {
  },
  },
  {
- id: component.NewIDWithName(typeStr, "regex"),
+ id: component.NewIDWithName(metadata.Type, "regex"),
  expected: &Config{
  NetAddr: confignet.NetAddr{
  Endpoint: "localhost:2003",

diff --git a/receiver/carbonreceiver/doc.go b/receiver/carbonreceiver/doc.go
@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//go:generate mdatagen metadata.yaml
+
 // Package carbonreceiver implements a receiver that can be used by the
 // OpenTelemetry collector to receive data in the Carbon supported formats.
 // Carbon is the backend used by Graphite, see

diff --git a/receiver/carbonreceiver/factory.go b/receiver/carbonreceiver/factory.go
@@ -22,25 +22,19 @@ import (
  "go.opentelemetry.io/collector/consumer"
  "go.opentelemetry.io/collector/receiver"
 
+ "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/carbonreceiver/internal/metadata"
  "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/carbonreceiver/protocol"
  "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/carbonreceiver/transport"
 )
 
 // This file implements factory for Carbon receiver.
 
-const (
- // The value of "type" key in configuration.
- typeStr = "carbon"
- // The stability level of the receiver.
- stability = component.StabilityLevelBeta
-)
-
 // NewFactory creates a factory for Carbon receiver.
 func NewFactory() receiver.Factory {
  return receiver.NewFactory(
- typeStr,
+ metadata.Type,
  createDefaultConfig,
- receiver.WithMetrics(createMetricsReceiver, stability))
+ receiver.WithMetrics(createMetricsReceiver, metadata.MetricsStability))
 }
 
 func createDefaultConfig() component.Config {

diff --git a/receiver/carbonreceiver/internal/metadata/generated_status.go b/receiver/carbonreceiver/internal/metadata/generated_status.go
diff --git a/receiver/carbonreceiver/metadata.yaml b/receiver/carbonreceiver/metadata.yaml
@@ -0,0 +1,8 @@
+type: carbon
+
+status:
+ class: receiver
+ stability:
+ beta: [metrics]
+ distributions: [contrib]
+
diff --git a/receiver/carbonreceiver/reporter_test.go b/receiver/carbonreceiver/reporter_test.go
@@ -22,10 +22,12 @@ import (
  "github.com/stretchr/testify/require"
  "go.opentelemetry.io/collector/component"
  "go.opentelemetry.io/collector/obsreport/obsreporttest"
+
+ "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/carbonreceiver/internal/metadata"
 )
 
 func TestReporterObservability(t *testing.T) {
- receiverID := component.NewIDWithName(typeStr, "fake_receiver")
+ receiverID := component.NewIDWithName(metadata.Type, "fake_receiver")
  tt, err := obsreporttest.SetupTelemetry(receiverID)
  require.NoError(t, err)
  defer func() {