Skip to content

Commit 4fb56bb

Browse files
committed
PYTHON-5945 Defer MongoClient docstring updates for tracing to follow-up PR
The tracing keyword argument remains fully functional (validated, threaded through to _CommandTelemetry); only its user-facing docstring documentation is deferred alongside the changelog entry.
1 parent ed1971f commit 4fb56bb

2 files changed

Lines changed: 0 additions & 38 deletions

File tree

pymongo/asynchronous/mongo_client.py

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -615,27 +615,8 @@ def __init__(
615615
If enabled, server overload errors will cause retry attempts to select a server that has not yet returned an overload error, if possible.
616616
Defaults to ``False``.
617617
618-
| **OpenTelemetry options:**
619-
| (Requires the ``opentelemetry-api`` package; install with the ``pymongo[opentelemetry]`` extra.)
620-
621-
- `tracing`: (dict) Configuration for OpenTelemetry command spans, with keys:
622-
623-
- ``enabled``: (boolean) Whether to create spans for server commands issued by
624-
this client. Defaults to ``False``. Also controlled by the
625-
``OTEL_PYTHON_INSTRUMENTATION_MONGODB_ENABLED`` environment variable; either
626-
being enabled is sufficient.
627-
- ``query_text_max_length``: (int) The maximum length of the ``db.query.text``
628-
span attribute. Unset by default, which defers to the
629-
``OTEL_PYTHON_INSTRUMENTATION_MONGODB_QUERY_TEXT_MAX_LENGTH`` environment
630-
variable (itself defaulting to ``0``, which omits the attribute). Setting
631-
this explicitly, including to ``0``, always overrides the environment
632-
variable.
633-
634618
.. seealso:: The MongoDB documentation on `connections <https://dochub.mongodb.org/core/connections>`_.
635619
636-
.. versionchanged:: 4.18
637-
Added the ``tracing`` keyword argument.
638-
639620
.. versionchanged:: 4.17
640621
Added the ``max_adaptive_retries`` and ``enable_overload_retargeting`` URI and keyword arguments.
641622

pymongo/synchronous/mongo_client.py

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -616,27 +616,8 @@ def __init__(
616616
If enabled, server overload errors will cause retry attempts to select a server that has not yet returned an overload error, if possible.
617617
Defaults to ``False``.
618618
619-
| **OpenTelemetry options:**
620-
| (Requires the ``opentelemetry-api`` package; install with the ``pymongo[opentelemetry]`` extra.)
621-
622-
- `tracing`: (dict) Configuration for OpenTelemetry command spans, with keys:
623-
624-
- ``enabled``: (boolean) Whether to create spans for server commands issued by
625-
this client. Defaults to ``False``. Also controlled by the
626-
``OTEL_PYTHON_INSTRUMENTATION_MONGODB_ENABLED`` environment variable; either
627-
being enabled is sufficient.
628-
- ``query_text_max_length``: (int) The maximum length of the ``db.query.text``
629-
span attribute. Unset by default, which defers to the
630-
``OTEL_PYTHON_INSTRUMENTATION_MONGODB_QUERY_TEXT_MAX_LENGTH`` environment
631-
variable (itself defaulting to ``0``, which omits the attribute). Setting
632-
this explicitly, including to ``0``, always overrides the environment
633-
variable.
634-
635619
.. seealso:: The MongoDB documentation on `connections <https://dochub.mongodb.org/core/connections>`_.
636620
637-
.. versionchanged:: 4.18
638-
Added the ``tracing`` keyword argument.
639-
640621
.. versionchanged:: 4.17
641622
Added the ``max_adaptive_retries`` and ``enable_overload_retargeting`` URI and keyword arguments.
642623

0 commit comments

Comments
 (0)