opentelemetry-python-contrib-external-valkey 0.59b0__tar.gz → 0.60b0__tar.gz

{opentelemetry_python_contrib_external_valkey-0.59b0 → opentelemetry_python_contrib_external_valkey-0.60b0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: opentelemetry-python-contrib-external-valkey
-Version: 0.59b0
+Version: 0.60b0
 Summary: OpenTelemetry Valkey instrumentation
 Author: Philip Meier
 Author-email: Philip Meier <github.pmeier@posteo.de>
@@ -19,7 +19,7 @@ Description-Content-Type: text/markdown
 
 ## How do I install it?
 
-`opentelemetry-python-contrib-external-valkey` is available on [PyPI](). You can install it with
+`opentelemetry-python-contrib-external-valkey` is available on [PyPI](https://pypi.org/project/opentelemetry-python-contrib-external-valkey). You can install it with
 
 ```shell
 pip install opentelemetry-python-contrib-external-valkey
@@ -47,7 +47,7 @@ For more detailed documentation please have a look at the [`opentelemetry-instru
 
 ## Why is this needed?
 
-`opentelemetry-instrumentation-redis` instruments the `redis` module and has multiple `isinstance` checks for classes from it. Since the [Valkey Python Client] is a fork of the [Redis Python Client](https://github.com/redis/redis-py), any instrumentation through `opentelemetry-instrumentation-redis` has no effect on the `valkey` module or any of its classes. `opentelemetry-python-contrib-external-valkey` fills this gap until Valkey is [officially supported](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3478) and gives Valkey users the same user experience for instrumentation as Redis users. 
+`opentelemetry-instrumentation-redis` instruments the `redis` module and has multiple `isinstance` checks for classes from it. Since the [Valkey Python Client](https://github.com/valkey-io/valkey-py) is a fork of the [Redis Python Client](https://github.com/redis/redis-py), any instrumentation through `opentelemetry-instrumentation-redis` has no effect on the `valkey` module or any of its classes. `opentelemetry-python-contrib-external-valkey` fills this gap until Valkey is [officially supported](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3478) and gives Valkey users the same user experience for instrumentation as Redis users. 
 
 ## How does it work?
 

{opentelemetry_python_contrib_external_valkey-0.59b0 → opentelemetry_python_contrib_external_valkey-0.60b0}/README.md

@@ -4,7 +4,7 @@
 
 ## How do I install it?
 
-`opentelemetry-python-contrib-external-valkey` is available on [PyPI](). You can install it with
+`opentelemetry-python-contrib-external-valkey` is available on [PyPI](https://pypi.org/project/opentelemetry-python-contrib-external-valkey). You can install it with
 
 ```shell
 pip install opentelemetry-python-contrib-external-valkey
@@ -32,7 +32,7 @@ For more detailed documentation please have a look at the [`opentelemetry-instru
 
 ## Why is this needed?
 
-`opentelemetry-instrumentation-redis` instruments the `redis` module and has multiple `isinstance` checks for classes from it. Since the [Valkey Python Client] is a fork of the [Redis Python Client](https://github.com/redis/redis-py), any instrumentation through `opentelemetry-instrumentation-redis` has no effect on the `valkey` module or any of its classes. `opentelemetry-python-contrib-external-valkey` fills this gap until Valkey is [officially supported](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3478) and gives Valkey users the same user experience for instrumentation as Redis users. 
+`opentelemetry-instrumentation-redis` instruments the `redis` module and has multiple `isinstance` checks for classes from it. Since the [Valkey Python Client](https://github.com/valkey-io/valkey-py) is a fork of the [Redis Python Client](https://github.com/redis/redis-py), any instrumentation through `opentelemetry-instrumentation-redis` has no effect on the `valkey` module or any of its classes. `opentelemetry-python-contrib-external-valkey` fills this gap until Valkey is [officially supported](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3478) and gives Valkey users the same user experience for instrumentation as Redis users. 
 
 ## How does it work?
 

{opentelemetry_python_contrib_external_valkey-0.59b0 → opentelemetry_python_contrib_external_valkey-0.60b0}/pyproject.toml

@@ -8,7 +8,7 @@ authors = [
 ]
 readme = "README.md"
 requires-python = ">=3.9"
-version = "0.59b0"
+version = "0.60b0"
 
 dependencies = [
     "opentelemetry-api~=1.12",

{opentelemetry_python_contrib_external_valkey-0.59b0 → opentelemetry_python_contrib_external_valkey-0.60b0}/src/opentelemetry/instrumentation/valkey/__init__.py

@@ -111,6 +111,35 @@ Request/Response Hooks
     client = valkey.StrictValkey(host="localhost", port=6379)
     client.get("my-key")
 
+Suppress Instrumentation
+------------------------
+
+You can use the ``suppress_instrumentation`` context manager to prevent instrumentation
+from being applied to specific Valkey operations. This is useful when you want to avoid
+creating spans for internal operations, health checks, or during specific code paths.
+
+.. code:: python
+
+    from opentelemetry.instrumentation.valkey import ValkeyInstrumentor
+    from opentelemetry.instrumentation.utils import suppress_instrumentation
+    import valkey
+
+    # Instrument valkey
+    ValkeyInstrumentor().instrument()
+
+    client = valkey.StrictValkey(host="localhost", port=6379)
+
+    # This will report a span
+    client.get("my-key")
+
+    # This will NOT report a span
+    with suppress_instrumentation():
+        client.get("internal-key")
+        client.set("cache-key", "value")
+
+    # This will report a span again
+    client.get("another-key")
+
 API
 ---
 """
@@ -135,7 +164,10 @@ from opentelemetry.instrumentation.valkey.util import (
     _set_connection_attributes,
 )
 from opentelemetry.instrumentation.valkey.version import __version__
-from opentelemetry.instrumentation.utils import unwrap
+from opentelemetry.instrumentation.utils import (
+    is_instrumentation_enabled,
+    unwrap,
+)
 from opentelemetry.semconv._incubating.attributes.db_attributes import (
     DB_STATEMENT,
 )
@@ -197,6 +229,9 @@ def _traced_execute_factory(
         args: tuple[Any, ...],
         kwargs: dict[str, Any],
     ) -> R:
+        if not is_instrumentation_enabled():
+            return func(*args, **kwargs)
+
         query = _format_command_args(args)
         name = _build_span_name(instance, args)
         with tracer.start_as_current_span(
@@ -232,6 +267,9 @@ def _traced_execute_pipeline_factory(
         args: tuple[Any, ...],
         kwargs: dict[str, Any],
     ) -> R:
+        if not is_instrumentation_enabled():
+            return func(*args, **kwargs)
+
         (
             command_stack,
             resource,
@@ -277,6 +315,9 @@ def _async_traced_execute_factory(
         args: tuple[Any, ...],
         kwargs: dict[str, Any],
     ) -> Awaitable[R]:
+        if not is_instrumentation_enabled():
+            return await func(*args, **kwargs)
+
         query = _format_command_args(args)
         name = _build_span_name(instance, args)
 
@@ -308,6 +349,9 @@ def _async_traced_execute_pipeline_factory(
         args: tuple[Any, ...],
         kwargs: dict[str, Any],
     ) -> Awaitable[R]:
+        if not is_instrumentation_enabled():
+            return await func(*args, **kwargs)
+
         (
             command_stack,
             resource,

{opentelemetry_python_contrib_external_valkey-0.59b0 → opentelemetry_python_contrib_external_valkey-0.60b0}/src/opentelemetry/instrumentation/valkey/util.py

@@ -208,4 +208,4 @@ def _build_span_meta_data_for_pipeline(
         resource = ""
         span_name = ""
 
-    return command_stack, resource, span_name
+    return command_stack, resource, span_name or "valkey"

{opentelemetry_python_contrib_external_valkey-0.59b0 → opentelemetry_python_contrib_external_valkey-0.60b0}/src/opentelemetry/instrumentation/valkey/version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.59b0"
+__version__ = "0.60b0"