Update internal telemetry docs #6484
Conversation
opentelemetrybot
requested review from
a team and
atoulme
and removed request for
a team
|
0.122.0 has been released, this is now unblocked. |
chalin
force-pushed
the
update-batch-processor-metrics-level
branch
from
7a3d2ca to
c1bda57
Compare
| {{% alert title="Note" color="info" %}} Aside from | ||
| `otelcol_processor_batch_batch_send_size_bytes` which has been `detailed` since | ||
| its introduction, the other batch processor metrics were `basic` until they were | ||
| switched to `normal` in Collector | ||
| [v0.99.0](https://github.com/open-telemetry/opentelemetry-collector/releases/tag/v0.99.0). | ||
| They were accidentally switched back to `basic` in v0.109.0, which was fixed in | ||
| v0.122.0. {{% /alert %}} |
There was a problem hiding this comment.
I wonder how useful this note is for the average reader. It feels like more (historical) detail than we actually need to document. WDYT @tiffany76 @theletterf @open-telemetry/docs-approvers?
If we do keep it, the text should be reworked:
- Add a comma before "which"
- I prefer the previous formulation, suggested in Update internal telemetry docs #6484 (comment)
- Other edits might be necessary
There was a problem hiding this comment.
I don't know if all that many users are using the very latest Collector version at all times, so since we don't have "per-version" documentation, I think it could still be useful to document changes while the metrics aren't stable? But I'll leave it to docs-approvers judgment.
There was a problem hiding this comment.
I agree with @jade-guiton-dd that there are a lot of users working with older versions of the Collector, as evidenced by community Slack conversations. The internal telemetry page also sees a fair bit of use (it's the 58th most viewed docs page so far this year). I think it's worth being explicit about these nuances while the changes are still recent. We can remove the note later if the versions are so outdated that it's unlikely anyone is still using them.
As for the text, I personally like the way @jade-guiton-dd has written it. It's succinct and clear. But I'm open to edits as well.
This PR in the Collector, which moves some internal Collector metrics from the
basiclevel tonormal, was recently merged and should be part of the next release (v0.122.0). This PR updates the docs related to internal telemetry to reflect this change, and should probably wait until the release of 0.122.0 on March 17 before being merged.This PR also adds a note detailing the history of changes to these metrics' level. (This is the PR that initially restricted them to
normal, and I believe this is the PR that accidentally moved them back tobasic.)Preview: https://deploy-preview-6484--opentelemetry.netlify.app/docs/collector/internal-telemetry/#lists-of-internal-metrics