[chore] [cmd/mdatagen] Move sample-metadata.yaml to a separate package (

open-telemetry#31503)

Create a separate internal sample receiver to generate and validate code
with mdatagen, including lifecycle tests.

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -21,6 +21,7 @@ body:
  - cmd/configschema
  - cmd/githubgen
  - cmd/mdatagen
+ - cmd/mdatagen/internal/samplereceiver
  - cmd/opampsupervisor
  - cmd/otelcontribcol
  - cmd/oteltestbedcol

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -15,6 +15,7 @@ body:
  - cmd/configschema
  - cmd/githubgen
  - cmd/mdatagen
+ - cmd/mdatagen/internal/samplereceiver
  - cmd/opampsupervisor
  - cmd/otelcontribcol
  - cmd/oteltestbedcol

.github/ISSUE_TEMPLATE/other.yaml

@@ -15,6 +15,7 @@ body:
  - cmd/configschema
  - cmd/githubgen
  - cmd/mdatagen
+ - cmd/mdatagen/internal/samplereceiver
  - cmd/opampsupervisor
  - cmd/otelcontribcol
  - cmd/oteltestbedcol

cmd/mdatagen/go.mod

@@ -9,6 +9,7 @@ require (
  go.opentelemetry.io/collector/component v0.95.0
  go.opentelemetry.io/collector/confmap v0.95.0
  go.opentelemetry.io/collector/confmap/provider/fileprovider v0.95.0
+ go.opentelemetry.io/collector/consumer v0.95.0
  go.opentelemetry.io/collector/pdata v1.2.0
  go.opentelemetry.io/collector/receiver v0.95.0
  go.opentelemetry.io/collector/semconv v0.95.0
@@ -44,7 +45,6 @@ require (
  github.com/prometheus/common v0.46.0 // indirect
  github.com/prometheus/procfs v0.12.0 // indirect
  go.opentelemetry.io/collector/config/configtelemetry v0.95.0 // indirect
- go.opentelemetry.io/collector/consumer v0.95.0 // indirect
  go.opentelemetry.io/otel v1.23.1 // indirect
  go.opentelemetry.io/otel/exporters/prometheus v0.45.2 // indirect
  go.opentelemetry.io/otel/sdk v1.23.1 // indirect

cmd/mdatagen/doc.go → cmd/mdatagen/internal/samplereceiver/doc.go

@@ -2,8 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 // Generate a test metrics builder from a sample metrics set covering all configuration options.
-//go:generate mdatagen metadata-sample.yaml
+//go:generate mdatagen metadata.yaml
 
 // Deprecated: This package is moving to https://github.com/open-telemetry/opentelemetry-collector and will eventually be removed.
 // Please see https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/30497
-package main
+// This is a sample receiver package used to showcase how mdatagen is applied.
+package samplereceiver

cmd/mdatagen/documentation.md → cmd/mdatagen/internal/samplereceiver/documentation.md

@@ -1,6 +1,6 @@
 [comment]: <> (Code generated by mdatagen. DO NOT EDIT.)
 
-# file
+# sample
 
 ## Default Metrics
 

cmd/mdatagen/internal/samplereceiver/factory.go

@@ -0,0 +1,43 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package samplereceiver
+
+import (
+ "context"
+
+ "go.opentelemetry.io/collector/component"
+ "go.opentelemetry.io/collector/consumer"
+ "go.opentelemetry.io/collector/receiver"
+
+ "github.com/open-telemetry/opentelemetry-collector-contrib/cmd/mdatagen/internal/samplereceiver/internal/metadata"
+)
+
+// NewFactory returns a receiver.Factory for sample receiver.
+func NewFactory() receiver.Factory {
+ return receiver.NewFactory(
+ metadata.Type,
+ func() component.Config { return &struct{}{} },
+ receiver.WithTraces(createTraces, metadata.TracesStability),
+ receiver.WithMetrics(createMetrics, metadata.MetricsStability),
+ receiver.WithLogs(createLogs, metadata.LogsStability))
+}
+
+func createTraces(context.Context, receiver.CreateSettings, component.Config, consumer.Traces) (receiver.Traces, error) {
+ return nopInstance, nil
+}
+
+func createMetrics(context.Context, receiver.CreateSettings, component.Config, consumer.Metrics) (receiver.Metrics, error) {
+ return nopInstance, nil
+}
+
+func createLogs(context.Context, receiver.CreateSettings, component.Config, consumer.Logs) (receiver.Logs, error) {
+ return nopInstance, nil
+}
+
+var nopInstance = &nopReceiver{}
+
+type nopReceiver struct {
+ component.StartFunc
+ component.ShutdownFunc
+}

cmd/mdatagen/metadata-sample.yaml → cmd/mdatagen/internal/samplereceiver/metadata.yaml

@@ -1,6 +1,6 @@
-# Sample metric metadata file with all available configurations.
+# Sample metadata file with all available configurations for a receiver.
 
-type: file
+type: sample
 
 sem_conv_version: 1.9.0
 
@@ -10,7 +10,9 @@ status:
  development: [logs]
  beta: [traces]
  stable: [metrics]
- distributions: [contrib]
+ distributions: []
+ codeowners:
+ active: [dmitryax]
  warnings:
  - Any additional information that should be brought to the consumer's attention
 
@@ -134,3 +136,6 @@ metrics:
  aggregation_temporality: delta
  warnings:
  if_enabled: This metric is deprecated and will be removed soon.
+
+tests:
+ config:

cmd/mdatagen/internal/samplereceiver/metrics_test.go

@@ -0,0 +1,20 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package samplereceiver
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+ "go.opentelemetry.io/collector/receiver/receivertest"
+
+ "github.com/open-telemetry/opentelemetry-collector-contrib/cmd/mdatagen/internal/samplereceiver/internal/metadata"
+)
+
+// TestGeneratedMetrics verifies that the internal/metadata API is generated correctly.
+func TestGeneratedMetrics(t *testing.T) {
+ mb := metadata.NewMetricsBuilder(metadata.DefaultMetricsBuilderConfig(), receivertest.NewNopCreateSettings())
+ m := mb.Emit()
+ require.Equal(t, 0, m.ResourceMetrics().Len())
+}

cmd/mdatagen/loader_test.go

@@ -18,9 +18,9 @@ func TestLoadMetadata(t *testing.T) {
  wantErr string
  }{
  {
- name: "metadata-sample.yaml",
+ name: "internal/samplereceiver/metadata.yaml",
  want: metadata{
- Type: "file",
+ Type: "sample",
  SemConvVersion: "1.9.0",
  Status: &Status{
  Class: "receiver",
@@ -29,8 +29,11 @@ func TestLoadMetadata(t *testing.T) {
  "beta": {"traces"},
  "stable": {"metrics"},
  },
- Distributions: []string{"contrib"},
- Warnings: []string{"Any additional information that should be brought to the consumer's attention"},
+ Distributions: []string{},
+ Codeowners: &Codeowners{
+ Active: []string{"dmitryax"},
+ },
+ Warnings: []string{"Any additional information that should be brought to the consumer's attention"},
  },
  ResourceAttributes: map[attributeName]attribute{
  "string.resource.attr": {
@@ -213,8 +216,9 @@ func TestLoadMetadata(t *testing.T) {
  },
  },
  },
- ScopeName: "otelcol",
- ShortFolderName: ".",
+ ScopeName: "otelcol/samplereceiver",
+ ShortFolderName: "sample",
+ Tests: &tests{},
  },
  },
  {

cmd/mdatagen/main_test.go

@@ -11,9 +11,6 @@ import (
  "testing"
 
  "github.com/stretchr/testify/require"
- "go.opentelemetry.io/collector/receiver/receivertest"
-
- md "github.com/open-telemetry/opentelemetry-collector-contrib/cmd/mdatagen/internal/metadata"
 )
 
 func TestRunContents(t *testing.T) {
@@ -413,10 +410,3 @@ func Tracer(settings component.TelemetrySettings) trace.Tracer {
  })
  }
 }
-
-// TestGenerated verifies that the internal/metadata API is generated correctly.
-func TestGenerated(t *testing.T) {
- mb := md.NewMetricsBuilder(md.DefaultMetricsBuilderConfig(), receivertest.NewNopCreateSettings())
- m := mb.Emit()
- require.Equal(t, 0, m.ResourceMetrics().Len())
-}

cmd/mdatagen/internal/metadata/package_test.go → cmd/mdatagen/package_test.go

@@ -1,7 +1,7 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-package metadata
+package main
 
 import (
  "testing"