Inconsistent Metric Descriptions Between dockerstatsreceiver and podmanstatsreceiver Causing prometheusexporter Errors

[bowling233]

Component(s)

receiver/podman

What happened?

I am using dockerstatsreceiver and podmanstatsreceiver simultaneously, but there are inconsistencies in some of the metric descriptions between them. This results in errors from the prometheusexporter (see log output for details).

Differences can be observed here:

• podmanreceiver/metadata.yaml#L80
• dockerstatsreceiver/metadata.yaml#L182

Collector version

0.111.0

Environment information

Environment

OS: Debian 12

OpenTelemetry Collector configuration

receivers:
  docker_stats:
  podman_stats:

exporters:
  prometheus:
    endpoint: localhost:9090
    send_timestamps: true
    resource_to_telemetry_conversion:
      enabled: true

service:
  pipelines:
    metrics:
      receivers: [podman_stats, docker_stats]
      processors: [memory_limiter, batch, resourcedetection]
      exporters: [prometheus]

Log output

2024-10-16T10:15:58.991Z   error   [email protected]/log.go:23   error gathering metrics: 12 error(s) occurred:
* collected metric container_memory_usage_total_bytes ... has help "Memory usage of the container." but should have "Memory usage of the container. This excludes the cache."
* collected metric container_network_io_usage_tx_bytes_total ... has help "Bytes sent." but should have "Bytes sent by the container."
......
   {"kind": "exporter", "data_type": "metrics", "name": "prometheus"}
github.com/open-telemetry/opentelemetry-collector-contrib/exporter/prometheusexporter.(*promLogger).Println
   github.com/open-telemetry/opentelemetry-collector-contrib/exporter/[email protected]/log.go:23
github.com/prometheus/client_golang/prometheus/promhttp.HandlerForTransactional.func1
   github.com/prometheus/[email protected]/prometheus/promhttp/http.go:169
net/http.HandlerFunc.ServeHTTP
   net/http/server.go:2220
net/http.(*ServeMux).ServeHTTP
   net/http/server.go:2747
go.opentelemetry.io/collector/config/confighttp.(*decompressor).ServeHTTP
   go.opentelemetry.io/collector/config/[email protected]/compression.go:168
go.opentelemetry.io/collector/config/confighttp.(*ServerConfig).ToServer.maxRequestBodySizeInterceptor.func2
   go.opentelemetry.io/collector/config/[email protected]/confighttp.go:553
net/http.HandlerFunc.ServeHTTP
   net/http/server.go:2220
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp.(*middleware).serveHTTP
   go.opentelemetry.io/contrib/instrumentation/net/http/[email protected]/handler.go:177
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp.NewMiddleware.func1.1
   go.opentelemetry.io/contrib/instrumentation/net/http/[email protected]/handler.go:65
net/http.HandlerFunc.ServeHTTP
   net/http/server.go:2220
go.opentelemetry.io/collector/config/confighttp.(*clientInfoHandler).ServeHTTP
   go.opentelemetry.io/collector/config/[email protected]/clientinfohandler.go:26
net/http.serverHandler.ServeHTTP
   net/http/server.go:3210
net/http.(*conn).serve
   net/http/server.go:2092

Additional context

No response

[github-actions]

Pinging code owners:

• receiver/podman: @rogercoll

See Adding Labels via Comments if you do not have permissions to add labels yourself.