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.

Sign up for GitHub

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

Jump to bottom

opentelemetry-instrumentation-system-metrics: add process metrics #3250

Merged
merged 13 commits into from
Feb 21, 2025
Merged

opentelemetry-instrumentation-system-metrics: add process metrics #3250

merged 13 commits into from
Feb 21, 2025

Conversation

xrmx
Copy link
Contributor

@xrmx xrmx commented Feb 7, 2025 •
edited
Loading

Description

Add process metrics as of 1.30.0 semconv to the system metrics instrumentation. We still keep around the old process.runtime metrics because the semconv suggest to not break current users. Still discourage their use in the doc and state explicitly they are deprecated.

Fixes #2662
Closes #2727

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • tox -e py310-test-instrumentation-system-metrics

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

xrmx added 2 commits February 7, 2025 16:25
@xrmx
opentelemetry-instrumentation-system-metrics: add process metrics
821e71c 
Add process metrics as of 1.30.0 semconv to the system metrics instrumentation.
We still keep around the old process.runtime metrics because the semconv
suggest to not break current users. Still discourage their use in the
doc and state explicitly they are deprecated.
@xrmx
Add Changelog
01ee403
@xrmx xrmx requested a review from a team as a code owner February 7, 2025 15:30
@xrmx xrmx mentioned this pull request Feb 7, 2025
Closed
@xrmx xrmx requested a review from emdneto February 18, 2025 13:59
emdneto
emdneto approved these changes Feb 20, 2025
View reviewed changes
Copy link
Member

@emdneto emdneto left a comment

Choose a reason for hiding this comment

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

LGTM. Not sure when semantic conventions for system-metrics will change from experimental to stable, so we'll need to keep process.runtime for a while

@xrmx xrmx enabled auto-merge (squash) February 21, 2025 08:52
@xrmx xrmx merged commit b5a0ee5 into open-telemetry:main Feb 21, 2025
694 checks passed
alexmojaki
alexmojaki reviewed Mar 13, 2025
View reviewed changes
...-instrumentation-system-metrics/src/opentelemetry/instrumentation/system_metrics/__init__.py
Comment on lines +40 to +41
"process.memory.usage": None,
"process.memory.virtual": None,
Copy link
Contributor

Choose a reason for hiding this comment

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

Am I correct that these two combine to replace "process.runtime.memory": ["rss", "vms"],?

alexmojaki
alexmojaki reviewed Mar 13, 2025
View reviewed changes
...-instrumentation-system-metrics/src/opentelemetry/instrumentation/system_metrics/__init__.py
"process.memory.usage": None,
"process.memory.virtual": None,
"process.open_file_descriptor.count": None,
"process.thread.count": None,
"process.runtime.memory": ["rss", "vms"],
"process.runtime.cpu.time": ["user", "system"],
"process.runtime.gc_count": None,
Copy link
Contributor

Choose a reason for hiding this comment

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

This won't be deprecated, right?

@alexmojaki alexmojaki mentioned this pull request Mar 14, 2025
Merged
alexmojaki
alexmojaki reviewed Mar 14, 2025
View reviewed changes
...-instrumentation-system-metrics/src/opentelemetry/instrumentation/system_metrics/__init__.py
@@ -112,13 +126,19 @@
"system.network.io": ["transmit", "receive"],
"system.network.connections": ["family", "type"],
"system.thread_count": None,
"process.context_switches": ["involuntary", "voluntary"],
"process.cpu.time": ["user", "system"],
"process.cpu.utilization": ["user", "system"],
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are there config values here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alexmojaki alexmojaki alexmojaki left review comments

@emdneto emdneto emdneto approved these changes

@lzchen lzchen lzchen approved these changes

@tammy-baylis-swi tammy-baylis-swi tammy-baylis-swi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update OS process metrics name according to semconv
5 participants
@xrmx @alexmojaki @emdneto @lzchen @tammy-baylis-swi