From b49a8733f5bce7797086ddeb84b10b315d7c3d77 Mon Sep 17 00:00:00 2001 From: Kaustubh Bhargava Date: Wed, 13 May 2026 11:46:44 +0000 Subject: [PATCH 1/3] docs: add sphinx docs for opentelemetry.sdk.util module The opentelemetry.sdk.util package exposes BoundedList, BoundedDict, ns_to_iso_str, and get_dict_as_key but was not included in the generated Sphinx documentation. Add util.rst and register it in the SDK docs toctree. Relates to #2573 --- .changelog/XXXX.added | 1 + docs/sdk/index.rst | 46 ++++++++++++++++++++++--------------------- docs/sdk/util.rst | 7 +++++++ 3 files changed, 32 insertions(+), 22 deletions(-) create mode 100644 .changelog/XXXX.added create mode 100644 docs/sdk/util.rst diff --git a/.changelog/XXXX.added b/.changelog/XXXX.added new file mode 100644 index 00000000000..9e5f413c83a --- /dev/null +++ b/.changelog/XXXX.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..651f7acaf88 --- /dev/null +++ b/docs/sdk/util.rst @@ -0,0 +1,7 @@ +opentelemetry.sdk.util +====================== + +.. automodule:: opentelemetry.sdk.util + :members: + :undoc-members: + :show-inheritance: From 73e4418a93565d9f9eac6189a10d9d93ea64959a Mon Sep 17 00:00:00 2001 From: Kaustubh Bhargava Date: Wed, 13 May 2026 11:54:46 +0000 Subject: [PATCH 2/3] docs: rename changelog fragment to PR 5204 --- .changelog/.gitignore | 2 +- .changelog/{XXXX.added => 5204.added} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename .changelog/{XXXX.added => 5204.added} (100%) 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/XXXX.added b/.changelog/5204.added similarity index 100% rename from .changelog/XXXX.added rename to .changelog/5204.added From eac297481631ac49f349edda8ff30aad01ecf53b Mon Sep 17 00:00:00 2001 From: Kaustubh Bhargava Date: Wed, 13 May 2026 11:58:58 +0000 Subject: [PATCH 3/3] docs: add 'package' suffix to util.rst heading per review --- docs/sdk/util.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sdk/util.rst b/docs/sdk/util.rst index 651f7acaf88..5271067df67 100644 --- a/docs/sdk/util.rst +++ b/docs/sdk/util.rst @@ -1,5 +1,5 @@ -opentelemetry.sdk.util -====================== +opentelemetry.sdk.util package +============================== .. automodule:: opentelemetry.sdk.util :members: