[podmanreceiver] Add metrics and resource metadata

.chloggen/add_podman_metadata.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. filelogreceiver)
+component: podmanreceiver
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: "Adds metrics and resources metadata"
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [28640]
+
+# (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:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# 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/validate_test.go

@@ -108,9 +108,17 @@ func TestValidate(t *testing.T) {
 
 func TestValidateMetricDuplicates(t *testing.T) {
 	allowedMetrics := map[string][]string{
-		"container.cpu.utilization": {"docker_stats", "kubeletstats"},
-		"container.memory.rss":      {"docker_stats", "kubeletstats"},
-		"container.uptime":          {"docker_stats", "kubeletstats"},
+		"container.cpu.utilization":           {"docker_stats", "kubeletstats"},
+		"container.cpu.usage.system":          {"docker_stats", "podman_stats"},
+		"container.cpu.usage.percpu":          {"docker_stats", "podman_stats"},
+		"container.cpu.usage.total":           {"docker_stats", "podman_stats"},
+		"container.memory.usage.limit":        {"docker_stats", "podman_stats"},
+		"container.memory.percent":            {"docker_stats", "podman_stats"},
+		"container.memory.usage.total":        {"docker_stats", "podman_stats"},
+		"container.network.io.usage.tx_bytes": {"docker_stats", "podman_stats"},
+		"container.network.io.usage.rx_bytes": {"docker_stats", "podman_stats"},
+		"container.memory.rss":                {"docker_stats", "kubeletstats"},
+		"container.uptime":                    {"docker_stats", "kubeletstats"},
 	}
 	allMetrics := map[string][]string{}
 	err := filepath.Walk("../../receiver", func(path string, info fs.FileInfo, err error) error {

receiver/podmanreceiver/README.md

@@ -33,6 +33,7 @@ The following settings are optional:
 - `collection_interval` (default = `10s`): The interval at which to gather container stats.
 - `initial_delay` (default = `1s`): defines how long this receiver waits before starting.
 - `timeout` (default = `5s`): The maximum amount of time to wait for Podman API responses.
+- `metrics` (defaults at [./documentation.md](./documentation.md)): Enables/disables individual metrics. See [./documentation.md](./documentation.md) for full detail.
 
 Example:
 
@@ -43,6 +44,9 @@ receivers:
     timeout: 10s
     collection_interval: 10s
     initial_delay: 1s
+    metrics:
+      container.cpu.usage.system:
+        enabled: false
 ```
 
 The full list of settings exposed for this receiver are documented [here](./config.go)
@@ -85,6 +89,8 @@ The receiver emits the following metrics:
 	container.cpu.percent
 	container.cpu.usage.percpu
 
+See [./documentation.md](./documentation.md) for full detail.
+
 ## Building
 
 This receiver uses the official libpod Go bindings for Podman. In order to include

receiver/podmanreceiver/config.go

@@ -9,6 +9,8 @@ import (
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config/configopaque"
 	"go.opentelemetry.io/collector/receiver/scraperhelper"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/podmanreceiver/internal/metadata"
 )
 
 var _ component.Config = (*Config)(nil)
@@ -22,6 +24,9 @@ type Config struct {
 	APIVersion    string              `mapstructure:"api_version"`
 	SSHKey        string              `mapstructure:"ssh_key"`
 	SSHPassphrase configopaque.String `mapstructure:"ssh_passphrase"`
+
+	// MetricsBuilderConfig config. Enable or disable stats by name.
+	metadata.MetricsBuilderConfig `mapstructure:",squash"`
 }
 
 func (config Config) Validate() error {

receiver/podmanreceiver/config_test.go

@@ -36,8 +36,9 @@ func TestLoadConfig(t *testing.T) {
 					InitialDelay:       time.Second,
 					Timeout:            5 * time.Second,
 				},
-				APIVersion: defaultAPIVersion,
-				Endpoint:   "unix:///run/podman/podman.sock",
+				APIVersion:           defaultAPIVersion,
+				Endpoint:             "unix:///run/podman/podman.sock",
+				MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
 			},
 		},
 		{
@@ -48,8 +49,9 @@ func TestLoadConfig(t *testing.T) {
 					InitialDelay:       time.Second,
 					Timeout:            20 * time.Second,
 				},
-				APIVersion: defaultAPIVersion,
-				Endpoint:   "http://example.com/",
+				APIVersion:           defaultAPIVersion,
+				Endpoint:             "http://example.com/",
+				MetricsBuilderConfig: metadata.DefaultMetricsBuilderConfig(),
 			},
 		},
 	}

receiver/podmanreceiver/documentation.md

@@ -0,0 +1,120 @@
+[comment]: <> (Code generated by mdatagen. DO NOT EDIT.)
+
+# podman_stats
+
+## Default Metrics
+
+The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:
+
+```yaml
+metrics:
+  <metric_name>:
+    enabled: false
+```
+
+### container.blockio.io_service_bytes_recursive.read
+
+Number of bytes transferred from the disk by the container
+
+[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt).
+
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| {operations} | Sum | Int | Cumulative | true |
+
+### container.blockio.io_service_bytes_recursive.write
+
+Number of bytes transferred to the disk by the container
+
+[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt).
+
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| {operations} | Sum | Int | Cumulative | true |
+
+### container.cpu.percent
+
+Percent of CPU used by the container.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| 1 | Gauge | Double |
+
+### container.cpu.usage.percpu
+
+Total CPU time consumed per CPU-core.
+
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| s | Sum | Int | Cumulative | true |
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| core | The CPU core number when utilising per-CPU metrics. | Any Str |
+
+### container.cpu.usage.system
+
+System CPU usage.
+
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| s | Sum | Int | Cumulative | true |
+
+### container.cpu.usage.total
+
+Total CPU time consumed.
+
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| s | Sum | Int | Cumulative | true |
+
+### container.memory.percent
+
+Percentage of memory used.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| 1 | Gauge | Double |
+
+### container.memory.usage.limit
+
+Memory limit of the container.
+
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| By | Sum | Int | Cumulative | false |
+
+### container.memory.usage.total
+
+Memory usage of the container.
+
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| By | Sum | Int | Cumulative | false |
+
+### container.network.io.usage.rx_bytes
+
+Bytes received by the container.
+
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| By | Sum | Int | Cumulative | true |
+
+### container.network.io.usage.tx_bytes
+
+Bytes sent by the container.
+
+| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
+| ---- | ----------- | ---------- | ----------------------- | --------- |
+| By | Sum | Int | Cumulative | true |
+
+## Resource Attributes
+
+| Name | Description | Values | Enabled |
+| ---- | ----------- | ------ | ------- |
+| container.id | The ID of the container. | Any Str | true |
+| container.image.name | The name of the 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 'podman'. | Any Str | true |

receiver/podmanreceiver/factory.go

@@ -35,6 +35,7 @@ func createDefaultConfig() *Config {
 		ScraperControllerSettings: cfg,
 		Endpoint:                  "unix:///run/podman/podman.sock",
 		APIVersion:                defaultAPIVersion,
+		MetricsBuilderConfig:      metadata.DefaultMetricsBuilderConfig(),
 	}
 }
 

receiver/podmanreceiver/go.mod

@@ -3,14 +3,14 @@ module github.com/open-telemetry/opentelemetry-collector-contrib/receiver/podman
 go 1.20
 
 require (
+	github.com/google/go-cmp v0.6.0
 	github.com/stretchr/testify v1.8.4
 	go.opentelemetry.io/collector/component v0.93.1-0.20240125183026-3cacd40b27e8
 	go.opentelemetry.io/collector/config/configopaque v0.93.1-0.20240125183026-3cacd40b27e8
 	go.opentelemetry.io/collector/confmap v0.93.1-0.20240125183026-3cacd40b27e8
 	go.opentelemetry.io/collector/consumer v0.93.1-0.20240125183026-3cacd40b27e8
 	go.opentelemetry.io/collector/pdata v1.0.2-0.20240125183026-3cacd40b27e8
 	go.opentelemetry.io/collector/receiver v0.93.1-0.20240125183026-3cacd40b27e8
-	go.opentelemetry.io/collector/semconv v0.93.1-0.20240125183026-3cacd40b27e8
 	go.opentelemetry.io/otel/metric v1.22.0
 	go.opentelemetry.io/otel/trace v1.22.0
 	go.uber.org/multierr v1.11.0