Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve scrapers/mdatagen tool to produce more user-friendly code and support user settings #10904

Open
30 of 33 tasks
dmitryax opened this issue Nov 24, 2021 · 8 comments
Open
30 of 33 tasks
Labels
cmd/mdatagen enhancement New feature or request

Comments

@dmitryax
Copy link
Member

dmitryax commented Nov 24, 2021

Metrics Builder for Scraper Receivers

Design document: https://docs.google.com/document/d/1OwDbIFlugS1rR0STv7rYBYcUjDZQ45pyVUvOSFfaRp4

Goals

Provide a user-friendly interface for metrics reporting by mdatagen tool

Currently mdatagen tool produces generated_metrics.go files that contain mostly definitions of the metrics taken from metadata.yaml files. Scraper authors have to add some amount of repetitive code to each of the scrapers to fill the metrics with data points and send them downstream. We want to reduce the amount of the repetitive code and provide scraper authors with a simple interface for reporting metrics that will be generated from metadata.yaml files.

Ability to change the default metrics representation by applying user settings

We need a way to customize the default representation of the metrics generated by mdatagen based on user's config. Once we move metrics generation to the Metrics Builder generated by mdatagen, it'll be be possible to customize metrics based on user settings.

As the first step, we want to provide a way to enable or disable any metrics based on user config. This functionality should be encapsulated in the Metrics Builder generated by mdatagen, so scraper authors don't need to deal with user settings. This will also provide a way to introduce optional metrics which are disabled by default just by changing metadata.yaml properties.

Progress

Metrics builder functionality:

Migrated scrapers:

Additional improvements

@abhide
Copy link
Member

abhide commented Dec 17, 2021

@dmitryax I would like to work on networkscraper receiver.

@abhide
Copy link
Member

abhide commented Jan 11, 2022

@dmitryax I would like to work on filesystemscraper receiver.

@dmitryax
Copy link
Member Author

dmitryax commented Jan 12, 2022

@abhide sounds good, thanks! I converted the action item into another issue open-telemetry/opentelemetry-collector-contrib#7136

@rogercoll
Copy link
Contributor

@dmitryax I would like to work on the memoryscraper receiver.

@github-actions
Copy link
Contributor

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

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

@github-actions
Copy link
Contributor

github-actions bot commented Apr 5, 2023

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

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

@github-actions github-actions bot added the Stale label Apr 5, 2023
@dmitryax dmitryax removed the Stale label Apr 5, 2023
Copy link
Contributor

github-actions bot commented Nov 6, 2023

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

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

@github-actions github-actions bot added the Stale label Nov 6, 2023
@dmitryax dmitryax removed the Stale label Nov 6, 2023
@codeboten codeboten transferred this issue from open-telemetry/opentelemetry-collector-contrib Aug 16, 2024
@codeboten
Copy link
Contributor

transferred issue as mdatagen lives in the core repo now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cmd/mdatagen enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants