Skip to content

Conversation

@kurtaking
Copy link
Contributor

This PR fixes several broken links from the documentation site to different instrumentation packages. I'm assuming this was missed during a migration of packages from plugins/node -> packages.

Example:

Looking at this documentation, clicking the second link takes you to a 404 page.

For example, to disable only @opentelemetry/instrumentation-fs and @opentelemetry/instrumentation-grpc instrumentations:

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 9, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: opentelemetrybot / name: OpenTelemetry Bot (211043c)
  • ✅ login: kurtaking / name: Kurt King (8a29f51)
  • ✅ login: svrnm / name: Severin Neumann (97abb1d)

@opentelemetrybot opentelemetrybot requested a review from a team July 9, 2025 06:24
@kurtaking kurtaking changed the title Fixes several links from the Fixes several links from the documentation site to different javascript instrumentation packages Jul 9, 2025
@kurtaking kurtaking marked this pull request as ready for review July 9, 2025 06:28
@kurtaking kurtaking requested a review from a team as a code owner July 9, 2025 06:28
Copy link
Member

@svrnm svrnm left a comment

Choose a reason for hiding this comment

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

thanks! LGTM

@trentm
Copy link
Contributor

trentm commented Jul 9, 2025

I'm assuming this was missed during a migration of packages from plugins/node -> packages.

That would be me missing this. The changes in directories in opentelemetry-js-contrib.git was done recently in open-telemetry/opentelemetry-js-contrib#2928

Thanks for doing this update!

@svrnm
Copy link
Member

svrnm commented Jul 9, 2025

/fix:all

@opentelemetrybot
Copy link
Contributor

fix:all applied successfully in this run.

@trentm
Copy link
Contributor

trentm commented Jul 9, 2025

There are still a number of hits for the old dirs. For example:

...
data/registry/instrumentation-js-memcached.yml
13:  repo: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-memcached

data/registry/instrumentation-js-aws-sdk.yml
19:  repo: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-aws-sdk

content/en/docs/zero-code/js/_index.md
59:[supported instrumentation](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/metapackages/auto-instrumentations-node#supported-instrumentations).

...

I am happy to follow-up with a second PR to catch those if you like, or I can post all of the hits I see here.


@svrnm Some of the hits for the now obsolete dirs are in static/refcache.json. Should those entries be removed?
E.g.:

static/refcache.json
9446:  "https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/metapackages/auto-instrumentations-node/README.md#supported-instrumentations": {
9458:  "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-alibaba-cloud": {
9462:  "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-aws": {
...

@svrnm
Copy link
Member

svrnm commented Jul 9, 2025

I am happy to follow-up with a second PR to catch those if you like, or I can post all of the hits I see here.

That would be appreciated

@svrnm Some of the hits for the now obsolete dirs are in static/refcache.json. Should those entries be removed?

let's leave them where they are right now, it's a long term item on our todo list to get the refcache put into action, i.e. have items removed, have them checked regularly, etc.

@kurtaking
Copy link
Contributor Author

I'm assuming this was missed during a migration of packages from plugins/node -> packages.

That would be me missing this. The changes in directories in opentelemetry-js-contrib.git was done recently in open-telemetry/opentelemetry-js-contrib#2928

Thanks for doing this update!

Ha, and thank you all for the documentation 💯

@trentm
Copy link
Contributor

trentm commented Jul 9, 2025

Here are 50 other hits: https://gist.github.com/trentm/edd6a23e7dc888e736a84ac51037a04b

If you merge this PR as is, I will follow-up with one that updates those other references.
(or, I'm totally happy if you handle those hits in this PR, @kurtaking :)

@kurtaking
Copy link
Contributor Author

Here are 50 other hits: https://gist.github.com/trentm/edd6a23e7dc888e736a84ac51037a04b

If you merge this PR as is, I will follow-up with one that updates those other references. (or, I'm totally happy if you handle those hits in this PR, @kurtaking :)

I don't mind, but it will be much later today. I am heads down on some deliverables at work.

@svrnm svrnm added this pull request to the merge queue Jul 9, 2025
@svrnm
Copy link
Member

svrnm commented Jul 9, 2025

thanks @kurtaking! we have one more PR for this: #7285

Merged via the queue into open-telemetry:main with commit c018595 Jul 9, 2025
20 checks passed
@opentelemetrybot
Copy link
Contributor

Thank you for your contribution @kurtaking! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey.

@kurtaking kurtaking deleted the fix-broken-instrumentation-ref-links branch July 9, 2025 17:53
sajibAdhi pushed a commit to sajibAdhi/opentelemetry.io that referenced this pull request Jul 16, 2025
…pt instrumentation packages (open-telemetry#7276)

Signed-off-by: Kurt King <[email protected]>
Co-authored-by: opentelemetrybot <[email protected]>
Co-authored-by: Severin Neumann <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants