[mdatagen] Add support for example configurations in metadata.yaml

cmd/mdatagen/internal/loader_test.go

@@ -448,7 +448,43 @@
 				},
 				ScopeName:       "go.opentelemetry.io/collector/internal/receiver/samplereceiver",
 				ShortFolderName: "sample",
+				ExampleConfigs: []ExampleConfig{
+					{
+						Name:        "Basic Configuration",
+						Description: "This example demonstrates the most basic configuration for the sample receiver with default settings.",
+						Config: `sample:
+  metrics:
+    default.metric:
+      enabled: true
+`,
+					},
+					{
+						Name:        "Advanced Configuration",
+						Description: "This example shows an advanced configuration with custom metrics enabled and resource attributes configured.",
+						Config: `sample:
+  metrics:
+    default.metric:
+      enabled: true
+    optional.metric:
+      enabled: true
+  resource_attributes:
+    string.resource.attr:
+      enabled: true
+    optional.resource.attr:
+      enabled: true
+`,
+					},
+					{
+						Name:        "Minimal Configuration",
+						Description: "A minimal configuration suitable for testing environments with only essential metrics.",
+						Config: `sample:
+  metrics:
+    metric.input_type:
+      enabled: true
+`,
+					},
+				},
 				Tests:           Tests{Host: "newMdatagenNopHost()"},
 			},
 		},
 		{

cmd/mdatagen/internal/metadata.go

@@ -44,6 +44,8 @@ type Metadata struct {
 	ScopeName string `mapstructure:"scope_name"`
 	// ShortFolderName is the shortened folder name of the component, removing class if present
 	ShortFolderName string `mapstructure:"-"`
+	// ExampleConfigs are example configuration snippets for the component.
+	ExampleConfigs []ExampleConfig `mapstructure:"example_configs"`
 	// Tests is the set of tests generated with the component
 	Tests Tests `mapstructure:"tests"`
 	// PackageName is the name of the package where the component is defined.
@@ -521,3 +523,12 @@ type EntityAttributeRef struct {
 	// Ref is the reference to a resource attribute.
 	Ref AttributeName `mapstructure:"ref"`
 }
+
+type ExampleConfig struct {
+	// Name is a descriptive name for the example configuration.
+	Name string `mapstructure:"name"`
+	// Description provides context about when this configuration should be used.
+	Description string `mapstructure:"description"`
+	// Config is the example configuration snippet in YAML format.
+	Config string `mapstructure:"config"`
+}

cmd/mdatagen/internal/samplereceiver/documentation.md

@@ -2,6 +2,51 @@
 
 # sample
 
+## Example Configurations
+
+### Basic Configuration
+
+This example demonstrates the most basic configuration for the sample receiver with default settings.
+
+```yaml
+sample:
+  metrics:
+    default.metric:
+      enabled: true
+
+```
+
+### Advanced Configuration
+
+This example shows an advanced configuration with custom metrics enabled and resource attributes configured.
+
+```yaml
+sample:
+  metrics:
+    default.metric:
+      enabled: true
+    optional.metric:
+      enabled: true
+  resource_attributes:
+    string.resource.attr:
+      enabled: true
+    optional.resource.attr:
+      enabled: true
+
+```
+
+### Minimal Configuration
+
+A minimal configuration suitable for testing environments with only essential metrics.
+
+```yaml
+sample:
+  metrics:
+    metric.input_type:
+      enabled: true
+
+```
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: