[cmd/mdatagen] Pull new changes from contrib (#9683)

To completely migrate mdatagen from contrib to core, we need to pull
latest changes:

-
open-telemetry/opentelemetry-collector-contrib#31500
-
open-telemetry/opentelemetry-collector-contrib#31503
-
open-telemetry/opentelemetry-collector-contrib#31520
-
open-telemetry/opentelemetry-collector-contrib#31525
-
open-telemetry/opentelemetry-collector-contrib#31530
-
open-telemetry/opentelemetry-collector-contrib#31532

---------

Co-authored-by: Alex Boten <[email protected]>

.chloggen/mdatagen-tests.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: cmd/mdatagen
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Generate the lifecycle tests for components by default.
+
+# One or more tracking issues or pull requests related to the change
+issues: [9683]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: |
+ It's encouraged to have lifecycle tests for all components enadled, but they can be disabled if needed 
+ in metadata.yaml with `skip_lifecycle: true` and `skip_shutdown: true` under `tests` section.
+
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []

cmd/mdatagen/go.mod

@@ -8,11 +8,13 @@ require (
  go.opentelemetry.io/collector/component v0.96.0
  go.opentelemetry.io/collector/confmap v0.96.0
  go.opentelemetry.io/collector/confmap/provider/fileprovider v0.96.0
+ go.opentelemetry.io/collector/consumer v0.96.0
  go.opentelemetry.io/collector/pdata v1.3.0
  go.opentelemetry.io/collector/receiver v0.96.0
  go.opentelemetry.io/collector/semconv v0.96.0
  go.opentelemetry.io/otel/metric v1.24.0
  go.opentelemetry.io/otel/trace v1.24.0
+ go.uber.org/goleak v1.3.0
  go.uber.org/multierr v1.11.0
  go.uber.org/zap v1.27.0
  golang.org/x/text v0.14.0
@@ -41,7 +43,6 @@ require (
  github.com/prometheus/common v0.48.0 // indirect
  github.com/prometheus/procfs v0.12.0 // indirect
  go.opentelemetry.io/collector/config/configtelemetry v0.96.0 // indirect
- go.opentelemetry.io/collector/consumer v0.96.0 // indirect
  go.opentelemetry.io/otel v1.24.0 // indirect
  go.opentelemetry.io/otel/exporters/prometheus v0.46.0 // indirect
  go.opentelemetry.io/otel/sdk v1.24.0 // indirect

cmd/mdatagen/internal/samplereceiver/doc.go

@@ -0,0 +1,10 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+// Generate a test metrics builder from a sample metrics set covering all configuration options.
+//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
+// This is a sample receiver package used to showcase how mdatagen is applied.
+package samplereceiver // import "go.opentelemetry.io/collector/cmd/mdatagen/internal/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,42 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package samplereceiver // import "go.opentelemetry.io/collector/cmd/mdatagen/internal/samplereceiver"
+
+import (
+ "context"
+
+ "go.opentelemetry.io/collector/cmd/mdatagen/internal/samplereceiver/internal/metadata"
+ "go.opentelemetry.io/collector/component"
+ "go.opentelemetry.io/collector/consumer"
+ "go.opentelemetry.io/collector/receiver"
+)
+
+// 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
 

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/cmd/mdatagen/internal/samplereceiver/internal/metadata"
+ "go.opentelemetry.io/collector/receiver/receivertest"
+)
+
+// 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/lint_test.go

@@ -9,7 +9,7 @@ import (
  "github.com/stretchr/testify/require"
 )
 
-func Test_formatIdentifier(t *testing.T) {
+func TestFormatIdentifier(t *testing.T) {
  var tests = []struct {
  input string
  want string

cmd/mdatagen/loader.go

@@ -202,6 +202,7 @@ func (a attribute) TestValue() string {
 type tests struct {
  Config any `mapstructure:"config"`
  SkipLifecycle bool `mapstructure:"skip_lifecycle"`
+ SkipShutdown bool `mapstructure:"skip_shutdown"`
  ExpectConsumerError bool `mapstructure:"expect_consumer_error"`
 }
 
@@ -225,7 +226,7 @@ type metadata struct {
  // ShortFolderName is the shortened folder name of the component, removing class if present
  ShortFolderName string `mapstructure:"-"`
 
- Tests *tests `mapstructure:"tests"`
+ Tests tests `mapstructure:"tests"`
 }
 
 func setAttributesFullName(attrs map[attributeName]attribute) {

cmd/mdatagen/loader_test.go

@@ -8,30 +8,34 @@ import (
 
  "github.com/stretchr/testify/require"
 
+ "go.opentelemetry.io/collector/component"
  "go.opentelemetry.io/collector/pdata/pcommon"
  "go.opentelemetry.io/collector/pdata/pmetric"
 )
 
-func Test_loadMetadata(t *testing.T) {
+func TestLoadMetadata(t *testing.T) {
  tests := []struct {
  name string
  want metadata
  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",
- Stability: map[string][]string{
- "development": {"logs"},
- "beta": {"traces"},
- "stable": {"metrics"},
+ Stability: map[component.StabilityLevel][]string{
+ component.StabilityLevelDevelopment: {"logs"},
+ component.StabilityLevelBeta: {"traces"},
+ component.StabilityLevelStable: {"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": {
@@ -214,8 +218,8 @@ func Test_loadMetadata(t *testing.T) {
  },
  },
  },
- ScopeName: "go.opentelemetry.io/collector",
- ShortFolderName: ".",
+ ScopeName: "go.opentelemetry.io/collector/samplereceiver",
+ ShortFolderName: "sample",
  },
  },
  {