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

Fix broken link in Prometheus exporter README. Fixes #4399 #4485

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

yrsuthari
Copy link

Description

This PR fixes the broken link in the Prometheus exporter README.rst by updating it to point to the current documentation location on opentelemetry.io.

The old link pointed to a non-existent page on readthedocs:
https://opentelemetry-python.readthedocs.io/en/latest/exporter/prometheus/prometheus.html

The new link points to the current documentation:
https://opentelemetry.io/docs/instrumentation/python/exporters/#prometheus

Fixes #4399

Type of change

  • 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?

  • Verified that the new link is accessible and points to the correct documentation
  • Checked that the RST formatting is correct in the README file

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

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

@yrsuthari yrsuthari requested a review from a team as a code owner March 13, 2025 16:48
Copy link

linux-foundation-easycla bot commented Mar 13, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

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.

I think we are still missing the prometheus-exporter docs published on the opentelemetry-python readthedocs

@yrsuthari yrsuthari force-pushed the fix-prometheus-exporter-link branch from 8f1efc4 to e392725 Compare March 19, 2025 05:43
@yrsuthari yrsuthari requested a review from emdneto March 19, 2025 05:44
@yrsuthari yrsuthari force-pushed the fix-prometheus-exporter-link branch 3 times, most recently from df0832f to 3e12137 Compare March 20, 2025 09:34
@yrsuthari
Copy link
Author

I think we are still missing the prometheus-exporter docs published on the opentelemetry-python readthedocs

Could you please take a look now @emdneto

@yrsuthari yrsuthari force-pushed the fix-prometheus-exporter-link branch from 3e12137 to ba0885b Compare March 20, 2025 17:21
@yrsuthari yrsuthari requested a review from emdneto March 26, 2025 13:31
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 when docs CI gets fixed. I think it's just a matter of adding the prometheus_client dependency in tox

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken link in exporter/opentelemetry-exporter-prometheus README
3 participants