[mdatagen] Add optional display_name field to metadata.yaml

- Added display_name field to metadata-schema.yaml
- Updated Metadata struct to include DisplayName field
- Implemented automatic capitalization of type field when display_name not provided
- Modified readme.md.tmpl to generate README titles from display_name
- Fixed unused import issue in config_test.go.tmpl
- Added test cases for display_name handling
- Regenerated internal test code and README files

Fixes open-telemetry#14114

Co-authored-by: SteveYi <[email protected]>
Signed-off-by: thc1006 <[email protected]>

Author: thc1006

.chloggen/add-display-name-14114.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: Add optional `display_name` field to metadata.yaml for human-readable component names
+
+# One or more tracking issues or pull requests related to the change
+issues: [14114]
+
+# (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: |
+  The `display_name` field allows components to specify a human-readable name in metadata.yaml.
+  If not provided, the component type will be used with the first letter capitalized.
+
+# 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: [user]

cmd/mdatagen/README.md

@@ -1,5 +1,8 @@
 # Metadata Generator
 
+
+# Mdatagen
+
 <!-- status autogenerated section -->
 | Status        |           |
 | ------------- |-----------|

cmd/mdatagen/internal/loader.go

@@ -59,6 +59,9 @@ func LoadMetadata(filePath string) (Metadata, error) {
 	if md.GeneratedPackageName == "" {
 		md.GeneratedPackageName = "metadata"
 	}
+	if md.DisplayName == "" {
+		md.DisplayName = generateDefaultDisplayName(md.Type)
+	}
 
 	if err := md.Validate(); err != nil {
 		return md, err
@@ -70,6 +73,13 @@ func LoadMetadata(filePath string) (Metadata, error) {
 	return md, nil
 }
 
+func generateDefaultDisplayName(componentType string) string {
+	if componentType == "" {
+		return ""
+	}
+	return strings.ToUpper(componentType[:1]) + componentType[1:]
+}
+
 var componentTypes = []string{
 	"connector",
 	"exporter",

cmd/mdatagen/internal/loader_test.go

@@ -47,6 +47,7 @@ func TestLoadMetadata(t *testing.T) {
 				GithubProject:        "open-telemetry/opentelemetry-collector",
 				GeneratedPackageName: "metadata",
 				Type:                 "sample",
+				DisplayName:          "Sample",
 				SemConvVersion:       "1.37.0",
 				PackageName:          "go.opentelemetry.io/collector/cmd/mdatagen/internal/samplereceiver",
 				Status: &Status{
@@ -455,6 +456,7 @@ func TestLoadMetadata(t *testing.T) {
 			name: "testdata/parent.yaml",
 			want: Metadata{
 				Type:                 "subcomponent",
+				DisplayName:          "Subcomponent",
 				Parent:               "parentComponent",
 				GeneratedPackageName: "metadata",
 				ScopeName:            "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
@@ -467,6 +469,7 @@ func TestLoadMetadata(t *testing.T) {
 			name: "testdata/generated_package_name.yaml",
 			want: Metadata{
 				Type:                 "custom",
+				DisplayName:          "Custom",
 				GeneratedPackageName: "customname",
 				ScopeName:            "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
 				PackageName:          "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
@@ -486,6 +489,7 @@ func TestLoadMetadata(t *testing.T) {
 			name: "testdata/empty_test_config.yaml",
 			want: Metadata{
 				Type:                 "test",
+				DisplayName:          "Test",
 				GeneratedPackageName: "metadata",
 				ScopeName:            "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
 				PackageName:          "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
@@ -553,6 +557,42 @@ func TestLoadMetadata(t *testing.T) {
 			name:    "testdata/~~this file doesn't exist~~.yaml",
 			wantErr: "unable to read the file file:testdata/~~this file doesn't exist~~.yaml",
 		},
+		{
+			name: "testdata/display_name.yaml",
+			want: Metadata{
+				Type:                 "test",
+				DisplayName:          "Test Receiver",
+				GeneratedPackageName: "metadata",
+				ScopeName:            "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
+				PackageName:          "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
+				ShortFolderName:      "testdata",
+				Tests:                Tests{Host: "newMdatagenNopHost()"},
+				Status: &Status{
+					Class: "receiver",
+					Stability: map[component.StabilityLevel][]string{
+						component.StabilityLevelBeta: {"logs"},
+					},
+				},
+			},
+		},
+		{
+			name: "testdata/no_display_name.yaml",
+			want: Metadata{
+				Type:                 "nodisplayname",
+				DisplayName:          "Nodisplayname",
+				GeneratedPackageName: "metadata",
+				ScopeName:            "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
+				PackageName:          "go.opentelemetry.io/collector/cmd/mdatagen/internal/testdata",
+				ShortFolderName:      "testdata",
+				Tests:                Tests{Host: "newMdatagenNopHost()"},
+				Status: &Status{
+					Class: "receiver",
+					Stability: map[component.StabilityLevel][]string{
+						component.StabilityLevelBeta: {"logs"},
+					},
+				},
+			},
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {

cmd/mdatagen/internal/metadata.go

@@ -18,6 +18,8 @@ import (
 type Metadata struct {
 	// Type of the component.
 	Type string `mapstructure:"type"`
+	// DisplayName is a human-readable name for the component.
+	DisplayName string `mapstructure:"display_name"`
 	// Type of the parent component (applicable to subcomponents).
 	Parent string `mapstructure:"parent"`
 	// Status information for the component.

cmd/mdatagen/internal/sampleconnector/internal/metadata/generated_config_test.go

@@ -1,5 +1,8 @@
 # Sample Receiver
 This receiver is used for testing purposes to check the output of mdatagen.
+
+# Sample
+
 <!-- status autogenerated section -->
 | Status        |           |
 | ------------- |-----------|

cmd/mdatagen/internal/samplefactoryreceiver/README.md

@@ -1,5 +1,8 @@
 # Sample Processor
 This processor is used for testing purposes to check the output of mdatagen.
+
+# Sample
+
 <!-- status autogenerated section -->
 | Status        |           |
 | ------------- |-----------|

cmd/mdatagen/internal/sampleprocessor/README.md

@@ -1,5 +1,8 @@
 # Sample Receiver
 This receiver is used for testing purposes to check the output of mdatagen.
+
+# Sample
+
 <!-- status autogenerated section -->
 | Status        |           |
 | ------------- |-----------|