opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard

[chore] Fix links to JMX Metric Insights docs

Open asweet-confluent opened this issue 4 months ago • 6 comments

This PR updates links to the JMX Metric Insights module documentation. The README file seems to have moved from instrumentation/jmx-metrics/javaagent/README.md to instrumentation/jmx-metrics/README.md.

I opted to explicitly link to README.md in a few cases so that it will be easier to find these dead links.

https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/README.md

I also updated the links to the built-in rules files to reflect the current state of the repo.

asweet-confluent avatar Aug 08 '25 18:08 asweet-confluent

Hi @asweet-confluent! Thanks for providing a more specific link in the ~~Java~~ demo docs. That's a great improvement.

As for the blog post updates, we see blogs as snapshots in time, so we don't normally go back and update them. Instead, we apply a warning to older blog posts, as you can see on the JVX Metric Insight post from 2023. Could you remove the blog changes from this PR? Thank you!

tiffany76 avatar Aug 12 '25 16:08 tiffany76

Hi @asweet-confluent! Did you get a chance to see @tiffany76's last comment?

/cc @open-telemetry/demo-approvers PTAL!

vitorvasc avatar Dec 01 '25 09:12 vitorvasc

/fix:refcache

vitorvasc avatar Dec 01 '25 09:12 vitorvasc

fix:refcache applied successfully in run 19817615817.

otelbot-docs[bot] avatar Dec 01 '25 09:12 otelbot-docs[bot]

Did you get a chance to see @tiffany76's last comment?

I did not! Totally missed this.

As for the blog post updates, we see blogs as snapshots in time, so we don't normally go back and update them. .... Could you remove the blog changes from this PR? Thank you!

I can understand not wanting to revise the actual content and I would be happy to remove those changes, but are you saying you don't even want to update dead links like this? That blog post is the first result when searching for "opentelemetry jmx", so maybe it's worth updating them?

asweet-confluent avatar Dec 02 '25 18:12 asweet-confluent

Did you get a chance to see @tiffany76's last comment?

I did not! Totally missed this.

As for the blog post updates, we see blogs as snapshots in time, so we don't normally go back and update them. .... Could you remove the blog changes from this PR? Thank you!

I can understand not wanting to revise the actual content and I would be happy to remove those changes, but are you saying you don't even want to update dead links like this? That blog post is the first result when searching for "opentelemetry jmx", so maybe it's worth updating them?

It's a slippery slop, every time we do an exception, we need to ask ourselves the next time, why not do an exception also this time? That's why we created this rule in the first place. What we should have done back then is not pointing to main but to the actual release/commit at that point in time, this is maybe something we need to put into our blog guidelines as well.

Finally, I would prefer to see a section on JMX in the java docs, since I suspect that this is a topic people search for more often.

Let me create issues accordingly.

Can you drop the changes to the blog then we are good to go with this one!

svrnm avatar Dec 04 '25 11:12 svrnm