lidavidm commented on code in PR #4500:
URL: https://github.com/apache/arrow-adbc/pull/4500#discussion_r3558565485
##########
docs/source/driver/flight_sql.rst:
##########
@@ -192,6 +192,87 @@ The options used for creating the Flight RPC client can be
customized.
Python:
:attr:`adbc_driver_flightsql.DatabaseOptions.WITH_COOKIE_MIDDLEWARE`
+OpenTelemetry Tracing
+---------------------
+
+The Go-based Flight SQL driver can emit OpenTelemetry traces for
+connection and statement activity.
+
+Tracing can be configured with database options or with environment
+variables.
+
+Database options
+~~~~~~~~~~~~~~~~
+
+``adbc.telemetry.traces_exporter``
+ Selects the traces exporter to use when the driver initializes its
+ tracer provider.
+
+ Supported values:
+
+ - ``none``: disable driver-managed trace exporting
+ - ``otlp``: export traces via OpenTelemetry OTLP exporters
+ - ``console``: write traces to standard output
+ - ``adbcfile``: write traces to rotated ``.jsonl`` files
+
+ When this option is set, it takes precedence over the
+ ``OTEL_TRACES_EXPORTER`` environment variable. If neither is set,
+ the driver falls back to the process-global OpenTelemetry tracer
+ provider.
+
+``adbc.telemetry.traces_folder_path``
+ Overrides the output folder used by the ``adbcfile`` exporter.
+ This option is ignored for other exporters.
+
+ If unset, the ``adbcfile`` exporter writes traces under the user's
+ configuration directory in:
+
+ - Windows: ``%APPDATA%\.adbc\traces``
+ - macOS: ``~/Library/Application Support/.adbc/traces``
+ - Linux: ``$XDG_CONFIG_HOME/.adbc/traces`` or ``~/.config/.adbc/traces``
Review Comment:
Not a problem with the docs per se, but does it need to be `.adbc`? Maybe we
can try to make this consistent with paths for profiles and manifests?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
