[receiver/dockerstats] Add optional resource attributes (open-telemet…

…ry#21185)

**Description:** <Describe what has changed.>
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
Add `container.image.id` and `container.command_line` as optional
resource attributes, disabled by default.



**Link to tracking Issue:** <Issue number if applicable>

Tracking issue
open-telemetry#21092

**Testing:** <Describe what testing was performed and which tests were
added.>

Until this point, all resource attributes have been enabled by default,
resulting in the coupling of the
[test](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/7bf5d66fae6c1c5360ec2875948f2c2adab6c44f/receiver/dockerstatsreceiver/receiver_test.go#L191)
to the default configuration. In order to test the current
implementation with the new resource attributes enabled & disabled, a
minor refactoring was required in the `TestScrapeV2` test, allowing to
pass different configurations for each test.

Refer to the following commit 508dbee9aa9a22c1ca79f16bba5abeecceeb9c48
to check the refactor in the test.

**Documentation:** <Describe the documentation added.>

New resource attributes documentation was generated by `mdatagen`.

.chloggen/docker-add-optional-resource-attributes.yaml

@@ -0,0 +1,16 @@
+# 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: dockerstatsreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "Add `container.image.id` and `container.command_line` optional resource attributes"
+
+# One or more tracking issues related to the change
+issues: [21092]
+
+# (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:

receiver/dockerstatsreceiver/documentation.md

@@ -718,8 +718,10 @@ Time elapsed since container start time.
 
 | Name | Description | Values | Enabled |
 | ---- | ----------- | ------ | ------- |
+| container.command_line | The full command executed by the container. | Any Str | false |
 | container.hostname | The hostname of the container. | Any Str | true |
 | container.id | The ID of the container. | Any Str | true |
+| container.image.id | The ID of the container image. | Any Str | false |
 | container.image.name | The name of the docker image in use by the container. | Any Str | true |
 | container.name | The name of the container. | Any Str | true |
 | container.runtime | The runtime of the container. For this receiver, it will always be 'docker'. | Any Str | true |

receiver/dockerstatsreceiver/internal/metadata/testdata/config.yaml

@@ -136,10 +136,14 @@ all_set:
     container.uptime:
       enabled: true
   resource_attributes:
+    container.command_line:
+      enabled: true
     container.hostname:
       enabled: true
     container.id:
       enabled: true
+    container.image.id:
+      enabled: true
     container.image.name:
       enabled: true
     container.name:
@@ -283,10 +287,14 @@ none_set:
     container.uptime:
       enabled: false
   resource_attributes:
+    container.command_line:
+      enabled: false
     container.hostname:
       enabled: false
     container.id:
       enabled: false
+    container.image.id:
+      enabled: false
     container.image.name:
       enabled: false
     container.name:

receiver/dockerstatsreceiver/metadata.yaml

@@ -30,6 +30,14 @@ resource_attributes:
     description: "The hostname of the container."
     type: string
     enabled: true
+  container.image.id:
+    description: "The ID of the container image."
+    type: string
+    enabled: false
+  container.command_line:
+    description: "The full command executed by the container."
+    type: string
+    enabled: false
 
 attributes:
   core:

receiver/dockerstatsreceiver/receiver.go

@@ -132,7 +132,10 @@ func (r *receiver) recordContainerStats(now pcommon.Timestamp, containerStats *d
 		metadata.WithContainerHostname(container.Config.Hostname),
 		metadata.WithContainerID(container.ID),
 		metadata.WithContainerImageName(container.Config.Image),
-		metadata.WithContainerName(strings.TrimPrefix(container.Name, "/")))
+		metadata.WithContainerName(strings.TrimPrefix(container.Name, "/")),
+		metadata.WithContainerImageID(container.Image),
+		metadata.WithContainerCommandLine(strings.Join(container.Config.Cmd, " ")),
+	)
 
 	for k, label := range r.config.EnvVarsToMetricLabels {
 		label := label

receiver/dockerstatsreceiver/receiver_test.go

@@ -102,6 +102,17 @@ var (
 		ContainerMemoryAnon:                        metricEnabled,
 		ContainerMemoryFile:                        metricEnabled,
 	}
+
+	resourceAttributeEnabled     = metadata.ResourceAttributeConfig{Enabled: true}
+	allResourceAttributesEnabled = metadata.ResourceAttributesConfig{
+		ContainerCommandLine: resourceAttributeEnabled,
+		ContainerHostname:    resourceAttributeEnabled,
+		ContainerID:          resourceAttributeEnabled,
+		ContainerImageID:     resourceAttributeEnabled,
+		ContainerImageName:   resourceAttributeEnabled,
+		ContainerName:        resourceAttributeEnabled,
+		ContainerRuntime:     resourceAttributeEnabled,
+	}
 )
 
 func TestNewReceiver(t *testing.T) {
@@ -145,6 +156,7 @@ func TestScrapeV2(t *testing.T) {
 		desc                string
 		expectedMetricsFile string
 		mockDockerEngine    func(t *testing.T) *httptest.Server
+		cfgBuilder          *testConfigBuilder
 	}{
 		{
 			desc:                "scrapeV2_single_container",
@@ -160,6 +172,9 @@ func TestScrapeV2(t *testing.T) {
 				require.NoError(t, err)
 				return mockServer
 			},
+			cfgBuilder: newTestConfigBuilder().
+				withDefaultLabels().
+				withMetrics(allMetricsEnabled),
 		},
 		{
 			desc:                "scrapeV2_two_containers",
@@ -180,6 +195,9 @@ func TestScrapeV2(t *testing.T) {
 				require.NoError(t, err)
 				return mockServer
 			},
+			cfgBuilder: newTestConfigBuilder().
+				withDefaultLabels().
+				withMetrics(allMetricsEnabled),
 		},
 		{
 			desc:                "scrapeV2_no_pids_stats",
@@ -195,6 +213,9 @@ func TestScrapeV2(t *testing.T) {
 				require.NoError(t, err)
 				return mockServer
 			},
+			cfgBuilder: newTestConfigBuilder().
+				withDefaultLabels().
+				withMetrics(allMetricsEnabled),
 		},
 		{
 			desc:                "scrapeV2_pid_stats_max",
@@ -210,6 +231,9 @@ func TestScrapeV2(t *testing.T) {
 				require.NoError(t, err)
 				return mockServer
 			},
+			cfgBuilder: newTestConfigBuilder().
+				withDefaultLabels().
+				withMetrics(allMetricsEnabled),
 		},
 		{
 			desc:                "cgroups_v2_container",
@@ -224,6 +248,27 @@ func TestScrapeV2(t *testing.T) {
 				require.NoError(t, err)
 				return mockServer
 			},
+			cfgBuilder: newTestConfigBuilder().
+				withDefaultLabels().
+				withMetrics(allMetricsEnabled),
+		},
+		{
+			desc:                "scrapeV2_single_container_with_optional_resource_attributes",
+			expectedMetricsFile: filepath.Join(mockFolder, "single_container_with_optional_resource_attributes", "expected_metrics.yaml"),
+			mockDockerEngine: func(t *testing.T) *httptest.Server {
+				containerID := "73364842ef014441cac89fed05df19463b1230db25a31252cdf82e754f1ec581"
+				mockServer, err := dockerMockServer(&map[string]string{
+					"/v1.23/containers/json":                      filepath.Join(mockFolder, "single_container_with_optional_resource_attributes", "containers.json"),
+					"/v1.23/containers/" + containerID + "/json":  filepath.Join(mockFolder, "single_container_with_optional_resource_attributes", "container.json"),
+					"/v1.23/containers/" + containerID + "/stats": filepath.Join(mockFolder, "single_container_with_optional_resource_attributes", "stats.json"),
+				})
+				require.NoError(t, err)
+				return mockServer
+			},
+			cfgBuilder: newTestConfigBuilder().
+				withDefaultLabels().
+				withMetrics(allMetricsEnabled).
+				withResourceAttributes(allResourceAttributesEnabled),
 		},
 	}
 
@@ -232,19 +277,8 @@ func TestScrapeV2(t *testing.T) {
 			mockDockerEngine := tc.mockDockerEngine(t)
 			defer mockDockerEngine.Close()
 
-			cfg := createDefaultConfig().(*Config)
-			cfg.Endpoint = mockDockerEngine.URL
-			cfg.EnvVarsToMetricLabels = map[string]string{
-				"ENV_VAR":   "env-var-metric-label",
-				"ENV_VAR_2": "env-var-metric-label-2",
-			}
-			cfg.ContainerLabelsToMetricLabels = map[string]string{
-				"container.label":   "container-metric-label",
-				"container.label.2": "container-metric-label-2",
-			}
-			cfg.MetricsBuilderConfig.Metrics = allMetricsEnabled
-
-			receiver := newReceiver(receivertest.NewNopCreateSettings(), cfg)
+			receiver := newReceiver(
+				receivertest.NewNopCreateSettings(), tc.cfgBuilder.withEndpoint(mockDockerEngine.URL).build())
 			err := receiver.start(context.Background(), componenttest.NewNopHost())
 			require.NoError(t, err)
 
@@ -335,3 +369,42 @@ func dockerMockServer(urlToFile *map[string]string) (*httptest.Server, error) {
 		_, _ = rw.Write(data)
 	})), nil
 }
