GH-31809: [Docs] Add instructions on how to collect the produced telemetry data #33873
Conversation
|
|
|
I've published a built version of the new page in the docs this PR creates to https://63d1d0cd7dae342ddeb4db1a--arrow-docs.netlify.app/cpp/opentelemetry.html for easier viewing. For whoever reviews, I think a very high-level review would be a good first step. Is this the right shape? Is this in the right location in the docs? I tried to match the style of other user guides in terms of structure and style and avoided writing this up in the more pedagogical style of https://github.com/amoeba/arrow-opentelemetry-example. |
|
Hi, I think this is a really great step because it allows users to at least get started with tracing! At some point we may want to explain some more about how to read the traces. But the telemetry code in Arrow is currently still in flux so there might be some changes coming up wrt the structure and naming of spans. Thanks for this. Maybe @mbrobbel would like to have a look? |
There was a problem hiding this comment.
This is great! I added two minor suggestions.
I agree with @joosthooz that we should defer documenting the trace structure until that stabilizes.
Co-authored-by: Matthijs Brobbel <[email protected]>
Co-authored-by: Matthijs Brobbel <[email protected]>
Just keeping these two lists in sync with one another
|
Thanks for taking a look at this @joosthooz and @mbrobbel. @mbrobbel I accepted both of your suggestions, re-wrapped your one change as you mentioned. I also replicated the changes to the the list of options for ARROW_TRACING_BACKEND in env_vars.rst so both pages are identical. An updated preview build of the docs is available at https://63d2f00e3c06c61b7852ce4a--tranquil-faloodeh-d58aad.netlify.app/cpp/opentelemetry.html. This is ready for another look and/or a merge. |
|
Hi @mbrobbel, do you want to look at this again or is this ready for a merge? |
|
I approved it, but I'm not a committer so I can't merge it. Maybe @westonpace or @lidavidm can help merge this? |
lidavidm
changed the title
|
Thank you @lidavidm! |
|
Benchmark runs are scheduled for baseline = a6ace68 and contender = 63cb14e. 63cb14e is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
…d telemetry data (apache#33873) ### Rationale for this change The codebase has been partially implemented with the OpenTelemetry SDK and it would be beneficial for users to have a concise guide on how to get started collecting and visualizing tracing data. ### What changes are included in this PR? This is an initial draft for review of an addition to the [C++ User Guide](https://arrow.apache.org/docs/dev/cpp/user_guide.html) as mentioned in apache#31809 (comment). ### Are these changes tested? These changes have been tested locally by building the docs and verifying. ### Are there any user-facing changes? Yes, but just documentation changes. * Closes: apache#31809 Lead-authored-by: Bryce Mecum <[email protected]> Co-authored-by: Matthijs Brobbel <[email protected]> Signed-off-by: David Li <[email protected]>
…d telemetry data (apache#33873) ### Rationale for this change The codebase has been partially implemented with the OpenTelemetry SDK and it would be beneficial for users to have a concise guide on how to get started collecting and visualizing tracing data. ### What changes are included in this PR? This is an initial draft for review of an addition to the [C++ User Guide](https://arrow.apache.org/docs/dev/cpp/user_guide.html) as mentioned in apache#31809 (comment). ### Are these changes tested? These changes have been tested locally by building the docs and verifying. ### Are there any user-facing changes? Yes, but just documentation changes. * Closes: apache#31809 Lead-authored-by: Bryce Mecum <[email protected]> Co-authored-by: Matthijs Brobbel <[email protected]> Signed-off-by: David Li <[email protected]>
…d telemetry data (apache#33873) ### Rationale for this change The codebase has been partially implemented with the OpenTelemetry SDK and it would be beneficial for users to have a concise guide on how to get started collecting and visualizing tracing data. ### What changes are included in this PR? This is an initial draft for review of an addition to the [C++ User Guide](https://arrow.apache.org/docs/dev/cpp/user_guide.html) as mentioned in apache#31809 (comment). ### Are these changes tested? These changes have been tested locally by building the docs and verifying. ### Are there any user-facing changes? Yes, but just documentation changes. * Closes: apache#31809 Lead-authored-by: Bryce Mecum <[email protected]> Co-authored-by: Matthijs Brobbel <[email protected]> Signed-off-by: David Li <[email protected]>
Rationale for this change
The codebase has been partially implemented with the OpenTelemetry SDK and it would be beneficial for users to have a concise guide on how to get started collecting and visualizing tracing data.
What changes are included in this PR?
This is an initial draft for review of an addition to the C++ User Guide as mentioned in #31809 (comment).
Are these changes tested?
These changes have been tested locally by building the docs and verifying.
Are there any user-facing changes?
Yes, but just documentation changes.