Skip to content

Commit c41471b

Browse files
johanpelAiee
authored andcommitted
GH-48046: [Docs][C++] Clarify "Exporting Tracing Information" section in OTel docs (#48047)
### Rationale for this change The docs should be more precise in describing when and how Arrow exports traces. It should also generally discourage the use of `ARROW_WITH_OPENTELEMETRY` in executables as it modifies global OTel SDK resources. ### What changes are included in this PR? More precise language in the docs. ### Are these changes tested? No. ### Are there any user-facing changes? Yes, docs. * GitHub Issue: #48046 Authored-by: Johan Peltenburg <[email protected]> Signed-off-by: Bryce Mecum <[email protected]>
1 parent 78a15c9 commit c41471b

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/source/cpp/opentelemetry.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,17 @@ Exporting Tracing Information
4040
-----------------------------
4141

4242
By default, no tracing information is exported until a tracing backend has been
43-
specified. The choice of tracing backend is controlled with the
44-
:envvar:`ARROW_TRACING_BACKEND` environment variable. Possible values are:
43+
specified. This is typically done by the executable using Arrow by installing a
44+
``TracerProvider`` through the OpenTelemetry SDK API. Please refer to the
45+
`OpenTelemetry SDK API C++ documentation
46+
<https://opentelemetry-cpp.readthedocs.io/en/latest/sdk/sdk.html>`_.
4547

48+
In the rare cases you want Arrow to control the global resources of the
49+
OpenTelemetry SDK, a tracing backend can be specified through the
50+
:envvar:`ARROW_TRACING_BACKEND` environment variable. This overrides any
51+
``TracerProvider`` previously set.
52+
53+
Possible values for :envvar:`ARROW_TRACING_BACKEND` are:
4654
- ``ostream``: emit textual log messages to stdout
4755
- ``otlp_http``: emit OTLP JSON encoded traces to a HTTP server (by default,
4856
the endpoint URL is "http://localhost:4318/v1/traces")

0 commit comments

Comments
 (0)