Skip to content

Conversation

@DomGarguilo
Copy link
Member

This PR adds notes regarding updated setup for tracing. This is being added to the end of https://accumulo.apache.org/blog/2022/06/22/2.1.0-metrics-and-tracing.html

Here is what these additions look like:
image

The original notes that inspired this PR were created by @keith-turner

@DomGarguilo DomGarguilo requested a review from keith-turner April 4, 2025 20:30
@DomGarguilo DomGarguilo self-assigned this Apr 4, 2025
8. View traces in Jaeger UI at http://localhost:16686. You can select the service name on the left panel and click `Find Traces` to view the trace information. If everything is working correctly, then you should see something like the image below.

![Jaeger Screenshot](/images/blog/202206_metrics_and_tracing/Jaeger_Screenshot.png)

Copy link
Contributor

Choose a reason for hiding this comment

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

The blog post was for the 2.1.0 release. It looks like the addition here updates / replaces items 5 and 6 above. I'm thinking that we should put a note in items 5 and 6 that says something like:

This contains instructions for configuring OpenTelemetry and Jaeger with Accumulo 2.1.0. As of Accumulo 2.1.4 the version of OpenTelemetry has been updated and the instructions have changed. See below for more information.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good idea. Added in 4b88f58.

Copy link
Member Author

Choose a reason for hiding this comment

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

Screenshot from 2025-04-08 14-52-32
Screenshot from 2025-04-08 14-52-18

Copy link
Member

@ctubbsii ctubbsii left a comment

Choose a reason for hiding this comment

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

An alternative to having an addendum, would be just to edit the page replacing the old instructions with the current ones, and have a note that says something short that says:

These instructions were updated from an earlier version to work with Accumulo 2.1.4 and OpenTelemetry 1.48.

Or, instead of modifying the document in place, you can release a copy of the blog post with a newer date, with those same edits, and link back to this one as the earlier version. That way, the earlier version is left unmodified, in case anybody wants to easily reference it, and we get more succinct current instructions that aren't bloated with the older ones as well.

Comment on lines 155 to 157
## Note for Recent Accumulo Versions (April 2025)

**Note:** This section replaces steps 5 and 6 in the [Tracing Example](#tracing-example) above. Follow steps 1-4 from the original instructions, then use the updated configuration below instead of steps 5-6, and continue with steps 7-8 to view traces in Jaeger.
Copy link
Member

Choose a reason for hiding this comment

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

This all seems fine, but is this really a note for recent Accumulo versions, or is it a note for newer OpenTelemetry versions? Somebody could use the newer OpenTelemetry libraries with the older Accumulo releases, in which case, these instructions would apply, right? Likewise, somebody could use a newer version of Accumulo but with an older version of OpenTelemetry, in which case the older instructions would apply?

I think the instructions are clear, but it is not clear to me that the conditions under which you use them are correctly or clearly being communicated. I think the version of Open Telemetry is much more important than the version of Accumulo for this. And, I think it's wrong to assume that the versions in Accumulo's POMs are the authoritative source for what the user is (or should be) running.

Users are responsible for their own CLASSPATH, including updating them, even for older versions of Accumulo, in response to CVEs, bug fixes, dependency convergence, integration issues, etc. That is a downstream responsibility. So, we should be careful to word things without making assumptions that the dependencies we reference in our POM are what users are, or should be, using.

It might be more correct and clear to say something like: "Accumulo X was released compiled and tested with OpenTelemetry Y, which uses the Z property to configure...", rather than say "For Accumulo X, you need to set Z property ...."; the latter might be true, but only for very specific assumptions.

@DomGarguilo
Copy link
Member Author

@ctubbsii I tried to address your comments in e4ec9cd.

An alternative to having an addendum, would be just to edit the page replacing the old instructions with the current ones, and have a note that says something short that says:

These instructions were updated from an earlier version to work with Accumulo 2.1.4 and OpenTelemetry 1.48.

Or, instead of modifying the document in place, you can release a copy of the blog post with a newer date, with those same edits, and link back to this one as the earlier version. That way, the earlier version is left unmodified, in case anybody wants to easily reference it, and we get more succinct current instructions that aren't bloated with the older ones as well.

I think I prefer the addendum approach since it preserves the old instructions which some may still find helpful while also adding the new stuff without causing too much churn.

Comment on lines -88 to +90
![Grafana Screenshot](/images/blog/202206_metrics_and_tracing/Grafana_Screenshot.png)
<a class="p-3 border rounded d-block" href="{{ site.baseurl }}/images/blog/202206_metrics_and_tracing/Grafana_Screenshot.png">
<img src="{{ site.baseurl }}/images/blog/202206_metrics_and_tracing/Grafana_Screenshot.png" class="img-fluid rounded" alt="Grafana Screenshot"/>
</a>
Copy link
Member Author

Choose a reason for hiding this comment

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

While I was making changes to this file I decided to add the styling we use in other pages for these screenshots. This helps the images remain in line with the other content.

For example:
image

Copy link
Member

Choose a reason for hiding this comment

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

It doesn't matter, really, but I think there's probably a way to specify the class on the image or at least on the section (div or p) containing the image, in the markdown form, that might be easier to read or maintain. Markdown, in general, is easier to work with than the raw HTML, but like I said, this doesn't really matter. The raw HTML is fine.

Comment on lines -88 to +90
![Grafana Screenshot](/images/blog/202206_metrics_and_tracing/Grafana_Screenshot.png)
<a class="p-3 border rounded d-block" href="{{ site.baseurl }}/images/blog/202206_metrics_and_tracing/Grafana_Screenshot.png">
<img src="{{ site.baseurl }}/images/blog/202206_metrics_and_tracing/Grafana_Screenshot.png" class="img-fluid rounded" alt="Grafana Screenshot"/>
</a>
Copy link
Member

Choose a reason for hiding this comment

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

It doesn't matter, really, but I think there's probably a way to specify the class on the image or at least on the section (div or p) containing the image, in the markdown form, that might be easier to read or maintain. Markdown, in general, is easier to work with than the raw HTML, but like I said, this doesn't really matter. The raw HTML is fine.

@DomGarguilo DomGarguilo merged commit 7f5fdef into apache:main Apr 23, 2025
1 check passed
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.

3 participants