+
+type testConfigBuilder struct {
+	config *Config
+}
+
+func newTestConfigBuilder() *testConfigBuilder {
+	return &testConfigBuilder{config: createDefaultConfig().(*Config)}
+}
+
+func (cb *testConfigBuilder) withEndpoint(endpoint string) *testConfigBuilder {
+	cb.config.Endpoint = endpoint
+	return cb
+}
+
+func (cb *testConfigBuilder) withMetrics(ms metadata.MetricsConfig) *testConfigBuilder {
+	cb.config.MetricsBuilderConfig.Metrics = ms
+	return cb
+}
+
+func (cb *testConfigBuilder) withResourceAttributes(ras metadata.ResourceAttributesConfig) *testConfigBuilder {
+	cb.config.MetricsBuilderConfig.ResourceAttributes = ras
+	return cb
+}
+
+func (cb *testConfigBuilder) withDefaultLabels() *testConfigBuilder {
+	cb.config.EnvVarsToMetricLabels = map[string]string{
+		"ENV_VAR":   "env-var-metric-label",
+		"ENV_VAR_2": "env-var-metric-label-2",
+	}
+	cb.config.ContainerLabelsToMetricLabels = map[string]string{
+		"container.label":   "container-metric-label",
+		"container.label.2": "container-metric-label-2",
+	}
+	return cb
+}
+
+func (cb *testConfigBuilder) build() *Config {
+	return cb.config
+}