Skip to content

Document that Prometheus exporter does not work with multiprocessing #4711

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
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Document that Prometheus exporter does not work with multiprocessing #4711

wants to merge 5 commits into from
+10 −0

Conversation

bastbu
Copy link

@bastbu bastbu commented Aug 5, 2025 •
edited
Loading

Description

This PR adds a note to the documentation of the Prometheus exporter to make it clear that the exporter does not work when using multiprocessing.

Applies to #3747

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?

No tests - documentation update.

Does This PR Require a Contrib Repo Change?

  • Yes.
  • No.

Checklist:

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

@bastbu bastbu marked this pull request as ready for review August 5, 2025 13:02
@bastbu bastbu requested a review from a team as a code owner August 5, 2025 13:02
@tammy-baylis-swi
Copy link
Contributor

Thank you for this PR!

Could the warning also be added to the docs-level rst?: https://github.com/open-telemetry/opentelemetry-python/blob/cf31a6967aac76663b4cca023b5d760fd6eb5355/docs/exporter/prometheus/prometheus.rst

@bastbu
Copy link
Author

bastbu commented Aug 7, 2025

Thank you for this PR!

Could the warning also be added to the docs-level rst?: https://github.com/open-telemetry/opentelemetry-python/blob/cf31a6967aac76663b4cca023b5d760fd6eb5355/docs/exporter/prometheus/prometheus.rst

Sure, added it in both places now.

tammy-baylis-swi
tammy-baylis-swi approved these changes Aug 7, 2025
View reviewed changes
Copy link
Contributor

@tammy-baylis-swi tammy-baylis-swi 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 that, I think this is good. The maintainers will be the next to look at this.

emdneto
emdneto reviewed Aug 11, 2025
View reviewed changes
xrmx
xrmx requested changes Aug 18, 2025
View reviewed changes
docs/exporter/prometheus/prometheus.rst
@@ -47,6 +47,11 @@ The following environment variables are supported:
* ``OTEL_EXPORTER_PROMETHEUS_HOST`` (default: "localhost"): The host to bind to
* ``OTEL_EXPORTER_PROMETHEUS_PORT`` (default: 9464): The port to bind to

Limitations
-----------------
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't these underlines be as long as the text?

@xrmx xrmx added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Aug 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xrmx xrmx xrmx requested changes

@emdneto emdneto emdneto approved these changes

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

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@bastbu @tammy-baylis-swi @xrmx @emdneto