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

docs(receiver/hostmetrics/process): update descriptions of OS-specific metrics #18051

Merged

Conversation

andrzej-stencel
Copy link
Member

Description:

The two metrics are Linux-only (not supported on Windows) but there was no mention of this in the documentation:

  • process.open_file_descriptors
  • process.context_switches

I have added "This metric is only available on Linux" similar to what other Linux-only metrics have.

Link to tracking Issue: #17555

Testing: N/A

Documentation: Yes 🙂

@runforesight
Copy link

runforesight bot commented Jan 26, 2023

Foresight Summary

    
Major Impacts

build-and-test-windows duration(6 seconds) has decreased 42 minutes 16 seconds compared to main branch avg(42 minutes 22 seconds).
View More Details

✅  tracegen workflow has finished in 1 minute 10 seconds (1 minute 14 seconds less than main branch avg.) and finished at 26th Jan, 2023.


Job Failed Steps Tests
build-dev -     🔗  N/A See Details
publish-latest -     🔗  N/A See Details
publish-stable -     🔗  N/A See Details

⭕  build-and-test-windows workflow has finished in 6 seconds (42 minutes 3 seconds less than main branch avg.) and finished at 23rd Feb, 2023.


Job Failed Steps Tests
windows-unittest -     🔗  N/A See Details
windows-unittest-matrix -     🔗  N/A See Details

⭕  changelog workflow has finished in 5 seconds (2 minutes 41 seconds less than main branch avg.) and finished at 23rd Feb, 2023.


Job Failed Steps Tests
changelog -     🔗  N/A See Details

✅  check-links workflow has finished in 2 minutes 45 seconds and finished at 23rd Feb, 2023.


Job Failed Steps Tests
changed files -     🔗  N/A See Details
check-links -     🔗  N/A See Details

✅  telemetrygen workflow has finished in 3 minutes 11 seconds and finished at 23rd Feb, 2023.


Job Failed Steps Tests
build-dev -     🔗  N/A See Details
publish-latest -     🔗  N/A See Details
publish-stable -     🔗  N/A See Details

✅  load-tests workflow has finished in 15 minutes 9 seconds (2 minutes 21 seconds less than main branch avg.) and finished at 23rd Feb, 2023.


Job Failed Steps Tests
loadtest (TestIdleMode) -     🔗  ✅ 1  ❌ 0  ⏭ 0    🔗 See Details
loadtest (TestBallastMemory|TestLog10kDPS) -     🔗  ✅ 18  ❌ 0  ⏭ 0    🔗 See Details
loadtest (TestMetricResourceProcessor|TestTrace10kSPS) -     🔗  ✅ 12  ❌ 0  ⏭ 0    🔗 See Details
loadtest (TestMetric10kDPS|TestMetricsFromFile) -     🔗  ✅ 6  ❌ 0  ⏭ 0    🔗 See Details
loadtest (TestTraceAttributesProcessor) -     🔗  ✅ 3  ❌ 0  ⏭ 0    🔗 See Details
loadtest (TestTraceBallast1kSPSWithAttrs|TestTraceBallast1kSPSAddAttrs) -     🔗  ✅ 10  ❌ 0  ⏭ 0    🔗 See Details
loadtest (TestTraceNoBackend10kSPS|TestTrace1kSPSWithAttrs) -     🔗  ✅ 8  ❌ 0  ⏭ 0    🔗 See Details
setup-environment -     🔗  N/A See Details

✅  prometheus-compliance-tests workflow has finished in 9 minutes 49 seconds and finished at 23rd Feb, 2023.


Job Failed Steps Tests
prometheus-compliance-tests -     🔗  ✅ 21  ❌ 0  ⏭ 0    🔗 See Details

✅  build-and-test workflow has finished in 55 minutes 50 seconds (12 minutes 42 seconds less than main branch avg.) and finished at 23rd Feb, 2023.


Job Failed Steps Tests
unittest-matrix (1.19, internal) -     🔗  ✅ 561  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.20, internal) -     🔗  ✅ 561  ❌ 0  ⏭ 0    🔗 See Details
correctness-metrics -     🔗  ✅ 2  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.19, processor) -     🔗  ✅ 1511  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.19, extension) -     🔗  ✅ 537  ❌ 0  ⏭ 0    🔗 See Details
correctness-traces -     🔗  ✅ 17  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.20, extension) -     🔗  ✅ 537  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.20, processor) -     🔗  ✅ 1511  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.19, receiver-0) -     🔗  ✅ 2577  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.20, receiver-0) -     🔗  ✅ 2577  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.19, exporter) -     🔗  ✅ 2457  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.20, exporter) -     🔗  ✅ 2457  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.19, receiver-1) -     🔗  ✅ 1932  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.20, receiver-1) -     🔗  ✅ 1932  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.19, other) -     🔗  ✅ 4772  ❌ 0  ⏭ 0    🔗 See Details
unittest-matrix (1.20, other) -     🔗  ✅ 4772  ❌ 0  ⏭ 0    🔗 See Details
integration-tests -     🔗  ✅ 55  ❌ 0  ⏭ 0    🔗 See Details
setup-environment -     🔗  N/A See Details
lint-matrix (receiver-0) -     🔗  N/A See Details
lint-matrix (receiver-1) -     🔗  N/A See Details
lint-matrix (processor) -     🔗  N/A See Details
lint-matrix (exporter) -     🔗  N/A See Details
lint-matrix (extension) -     🔗  N/A See Details
lint-matrix (internal) -     🔗  N/A See Details
lint-matrix (other) -     🔗  N/A See Details
build-examples -     🔗  N/A See Details
check-codeowners -     🔗  N/A See Details
check-collector-module-version -     🔗  N/A See Details
checks -     🔗  N/A See Details
lint -     🔗  N/A See Details
unittest (1.20) -     🔗  N/A See Details
unittest (1.19) -     🔗  N/A See Details
cross-compile (darwin, amd64) -     🔗  N/A See Details
cross-compile (darwin, arm64) -     🔗  N/A See Details
cross-compile (linux, 386) -     🔗  N/A See Details
cross-compile (linux, amd64) -     🔗  N/A See Details
cross-compile (linux, arm) -     🔗  N/A See Details
cross-compile (linux, arm64) -     🔗  N/A See Details
cross-compile (linux, ppc64le) -     🔗  N/A See Details
cross-compile (windows, 386) -     🔗  N/A See Details
cross-compile (windows, amd64) -     🔗  N/A See Details
build-package (deb) -     🔗  N/A See Details
build-package (rpm) -     🔗  N/A See Details
windows-msi -     🔗  N/A See Details
publish-check -     🔗  N/A See Details
publish-dev -     🔗  N/A See Details
publish-stable -     🔗  N/A See Details

✅  e2e-tests workflow has finished in 21 minutes 4 seconds (⚠️ 5 minutes 10 seconds more than main branch avg.) and finished at 23rd Feb, 2023.


Job Failed Steps Tests
kubernetes-test (v1.24.7) -     🔗  N/A See Details
kubernetes-test (v1.26.0) -     🔗  N/A See Details
kubernetes-test (v1.25.3) -     🔗  N/A See Details
kubernetes-test (v1.23.13) -     🔗  N/A See Details

🔎 See details on Foresight

*You can configure Foresight comments in your organization settings page.

@andrzej-stencel
Copy link
Member Author

I'm not sure this change needs a changelog entry? I guess for a description update a changelog entry is not needed?

@andrzej-stencel andrzej-stencel force-pushed the linux-only-metrics-description branch from 446367a to 992ced6 Compare January 26, 2023 08:37
@andrzej-stencel
Copy link
Member Author

@evan-bradley hope you can take a look, as you originally added these metrics in #12972.

@andrzej-stencel
Copy link
Member Author

A test failed with a 429 from GitHub 😕

Error: fatal: unable to access 'https://github.com/open-telemetry/opentelemetry-collector-contrib/': The requested URL returned error: 429

Copy link
Member

@dmitryax dmitryax left a comment

Choose a reason for hiding this comment

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

Thanks @astencel-sumo,

Are these two metrics the only platform-specific ones?

@dmitryax dmitryax added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jan 26, 2023
@dmitryax
Copy link
Member

I'm not sure this change needs a changelog entry? I guess for a description update a changelog entry is not needed?

I don't think changelog entry is needed if it's documentation update only

@andrzej-stencel andrzej-stencel force-pushed the linux-only-metrics-description branch from 992ced6 to 0a1c1f0 Compare February 8, 2023 16:08
…c metrics

The two metrics are Linux-only (not supported on Windows)
but there was no mention of this in the documentation:
- process.open_file_descriptors
- process.context_switches
I have added "This metric is only available on Linux"
similar to what other Linux-only metrics have.
@andrzej-stencel
Copy link
Member Author

andrzej-stencel commented Feb 8, 2023

Are these two metrics the only platform-specific ones?

@dmitryax To my knowledge only these two and two more, which already had this in their description (moved to extended documentation).

Copy link
Contributor

@evan-bradley evan-bradley left a comment

Choose a reason for hiding this comment

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

Thanks for catching this. I checked and indeed gopsutil only provides context switch metrics on Linux.

@github-actions
Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 14 days.

@andrzej-stencel
Copy link
Member Author

@dmitryax can we get this merged?

@dmitryax
Copy link
Member

Sure, sorry for the delay

@dmitryax dmitryax closed this Feb 23, 2023
@dmitryax dmitryax reopened this Feb 23, 2023
@codeboten codeboten merged commit 4853ffa into open-telemetry:main Feb 24, 2023
@andrzej-stencel andrzej-stencel deleted the linux-only-metrics-description branch February 24, 2023 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
receiver/hostmetrics Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants