[cmd/mdatagen] Add parent field to metadata.yaml file for subcomponen…

…ts (#23636) This PR adds a `parent` field to the `metadata.yaml`. This is used in subcomponents, and the field contains the type of their parent component. --------- Co-authored-by: Dmitrii Anoshin <[email protected]>
open-telemetry · Jun 26, 2023 · c15794f · c15794f
1 parent c2401db
commit c15794f
Show file tree

Hide file tree

Showing 49 changed files with 127 additions and 0 deletions.
diff --git a/.chloggen/add-parent-field-metadata.yaml b/.chloggen/add-parent-field-metadata.yaml
@@ -0,0 +1,20 @@
+# Use this changelog template to create an entry for release notes.
+# If your change doesn't affect end users, such as a test fix or a tooling change,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+
+# 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. filelogreceiver)
+component: mdatagen
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Adds a parent field to metadata.yaml for subcomponents.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [23636]
+
+# (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:
diff --git a/cmd/mdatagen/loader.go b/cmd/mdatagen/loader.go
@@ -210,6 +210,8 @@ func (attr *attribute) Unmarshal(parser *confmap.Conf) error {
 type metadata struct {
 	// Type of the component.
 	Type string `mapstructure:"type"`
+	// Type of the parent component (applicable to subcomponents).
+	Parent string `mapstructure:"parent"`
 	// Status information for the component.
 	Status *Status `mapstructure:"status"`
 	// SemConvVersion is a version number of OpenTelemetry semantic conventions applied to the scraped metrics.

diff --git a/cmd/mdatagen/loader_test.go b/cmd/mdatagen/loader_test.go
@@ -158,6 +158,14 @@ func Test_loadMetadata(t *testing.T) {
 				ScopeName: "otelcol",
 			},
 		},
+		{
+			name: "testdata/parent.yaml",
+			want: metadata{
+				Type:      "subcomponent",
+				Parent:    "parentComponent",
+				ScopeName: "otelcol",
+			},
+		},
 		{
 			name:    "testdata/unknown_metric_attribute.yaml",
 			want:    metadata{},

diff --git a/cmd/mdatagen/metadata-schema.yaml b/cmd/mdatagen/metadata-schema.yaml
@@ -1,6 +1,9 @@
 # Required: The type of the component - Usually the name. The type and class combined uniquely identify the component (eg. receiver/otlp) or subcomponent (eg. receiver/hostmetricsreceiver/cpu)
 type:
 
+# Required for subcomponents: The type of the parent component.
+parent: string
+
 # Required for components (Optional for subcomponents): A high-level view of the development status and use of this component
 status:
   # Required: The class of the component (For example receiver)

diff --git a/cmd/mdatagen/templates/documentation.md.tmpl b/cmd/mdatagen/templates/documentation.md.tmpl
@@ -38,6 +38,11 @@
 
 # {{ .Type }}
 
+{{- if .Parent }}
+
+**Parent Component:** {{ .Parent }}
+{{- end }}
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/cmd/mdatagen/testdata/parent.yaml b/cmd/mdatagen/testdata/parent.yaml
@@ -0,0 +1,3 @@
+type: subcomponent
+
+parent: parentComponent
diff --git a/processor/resourcedetectionprocessor/internal/aws/ec2/metadata.yaml b/processor/resourcedetectionprocessor/internal/aws/ec2/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/ec2
 
+parent: resourcedetection
+
 resource_attributes:
   host.name:
     description: The hostname

diff --git a/processor/resourcedetectionprocessor/internal/aws/ecs/metadata.yaml b/processor/resourcedetectionprocessor/internal/aws/ecs/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/ecs
 
+parent: resourcedetection
+
 resource_attributes:
   cloud.provider:
     description: The cloud.provider

diff --git a/processor/resourcedetectionprocessor/internal/aws/eks/metadata.yaml b/processor/resourcedetectionprocessor/internal/aws/eks/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/eks
 
+parent: resourcedetection
+
 resource_attributes:
   cloud.provider:
     description: The cloud.provider

diff --git a/processor/resourcedetectionprocessor/internal/aws/elasticbeanstalk/metadata.yaml b/processor/resourcedetectionprocessor/internal/aws/elasticbeanstalk/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/elastic_beanstalk
 
+parent: resourcedetection
+
 resource_attributes:
   cloud.provider:
     description: The cloud.provider

diff --git a/processor/resourcedetectionprocessor/internal/aws/lambda/metadata.yaml b/processor/resourcedetectionprocessor/internal/aws/lambda/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/lambda
 
+parent: resourcedetection
+
 resource_attributes:
   cloud.provider:
     description: The cloud.provider

diff --git a/processor/resourcedetectionprocessor/internal/azure/aks/metadata.yaml b/processor/resourcedetectionprocessor/internal/azure/aks/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/aks
 
+parent: resourcedetection
+
 resource_attributes:
   cloud.provider:
     description: The cloud.provider

diff --git a/processor/resourcedetectionprocessor/internal/azure/metadata.yaml b/processor/resourcedetectionprocessor/internal/azure/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/azure
 
+parent: resourcedetection
+
 resource_attributes:
   cloud.provider:
     description: The cloud.provider

diff --git a/processor/resourcedetectionprocessor/internal/consul/metadata.yaml b/processor/resourcedetectionprocessor/internal/consul/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/consul
 
+parent: resourcedetection
+
 resource_attributes:
   cloud.provider:
     description: The cloud.provider

diff --git a/processor/resourcedetectionprocessor/internal/docker/metadata.yaml b/processor/resourcedetectionprocessor/internal/docker/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/docker
 
+parent: resourcedetection
+
 resource_attributes:
   host.name:
     description: The host.name

diff --git a/processor/resourcedetectionprocessor/internal/gcp/metadata.yaml b/processor/resourcedetectionprocessor/internal/gcp/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/gcp
 
+parent: resourcedetection
+
 resource_attributes:
   host.name:
     description: The host.name

diff --git a/processor/resourcedetectionprocessor/internal/heroku/metadata.yaml b/processor/resourcedetectionprocessor/internal/heroku/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/heroku
 
+parent: resourcedetection
+
 resource_attributes:
   cloud.provider:
     description: The cloud.provider

diff --git a/processor/resourcedetectionprocessor/internal/openshift/metadata.yaml b/processor/resourcedetectionprocessor/internal/openshift/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/openshift
 
+parent: resourcedetection
+
 resource_attributes:
   cloud.provider:
     description: The cloud.provider

diff --git a/processor/resourcedetectionprocessor/internal/system/metadata.yaml b/processor/resourcedetectionprocessor/internal/system/metadata.yaml
@@ -1,5 +1,7 @@
 type: resourcedetectionprocessor/system
 
+parent: resourcedetection
+
 resource_attributes:
   host.name:
     description: The host.name

diff --git a/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/documentation.md
@@ -2,6 +2,8 @@
 
 # hostmetricsreceiver/cpu
 
+**Parent Component:** hostmetrics
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/metadata.yaml b/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/metadata.yaml
@@ -1,5 +1,7 @@
 type: hostmetricsreceiver/cpu
 
+parent: hostmetrics
+
 sem_conv_version: 1.9.0
 
 attributes:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/diskscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/diskscraper/documentation.md
@@ -2,6 +2,8 @@
 
 # hostmetricsreceiver/disk
 
+**Parent Component:** hostmetrics
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/diskscraper/metadata.yaml b/receiver/hostmetricsreceiver/internal/scraper/diskscraper/metadata.yaml
@@ -1,5 +1,7 @@
 type: hostmetricsreceiver/disk
 
+parent: hostmetrics
+
 sem_conv_version: 1.9.0
 
 attributes:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/documentation.md
@@ -2,6 +2,8 @@
 
 # hostmetricsreceiver/filesystem
 
+**Parent Component:** hostmetrics
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/metadata.yaml b/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/metadata.yaml
@@ -1,5 +1,7 @@
 type: hostmetricsreceiver/filesystem
 
+parent: hostmetrics
+
 sem_conv_version: 1.9.0
 
 attributes:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/loadscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/loadscraper/documentation.md
@@ -2,6 +2,8 @@
 
 # hostmetricsreceiver/load
 
+**Parent Component:** hostmetrics
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/loadscraper/metadata.yaml b/receiver/hostmetricsreceiver/internal/scraper/loadscraper/metadata.yaml
@@ -1,5 +1,7 @@
 type: hostmetricsreceiver/load
 
+parent: hostmetrics
+
 sem_conv_version: 1.9.0
 
 metrics:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/documentation.md
@@ -2,6 +2,8 @@
 
 # hostmetricsreceiver/memory
 
+**Parent Component:** hostmetrics
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/metadata.yaml b/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/metadata.yaml
@@ -1,5 +1,7 @@
 type: hostmetricsreceiver/memory
 
+parent: hostmetrics
+
 sem_conv_version: 1.9.0
 
 attributes:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md
@@ -2,6 +2,8 @@
 
 # hostmetricsreceiver/network
 
+**Parent Component:** hostmetrics
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/networkscraper/metadata.yaml b/receiver/hostmetricsreceiver/internal/scraper/networkscraper/metadata.yaml
@@ -1,5 +1,7 @@
 type: hostmetricsreceiver/network
 
+parent: hostmetrics
+
 sem_conv_version: 1.9.0
 
 attributes:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/documentation.md
@@ -2,6 +2,8 @@
 
 # hostmetricsreceiver/paging
 
+**Parent Component:** hostmetrics
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/metadata.yaml b/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/metadata.yaml
@@ -1,5 +1,7 @@
 type: hostmetricsreceiver/paging
 
+parent: hostmetrics
+
 sem_conv_version: 1.9.0
 
 attributes:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/processesscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/processesscraper/documentation.md
@@ -2,6 +2,8 @@
 
 # hostmetricsreceiver/processes
 
+**Parent Component:** hostmetrics
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/processesscraper/metadata.yaml b/receiver/hostmetricsreceiver/internal/scraper/processesscraper/metadata.yaml
@@ -1,5 +1,7 @@
 type: hostmetricsreceiver/processes
 
+parent: hostmetrics
+
 sem_conv_version: 1.9.0
 
 attributes:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md
@@ -2,6 +2,8 @@
 
 # hostmetricsreceiver/process
 
+**Parent Component:** hostmetrics
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/hostmetricsreceiver/internal/scraper/processscraper/metadata.yaml b/receiver/hostmetricsreceiver/internal/scraper/processscraper/metadata.yaml
@@ -1,5 +1,7 @@
 type: hostmetricsreceiver/process
 
+parent: hostmetrics
+
 sem_conv_version: 1.9.0
 
 resource_attributes:

diff --git a/receiver/k8sclusterreceiver/internal/deployment/documentation.md b/receiver/k8sclusterreceiver/internal/deployment/documentation.md
@@ -2,6 +2,8 @@
 
 # k8s/deployment
 
+**Parent Component:** k8s_cluster
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/k8sclusterreceiver/internal/deployment/metadata.yaml b/receiver/k8sclusterreceiver/internal/deployment/metadata.yaml
@@ -1,5 +1,7 @@
 type: k8s/deployment
 
+parent: k8s_cluster
+
 sem_conv_version: 1.18.0
 
 resource_attributes:

diff --git a/receiver/k8sclusterreceiver/internal/hpa/documentation.md b/receiver/k8sclusterreceiver/internal/hpa/documentation.md
@@ -2,6 +2,8 @@
 
 # k8s/hpa
 
+**Parent Component:** k8s_cluster
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/k8sclusterreceiver/internal/hpa/metadata.yaml b/receiver/k8sclusterreceiver/internal/hpa/metadata.yaml
@@ -1,5 +1,7 @@
 type: k8s/hpa
 
+parent: k8s_cluster
+
 sem_conv_version: 1.9.0
 
 resource_attributes:

diff --git a/receiver/k8sclusterreceiver/internal/namespace/documentation.md b/receiver/k8sclusterreceiver/internal/namespace/documentation.md
@@ -2,6 +2,8 @@
 
 # k8s/namespace
 
+**Parent Component:** k8s_cluster
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/k8sclusterreceiver/internal/namespace/metadata.yaml b/receiver/k8sclusterreceiver/internal/namespace/metadata.yaml
@@ -1,5 +1,7 @@
 type: k8s/namespace
 
+parent: k8s_cluster
+
 sem_conv_version: 1.18.0
 
 resource_attributes:

diff --git a/receiver/k8sclusterreceiver/internal/node/documentation.md b/receiver/k8sclusterreceiver/internal/node/documentation.md
@@ -2,6 +2,8 @@
 
 # k8s/node
 
+**Parent Component:** k8s_cluster
+
 ## Default Metrics
 
 The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

diff --git a/receiver/k8sclusterreceiver/internal/node/metadata.yaml b/receiver/k8sclusterreceiver/internal/node/metadata.yaml
@@ -1,5 +1,7 @@
 type: k8s/node
 
+parent: k8s_cluster
+
 sem_conv_version: 1.18.0
 
 resource_attributes: