Skip to content

[receiver/dockerstats] For V2 implementation, create sensible enabled defaults #14093

Merged
codeboten merged 4 commits into
open-telemetry:mainfrom
atlassian-forks:dockerstats-defaults
Sep 16, 2022
Merged

[receiver/dockerstats] For V2 implementation, create sensible enabled defaults #14093
codeboten merged 4 commits into
open-telemetry:mainfrom
atlassian-forks:dockerstats-defaults

Conversation

@jamesmoessis

@jamesmoessis jamesmoessis commented Sep 13, 2022

Copy link
Copy Markdown
Contributor

Description:

This is not a breaking change unless you are using the non-default V2 scraper which is behind a feature gate.

Currently almost every metric is enabled by default, which was done to demonstrate feature parity with the original V1 scraper which enables almost everything by default.

This changes so most metrics are not enabled by default, and instead a sensible set of defaults are enabled. There are many very detailed memory and block IO metric that 99% of users will never need, and all it does it consume needless MTS.

The change brings the default set of metrics from 63 to 14.

The new list of enabled metrics by default is below. I made it similar to the defaults of the signalfx agent. I am open to suggestions on changes here.

  • container.cpu.usage.system
  • container.cpu.usage.total
  • container.cpu.usage.kernelmode
  • container.cpu.usage.usermode
  • container.cpu.percent
  • container.memory.usage.limit
  • container.memory.usage.total
  • container.memory.percent
  • container.memory.total_cache
  • container.blockio.io_service_bytes_recursive
  • container.network.io.usage.rx_bytes
  • container.network.io.usage.tx_bytes
  • container.network.io.usage.rx_dropped
  • container.network.io.usage.tx_dropped

Link to tracking Issue:

#9794

Testing:

All unit tests still test 100% of the metrics.

Documentation:

Documentation automatically updated by go generate and mdatagen.

@jamesmoessis

Copy link
Copy Markdown
Contributor Author

FYI @MovieStoreGuy @rmfitzpatrick

Comment thread unreleased/dockerstats-defaults.yaml Outdated

@TylerHelmuth TylerHelmuth left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jamesmoessis

Copy link
Copy Markdown
Contributor Author

@TylerHelmuth this has your approval, codeowner, plus one more. Please merge whenever possible 🙂

@TylerHelmuth TylerHelmuth added the ready to merge Code review completed; ready to merge by maintainers label Sep 15, 2022
@codeboten codeboten merged commit c43205a into open-telemetry:main Sep 16, 2022
@jamesmoessis jamesmoessis deleted the dockerstats-defaults branch September 19, 2022 00:19
djaglowski pushed a commit to djaglowski/opentelemetry-collector-contrib that referenced this pull request Sep 19, 2022
… defaults (open-telemetry#14093)

This is not a breaking change unless you are using the non-default V2 scraper which is behind a feature gate.

Currently almost every metric is enabled by default, which was done to demonstrate feature parity with the original V1 scraper which enables almost everything by default.

This changes so most metrics are not enabled by default, and instead a sensible set of defaults are enabled. There are many very detailed memory and block IO metric that 99% of users will never need, and all it does it consume needless MTS.

The change brings the default set of metrics from 63 to 14.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready to merge Code review completed; ready to merge by maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants