diff --git a/.changelog/.gitignore b/.changelog/.gitignore index f935021a8f8..e73174f6322 100644 --- a/.changelog/.gitignore +++ b/.changelog/.gitignore @@ -1 +1 @@ -!.gitignore +!.gitignore diff --git a/.changelog/5204.added b/.changelog/5204.added new file mode 100644 index 00000000000..9e5f413c83a --- /dev/null +++ b/.changelog/5204.added @@ -0,0 +1 @@ +`opentelemetry-sdk`: add sphinx docs for `opentelemetry.sdk.util` module diff --git a/docs/sdk/index.rst b/docs/sdk/index.rst index ecc4a390856..19b8c29b4c7 100644 --- a/docs/sdk/index.rst +++ b/docs/sdk/index.rst @@ -1,22 +1,24 @@ -OpenTelemetry Python SDK -======================== - -The OpenTelemetry Python SDK provides the reference implementation of the -:doc:`OpenTelemetry Python API `. It includes the concrete classes -for managing and exporting traces, metrics, and logs — such as -``TracerProvider``, ``MeterProvider``, span processors, metric readers, and -exporters. The SDK is responsible for sampling, batching, and delivering -telemetry data to backends. - -Install the SDK in your application to configure how telemetry is collected, -processed, and exported. - -.. toctree:: - :maxdepth: 1 - - _logs - resources - trace - metrics - error_handler - environment_variables +OpenTelemetry Python SDK +======================== + +The OpenTelemetry Python SDK provides the reference implementation of the +:doc:`OpenTelemetry Python API `. It includes the concrete classes +for managing and exporting traces, metrics, and logs — such as +``TracerProvider``, ``MeterProvider``, span processors, metric readers, and +exporters. The SDK is responsible for sampling, batching, and delivering +telemetry data to backends. + +Install the SDK in your application to configure how telemetry is collected, +processed, and exported. + +.. toctree:: + :maxdepth: 1 + + _logs + resources + trace + metrics + error_handler + environment_variables + util + util.instrumentation diff --git a/docs/sdk/util.rst b/docs/sdk/util.rst new file mode 100644 index 00000000000..5271067df67 --- /dev/null +++ b/docs/sdk/util.rst @@ -0,0 +1,7 @@ +opentelemetry.sdk.util package +============================== + +.. automodule:: opentelemetry.sdk.util + :members: + :undoc-members: + :show-inheritance: