opentelemetry-python-contrib-external-valkey 0.59b0__py3-none-any.whl

opentelemetry/instrumentation/valkey/__init__.py

@@ -0,0 +1,662 @@
+# Copyright The OpenTelemetry Authors
+# Copyright 2025 Philip Meier
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Instrument `valkey`_ to report Valkey queries.
+
+.. _valkey: https://pypi.org/project/valkey/
+
+
+Instrument All Clients
+----------------------
+
+The easiest way to instrument all valkey client instances is by
+``ValkeyInstrumentor().instrument()``:
+
+.. code:: python
+
+    from opentelemetry.instrumentation.valkey import ValkeyInstrumentor
+    import valkey
+
+
+    # Instrument valkey
+    ValkeyInstrumentor().instrument()
+
+    # This will report a span with the default settings
+    client = valkey.StrictValkey(host="localhost", port=6379)
+    client.get("my-key")
+
+Async Valkey clients (i.e. ``valkey.asyncio.Valkey``) are also instrumented in the same way:
+
+.. code:: python
+
+    from opentelemetry.instrumentation.valkey import ValkeyInstrumentor
+    import valkey.asyncio
+
+
+    # Instrument valkey
+    ValkeyInstrumentor().instrument()
+
+    # This will report a span with the default settings
+    async def valkey_get():
+        client = valkey.asyncio.Valkey(host="localhost", port=6379)
+        await client.get("my-key")
+
+.. note::
+    Calling the ``instrument`` method will instrument the client classes, so any client
+    created after the ``instrument`` call will be instrumented. To instrument only a
+    single client, use :func:`ValkeyInstrumentor.instrument_client` method.
+
+Instrument Single Client
+------------------------
+
+The :func:`ValkeyInstrumentor.instrument_client` can instrument a connection instance. This is useful when there are multiple clients with a different valkey database index.
+Or, you might have a different connection pool used for an application function you
+don't want instrumented.
+
+.. code:: python
+
+    from opentelemetry.instrumentation.valkey import ValkeyInstrumentor
+    import valkey
+
+    instrumented_client = valkey.Valkey()
+    not_instrumented_client = valkey.Valkey()
+
+    # Instrument valkey
+    ValkeyInstrumentor.instrument_client(client=instrumented_client)
+
+    # This will report a span with the default settings
+    instrumented_client.get("my-key")
+
+    # This will not have a span
+    not_instrumented_client.get("my-key")
+
+.. warning::
+    All client instances created after calling ``ValkeyInstrumentor().instrument`` will
+    be instrumented. To avoid instrumenting all clients, use
+    :func:`ValkeyInstrumentor.instrument_client` .
+
+Request/Response Hooks
+----------------------
+
+.. code:: python
+
+    from opentelemetry.instrumentation.valkey import ValkeyInstrumentor
+    import valkey
+
+    def request_hook(span, instance, args, kwargs):
+        if span and span.is_recording():
+            span.set_attribute("custom_user_attribute_from_request_hook", "some-value")
+
+    def response_hook(span, instance, response):
+        if span and span.is_recording():
+            span.set_attribute("custom_user_attribute_from_response_hook", "some-value")
+
+    # Instrument valkey with hooks
+    ValkeyInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook)
+
+    # This will report a span with the default settings and the custom attributes added from the hooks
+    client = valkey.StrictValkey(host="localhost", port=6379)
+    client.get("my-key")
+
+API
+---
+"""
+
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any, Callable, Collection
+
+import valkey
+from wrapt import wrap_function_wrapper
+
+from opentelemetry import trace
+from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
+from opentelemetry.instrumentation.valkey.package import _instruments
+from opentelemetry.instrumentation.valkey.util import (
+    _add_create_attributes,
+    _add_search_attributes,
+    _build_span_meta_data_for_pipeline,
+    _build_span_name,
+    _format_command_args,
+    _set_connection_attributes,
+)
+from opentelemetry.instrumentation.valkey.version import __version__
+from opentelemetry.instrumentation.utils import unwrap
+from opentelemetry.semconv._incubating.attributes.db_attributes import (
+    DB_STATEMENT,
+)
+from opentelemetry.trace import (
+    StatusCode,
+    Tracer,
+    TracerProvider,
+    get_tracer,
+)
+
+if TYPE_CHECKING:
+    from typing import Awaitable
+
+    import valkey.asyncio.client
+    import valkey.asyncio.cluster
+    import valkey.client
+    import valkey.cluster
+    import valkey.connection
+
+    from opentelemetry.instrumentation.valkey.custom_types import (
+        AsyncPipelineInstance,
+        AsyncValkeyInstance,
+        PipelineInstance,
+        R,
+        ValkeyInstance,
+        RequestHook,
+        ResponseHook,
+    )
+
+
+_logger = logging.getLogger(__name__)
+
+_REDIS_ASYNCIO_VERSION = (4, 2, 0)
+_REDIS_CLUSTER_VERSION = (4, 1, 0)
+_REDIS_ASYNCIO_CLUSTER_VERSION = (4, 3, 2)
+
+
+_CLIENT_ASYNCIO_SUPPORT = valkey.VERSION >= _REDIS_ASYNCIO_VERSION
+_CLIENT_ASYNCIO_CLUSTER_SUPPORT = (
+    valkey.VERSION >= _REDIS_ASYNCIO_CLUSTER_VERSION
+)
+_CLIENT_CLUSTER_SUPPORT = valkey.VERSION >= _REDIS_CLUSTER_VERSION
+_CLIENT_BEFORE_V3 = valkey.VERSION < (3, 0, 0)
+
+if _CLIENT_ASYNCIO_SUPPORT:
+    import valkey.asyncio
+
+_INSTRUMENTATION_ATTR = "_is_instrumented_by_opentelemetry"
+
+
+def _traced_execute_factory(
+    tracer: Tracer,
+    request_hook: RequestHook | None = None,
+    response_hook: ResponseHook | None = None,
+):
+    def _traced_execute_command(
+        func: Callable[..., R],
+        instance: ValkeyInstance,
+        args: tuple[Any, ...],
+        kwargs: dict[str, Any],
+    ) -> R:
+        query = _format_command_args(args)
+        name = _build_span_name(instance, args)
+        with tracer.start_as_current_span(
+            name, kind=trace.SpanKind.CLIENT
+        ) as span:
+            if span.is_recording():
+                span.set_attribute(DB_STATEMENT, query)
+                _set_connection_attributes(span, instance)
+                span.set_attribute("db.valkey.args_length", len(args))
+                if span.name == "valkey.create_index":
+                    _add_create_attributes(span, args)
+            if callable(request_hook):
+                request_hook(span, instance, args, kwargs)
+            response = func(*args, **kwargs)
+            if span.is_recording():
+                if span.name == "valkey.search":
+                    _add_search_attributes(span, response, args)
+            if callable(response_hook):
+                response_hook(span, instance, response)
+            return response
+
+    return _traced_execute_command
+
+
+def _traced_execute_pipeline_factory(
+    tracer: Tracer,
+    request_hook: RequestHook | None = None,
+    response_hook: ResponseHook | None = None,
+):
+    def _traced_execute_pipeline(
+        func: Callable[..., R],
+        instance: PipelineInstance,
+        args: tuple[Any, ...],
+        kwargs: dict[str, Any],
+    ) -> R:
+        (
+            command_stack,
+            resource,
+            span_name,
+        ) = _build_span_meta_data_for_pipeline(instance)
+        exception = None
+        with tracer.start_as_current_span(
+            span_name, kind=trace.SpanKind.CLIENT
+        ) as span:
+            if span.is_recording():
+                span.set_attribute(DB_STATEMENT, resource)
+                _set_connection_attributes(span, instance)
+                span.set_attribute(
+                    "db.valkey.pipeline_length", len(command_stack)
+                )
+
+            response = None
+            try:
+                response = func(*args, **kwargs)
+            except valkey.WatchError as watch_exception:
+                span.set_status(StatusCode.UNSET)
+                exception = watch_exception
+
+            if callable(response_hook):
+                response_hook(span, instance, response)
+
+        if exception:
+            raise exception
+
+        return response
+
+    return _traced_execute_pipeline
+
+
+def _async_traced_execute_factory(
+    tracer: Tracer,
+    request_hook: RequestHook | None = None,
+    response_hook: ResponseHook | None = None,
+):
+    async def _async_traced_execute_command(
+        func: Callable[..., Awaitable[R]],
+        instance: AsyncValkeyInstance,
+        args: tuple[Any, ...],
+        kwargs: dict[str, Any],
+    ) -> Awaitable[R]:
+        query = _format_command_args(args)
+        name = _build_span_name(instance, args)
+
+        with tracer.start_as_current_span(
+            name, kind=trace.SpanKind.CLIENT
+        ) as span:
+            if span.is_recording():
+                span.set_attribute(DB_STATEMENT, query)
+                _set_connection_attributes(span, instance)
+                span.set_attribute("db.valkey.args_length", len(args))
+            if callable(request_hook):
+                request_hook(span, instance, args, kwargs)
+            response = await func(*args, **kwargs)
+            if callable(response_hook):
+                response_hook(span, instance, response)
+            return response
+
+    return _async_traced_execute_command
+
+
+def _async_traced_execute_pipeline_factory(
+    tracer: Tracer,
+    request_hook: RequestHook | None = None,
+    response_hook: ResponseHook | None = None,
+):
+    async def _async_traced_execute_pipeline(
+        func: Callable[..., Awaitable[R]],
+        instance: AsyncPipelineInstance,
+        args: tuple[Any, ...],
+        kwargs: dict[str, Any],
+    ) -> Awaitable[R]:
+        (
+            command_stack,
+            resource,
+            span_name,
+        ) = _build_span_meta_data_for_pipeline(instance)
+
+        exception = None
+
+        with tracer.start_as_current_span(
+            span_name, kind=trace.SpanKind.CLIENT
+        ) as span:
+            if span.is_recording():
+                span.set_attribute(DB_STATEMENT, resource)
+                _set_connection_attributes(span, instance)
+                span.set_attribute(
+                    "db.valkey.pipeline_length", len(command_stack)
+                )
+
+            response = None
+            try:
+                response = await func(*args, **kwargs)
+            except valkey.WatchError as watch_exception:
+                span.set_status(StatusCode.UNSET)
+                exception = watch_exception
+
+            if callable(response_hook):
+                response_hook(span, instance, response)
+
+        if exception:
+            raise exception
+
+        return response
+
+    return _async_traced_execute_pipeline
+
+
+# pylint: disable=R0915
+def _instrument(
+    tracer: Tracer,
+    request_hook: RequestHook | None = None,
+    response_hook: ResponseHook | None = None,
+):
+    _traced_execute_command = _traced_execute_factory(
+        tracer, request_hook, response_hook
+    )
+    _traced_execute_pipeline = _traced_execute_pipeline_factory(
+        tracer, request_hook, response_hook
+    )
+    pipeline_class = "BasePipeline" if _CLIENT_BEFORE_V3 else "Pipeline"
+    valkey_class = "StrictValkey" if _CLIENT_BEFORE_V3 else "Valkey"
+
+    wrap_function_wrapper(
+        "valkey", f"{valkey_class}.execute_command", _traced_execute_command
+    )
+    wrap_function_wrapper(
+        "valkey.client",
+        f"{pipeline_class}.execute",
+        _traced_execute_pipeline,
+    )
+    wrap_function_wrapper(
+        "valkey.client",
+        f"{pipeline_class}.immediate_execute_command",
+        _traced_execute_command,
+    )
+    if _CLIENT_CLUSTER_SUPPORT:
+        wrap_function_wrapper(
+            "valkey.cluster",
+            "ValkeyCluster.execute_command",
+            _traced_execute_command,
+        )
+        wrap_function_wrapper(
+            "valkey.cluster",
+            "ClusterPipeline.execute",
+            _traced_execute_pipeline,
+        )
+
+    _async_traced_execute_command = _async_traced_execute_factory(
+        tracer, request_hook, response_hook
+    )
+    _async_traced_execute_pipeline = _async_traced_execute_pipeline_factory(
+        tracer, request_hook, response_hook
+    )
+    if _CLIENT_ASYNCIO_SUPPORT:
+        wrap_function_wrapper(
+            "valkey.asyncio",
+            f"{valkey_class}.execute_command",
+            _async_traced_execute_command,
+        )
+        wrap_function_wrapper(
+            "valkey.asyncio.client",
+            f"{pipeline_class}.execute",
+            _async_traced_execute_pipeline,
+        )
+        wrap_function_wrapper(
+            "valkey.asyncio.client",
+            f"{pipeline_class}.immediate_execute_command",
+            _async_traced_execute_command,
+        )
+    if _CLIENT_ASYNCIO_CLUSTER_SUPPORT:
+        wrap_function_wrapper(
+            "valkey.asyncio.cluster",
+            "ValkeyCluster.execute_command",
+            _async_traced_execute_command,
+        )
+        wrap_function_wrapper(
+            "valkey.asyncio.cluster",
+            "ClusterPipeline.execute",
+            _async_traced_execute_pipeline,
+        )
+
+
+def _instrument_client(
+    client,
+    tracer: Tracer,
+    request_hook: RequestHook | None = None,
+    response_hook: ResponseHook | None = None,
+):
+    # first, handle async clients and cluster clients
+    _async_traced_execute = _async_traced_execute_factory(
+        tracer, request_hook, response_hook
+    )
+    _async_traced_execute_pipeline = _async_traced_execute_pipeline_factory(
+        tracer, request_hook, response_hook
+    )
+
+    if _CLIENT_ASYNCIO_SUPPORT and isinstance(client, valkey.asyncio.Valkey):
+
+        def _async_pipeline_wrapper(func, instance, args, kwargs):
+            result = func(*args, **kwargs)
+            wrap_function_wrapper(
+                result, "execute", _async_traced_execute_pipeline
+            )
+            wrap_function_wrapper(
+                result, "immediate_execute_command", _async_traced_execute
+            )
+            return result
+
+        wrap_function_wrapper(client, "execute_command", _async_traced_execute)
+        wrap_function_wrapper(client, "pipeline", _async_pipeline_wrapper)
+        return
+
+    if _CLIENT_ASYNCIO_CLUSTER_SUPPORT and isinstance(
+        client, valkey.asyncio.ValkeyCluster
+    ):
+
+        def _async_cluster_pipeline_wrapper(func, instance, args, kwargs):
+            result = func(*args, **kwargs)
+            wrap_function_wrapper(
+                result, "execute", _async_traced_execute_pipeline
+            )
+            return result
+
+        wrap_function_wrapper(client, "execute_command", _async_traced_execute)
+        wrap_function_wrapper(
+            client, "pipeline", _async_cluster_pipeline_wrapper
+        )
+        return
+    # for valkey.client.Valkey, valkey.Cluster and v3.0.0 valkey.client.StrictValkey
+    # the wrappers are the same
+    _traced_execute = _traced_execute_factory(
+        tracer, request_hook, response_hook
+    )
+    _traced_execute_pipeline = _traced_execute_pipeline_factory(
+        tracer, request_hook, response_hook
+    )
+
+    def _pipeline_wrapper(func, instance, args, kwargs):
+        result = func(*args, **kwargs)
+        wrap_function_wrapper(result, "execute", _traced_execute_pipeline)
+        wrap_function_wrapper(
+            result, "immediate_execute_command", _traced_execute
+        )
+        return result
+
+    wrap_function_wrapper(
+        client,
+        "execute_command",
+        _traced_execute,
+    )
+    wrap_function_wrapper(
+        client,
+        "pipeline",
+        _pipeline_wrapper,
+    )
+
+
+class ValkeyInstrumentor(BaseInstrumentor):
+    @staticmethod
+    def _get_tracer(**kwargs):
+        tracer_provider = kwargs.get("tracer_provider")
+        return get_tracer(
+            __name__,
+            __version__,
+            tracer_provider=tracer_provider,
+            schema_url="https://opentelemetry.io/schemas/1.11.0",
+        )
+
+    def instrument(
+        self,
+        tracer_provider: TracerProvider | None = None,
+        request_hook: RequestHook | None = None,
+        response_hook: ResponseHook | None = None,
+        **kwargs,
+    ):
+        """Instruments all Valkey/StrictValkey/ValkeyCluster and async client instances.
+
+        Args:
+            tracer_provider: A TracerProvider, defaults to global.
+            request_hook:
+                a function with extra user-defined logic to run before performing the request.
+
+                The ``args`` is a tuple, where items are
+                command arguments. For example ``client.set("mykey", "value", ex=5)`` would
+                have ``args`` as ``('SET', 'mykey', 'value', 'EX', 5)``.
+
+                The ``kwargs`` represents occasional ``options`` passed by valkey. For example,
+                if you use ``client.set("mykey", "value", get=True)``, the ``kwargs`` would be
+                ``{'get': True}``.
+            response_hook:
+                a function with extra user-defined logic to run after the request is complete.
+
+                The ``args`` represents the response.
+        """
+        super().instrument(
+            tracer_provider=tracer_provider,
+            request_hook=request_hook,
+            response_hook=response_hook,
+            **kwargs,
+        )
+
+    def _instrument(self, **kwargs: Any):
+        """Instruments the valkey module
+
+        Args:
+            **kwargs: Optional arguments
+                ``tracer_provider``: a TracerProvider, defaults to global.
+                ``request_hook``: An optional callback that is invoked right after a span is created.
+                ``response_hook``: An optional callback which is invoked right before the span is finished processing a response.
+        """
+        _instrument(
+            self._get_tracer(**kwargs),
+            request_hook=kwargs.get("request_hook"),
+            response_hook=kwargs.get("response_hook"),
+        )
+
+    def _uninstrument(self, **kwargs: Any):
+        if _CLIENT_BEFORE_V3:
+            unwrap(valkey.StrictValkey, "execute_command")
+            unwrap(valkey.StrictValkey, "pipeline")
+            unwrap(valkey.Valkey, "pipeline")
+            unwrap(
+                valkey.client.BasePipeline,  # pylint:disable=no-member
+                "execute",
+            )
+            unwrap(
+                valkey.client.BasePipeline,  # pylint:disable=no-member
+                "immediate_execute_command",
+            )
+        else:
+            unwrap(valkey.Valkey, "execute_command")
+            unwrap(valkey.Valkey, "pipeline")
+            unwrap(valkey.client.Pipeline, "execute")
+            unwrap(valkey.client.Pipeline, "immediate_execute_command")
+        if _CLIENT_CLUSTER_SUPPORT:
+            unwrap(valkey.cluster.ValkeyCluster, "execute_command")
+            unwrap(valkey.cluster.ClusterPipeline, "execute")
+        if _CLIENT_ASYNCIO_SUPPORT:
+            unwrap(valkey.asyncio.Valkey, "execute_command")
+            unwrap(valkey.asyncio.Valkey, "pipeline")
+            unwrap(valkey.asyncio.client.Pipeline, "execute")
+            unwrap(valkey.asyncio.client.Pipeline, "immediate_execute_command")
+        if _CLIENT_ASYNCIO_CLUSTER_SUPPORT:
+            unwrap(valkey.asyncio.cluster.ValkeyCluster, "execute_command")
+            unwrap(valkey.asyncio.cluster.ClusterPipeline, "execute")
+
+    @staticmethod
+    def instrument_client(
+        client: valkey.StrictValkey
+        | valkey.Valkey
+        | valkey.asyncio.Valkey
+        | valkey.cluster.ValkeyCluster
+        | valkey.asyncio.cluster.ValkeyCluster,
+        tracer_provider: TracerProvider | None = None,
+        request_hook: RequestHook | None = None,
+        response_hook: ResponseHook | None = None,
+    ):
+        """Instrument the provided Valkey Client. The client can be sync or async.
+        Cluster client is also supported.
+
+        Args:
+            client: The valkey client.
+            tracer_provider: A TracerProvider, defaults to global.
+            request_hook: a function with extra user-defined logic to run before
+                performing the request.
+
+                The ``args`` is a tuple, where items are
+                command arguments. For example ``client.set("mykey", "value", ex=5)`` would
+                have ``args`` as ``('SET', 'mykey', 'value', 'EX', 5)``.
+
+                The ``kwargs`` represents occasional ``options`` passed by valkey. For example,
+                if you use ``client.set("mykey", "value", get=True)``, the ``kwargs`` would be
+                ``{'get': True}``.
+
+            response_hook: a function with extra user-defined logic to run after
+                the request is complete.
+
+                The ``args`` represents the response.
+        """
+        if not hasattr(client, _INSTRUMENTATION_ATTR):
+            setattr(client, _INSTRUMENTATION_ATTR, False)
+        if not getattr(client, _INSTRUMENTATION_ATTR):
+            _instrument_client(
+                client,
+                ValkeyInstrumentor._get_tracer(tracer_provider=tracer_provider),
+                request_hook=request_hook,
+                response_hook=response_hook,
+            )
+            setattr(client, _INSTRUMENTATION_ATTR, True)
+        else:
+            _logger.warning(
+                "Attempting to instrument Valkey connection while already instrumented"
+            )
+
+    @staticmethod
+    def uninstrument_client(
+        client: valkey.StrictValkey
+        | valkey.Valkey
+        | valkey.asyncio.Valkey
+        | valkey.cluster.ValkeyCluster
+        | valkey.asyncio.cluster.ValkeyCluster,
+    ):
+        """Disables instrumentation for the given client instance
+
+        Args:
+            client: The valkey client
+        """
+        if getattr(client, _INSTRUMENTATION_ATTR):
+            # for all clients we need to unwrap execute_command and pipeline functions
+            unwrap(client, "execute_command")
+            # the method was creating a pipeline and wrapping the functions of the
+            # created instance. any pipelines created before un-instrumenting will
+            # remain instrumented (pipelines should usually have a short span)
+            unwrap(client, "pipeline")
+        else:
+            _logger.warning(
+                "Attempting to un-instrument Valkey connection that wasn't instrumented"
+            )
+            return
+
+    def instrumentation_dependencies(self) -> Collection[str]:
+        """Return a list of python packages with versions that the will be instrumented."""
+        return _instruments

opentelemetry/instrumentation/valkey/custom_types.py

@@ -0,0 +1,49 @@
+# Copyright The OpenTelemetry Authors
+# Copyright 2025 Philip Meier
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+from typing import Any, Callable, TypeVar
+
+import valkey.asyncio.client
+import valkey.asyncio.cluster
+import valkey.client
+import valkey.cluster
+import valkey.connection
+
+from opentelemetry.trace import Span
+
+RequestHook = Callable[
+    [Span, valkey.connection.Connection, list[Any], dict[str, Any]], None
+]
+ResponseHook = Callable[[Span, valkey.connection.Connection, Any], None]
+
+AsyncPipelineInstance = TypeVar(
+    "AsyncPipelineInstance",
+    valkey.asyncio.client.Pipeline,
+    valkey.asyncio.cluster.ClusterPipeline,
+)
+AsyncValkeyInstance = TypeVar(
+    "AsyncValkeyInstance", valkey.asyncio.Valkey, valkey.asyncio.ValkeyCluster
+)
+PipelineInstance = TypeVar(
+    "PipelineInstance",
+    valkey.client.Pipeline,
+    valkey.cluster.ClusterPipeline,
+)
+ValkeyInstance = TypeVar(
+    "ValkeyInstance", valkey.client.Valkey, valkey.cluster.ValkeyCluster
+)
+R = TypeVar("R")

opentelemetry/instrumentation/valkey/package.py

@@ -0,0 +1,16 @@
+# Copyright The OpenTelemetry Authors
+# Copyright 2025 Philip Meier
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+_instruments = ("valkey >= 6.1.0",)

opentelemetry/instrumentation/valkey/util.py

@@ -0,0 +1,211 @@
+# Copyright The OpenTelemetry Authors
+# Copyright 2025 Philip Meier
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Some utils used by the valkey integration
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from opentelemetry.semconv._incubating.attributes.db_attributes import (
+    DB_REDIS_DATABASE_INDEX,
+    DB_SYSTEM,
+)
+from opentelemetry.semconv._incubating.attributes.net_attributes import (
+    NET_PEER_NAME,
+    NET_PEER_PORT,
+    NET_TRANSPORT,
+)
+from opentelemetry.semconv.trace import (
+    DbSystemValues,
+    NetTransportValues,
+)
+from opentelemetry.trace import Span
+
+if TYPE_CHECKING:
+    from opentelemetry.instrumentation.valkey.custom_types import (
+        AsyncPipelineInstance,
+        AsyncValkeyInstance,
+        PipelineInstance,
+        ValkeyInstance,
+    )
+
+_FIELD_TYPES = ["NUMERIC", "TEXT", "GEO", "TAG", "VECTOR"]
+
+
+def _extract_conn_attributes(conn_kwargs):
+    """Transform valkey conn info into dict"""
+    attributes = {
+        DB_SYSTEM: DbSystemValues.REDIS.value,
+    }
+    db = conn_kwargs.get("db", 0)
+    attributes[DB_REDIS_DATABASE_INDEX] = db
+    if "path" in conn_kwargs:
+        attributes[NET_PEER_NAME] = conn_kwargs.get("path", "")
+        attributes[NET_TRANSPORT] = NetTransportValues.OTHER.value
+    else:
+        attributes[NET_PEER_NAME] = conn_kwargs.get("host", "localhost")
+        attributes[NET_PEER_PORT] = conn_kwargs.get("port", 6379)
+        attributes[NET_TRANSPORT] = NetTransportValues.IP_TCP.value
+
+    return attributes
+
+
+def _format_command_args(args: list[str]):
+    """Format and sanitize command arguments, and trim them as needed"""
+    cmd_max_len = 1000
+    value_too_long_mark = "..."
+
+    # Sanitized query format: "COMMAND ? ?"
+    args_length = len(args)
+    if args_length > 0:
+        out = [str(args[0])] + ["?"] * (args_length - 1)
+        out_str = " ".join(out)
+
+        if len(out_str) > cmd_max_len:
+            out_str = (
+                out_str[: cmd_max_len - len(value_too_long_mark)]
+                + value_too_long_mark
+            )
+    else:
+        out_str = ""
+
+    return out_str
+
+
+def _set_span_attribute_if_value(span, name, value):
+    if value is not None and value != "":
+        span.set_attribute(name, value)
+
+
+def _value_or_none(values, n):
+    try:
+        return values[n]
+    except IndexError:
+        return None
+
+
+def _set_connection_attributes(
+    span: Span, conn: ValkeyInstance | AsyncValkeyInstance
+) -> None:
+    if not span.is_recording() or not hasattr(conn, "connection_pool"):
+        return
+    for key, value in _extract_conn_attributes(
+        conn.connection_pool.connection_kwargs
+    ).items():
+        span.set_attribute(key, value)
+
+
+def _build_span_name(
+    instance: ValkeyInstance | AsyncValkeyInstance, cmd_args: tuple[Any, ...]
+) -> str:
+    if len(cmd_args) > 0 and cmd_args[0]:
+        if cmd_args[0] == "FT.SEARCH":
+            name = "valkey.search"
+        elif cmd_args[0] == "FT.CREATE":
+            name = "valkey.create_index"
+        else:
+            name = cmd_args[0]
+    else:
+        name = instance.connection_pool.connection_kwargs.get("db", 0)
+    return name
+
+
+def _add_create_attributes(span: Span, args: tuple[Any, ...]):
+    _set_span_attribute_if_value(
+        span, "valkey.create_index.index", _value_or_none(args, 1)
+    )
+    # According to: https://github.com/valkey/valkey-py/blob/master/valkey/commands/search/commands.py#L155 schema is last argument for execute command
+    try:
+        schema_index = args.index("SCHEMA")
+    except ValueError:
+        return
+    schema = args[schema_index:]
+    field_attribute = ""
+    # Schema in format:
+    # [first_field_name, first_field_type, first_field_some_attribute1, first_field_some_attribute2, second_field_name, ...]
+    field_attribute = "".join(
+        f"Field(name: {schema[index - 1]}, type: {schema[index]});"
+        for index in range(1, len(schema))
+        if schema[index] in _FIELD_TYPES
+    )
+    _set_span_attribute_if_value(
+        span,
+        "valkey.create_index.fields",
+        field_attribute,
+    )
+
+
+def _add_search_attributes(span: Span, response, args):
+    _set_span_attribute_if_value(
+        span, "valkey.search.index", _value_or_none(args, 1)
+    )
+    _set_span_attribute_if_value(
+        span, "valkey.search.query", _value_or_none(args, 2)
+    )
+    # Parse response from search
+    # https://valkey.io/docs/latest/commands/ft.search/
+    # Response in format:
+    # [number_of_returned_documents, index_of_first_returned_doc, first_doc(as a list), index_of_second_returned_doc, second_doc(as a list) ...]
+    # Returned documents in array format:
+    # [first_field_name, first_field_value, second_field_name, second_field_value ...]
+    number_of_returned_documents = _value_or_none(response, 0)
+    _set_span_attribute_if_value(
+        span, "valkey.search.total", number_of_returned_documents
+    )
+    if "NOCONTENT" in args or not number_of_returned_documents:
+        return
+    for document_number in range(number_of_returned_documents):
+        document_index = _value_or_none(response, 1 + 2 * document_number)
+        if document_index:
+            document = response[2 + 2 * document_number]
+            for attribute_name_index in range(0, len(document), 2):
+                _set_span_attribute_if_value(
+                    span,
+                    f"valkey.search.xdoc_{document_index}.{document[attribute_name_index]}",
+                    document[attribute_name_index + 1],
+                )
+
+
+def _build_span_meta_data_for_pipeline(
+    instance: PipelineInstance | AsyncPipelineInstance,
+) -> tuple[list[Any], str, str]:
+    try:
+        command_stack = (
+            instance.command_stack
+            if hasattr(instance, "command_stack")
+            else instance._command_stack
+        )
+
+        cmds = [
+            _format_command_args(c.args if hasattr(c, "args") else c[0])
+            for c in command_stack
+        ]
+        resource = "\n".join(cmds)
+
+        span_name = " ".join(
+            [
+                (c.args[0] if hasattr(c, "args") else c[0][0])
+                for c in command_stack
+            ]
+        )
+    except (AttributeError, IndexError):
+        command_stack = []
+        resource = ""
+        span_name = ""
+
+    return command_stack, resource, span_name

opentelemetry/instrumentation/valkey/version.py

@@ -0,0 +1,16 @@
+# Copyright The OpenTelemetry Authors
+# Copyright 2025 Philip Meier
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__version__ = "0.59b0"

opentelemetry_python_contrib_external_valkey-0.59b0.dist-info/METADATA

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: opentelemetry-python-contrib-external-valkey
+Version: 0.59b0
+Summary: OpenTelemetry Valkey instrumentation
+Author: Philip Meier
+Author-email: Philip Meier <github.pmeier@posteo.de>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Dist: opentelemetry-api~=1.12
+Requires-Dist: opentelemetry-instrumentation==0.59b0
+Requires-Dist: opentelemetry-semantic-conventions==0.59b0
+Requires-Dist: wrapt>=1.12.1
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# opentelemetry-python-contrib-external-valkey
+
+[OpenTelemetry](https://opentelemetry.io/) instrumentation for the [Valkey Python Client](https://github.com/valkey-io/valkey-py).
+
+## How do I install it?
+
+`opentelemetry-python-contrib-external-valkey` is available on [PyPI](). You can install it with
+
+```shell
+pip install opentelemetry-python-contrib-external-valkey
+```
+
+or
+
+```shell
+uv add opentelemetry-python-contrib-external-valkey
+```
+
+or something equivalent.
+
+## How do I use it?
+
+For global instrumentation of the [Valkey Python client](https://github.com/valkey-io/valkey-py) you can do
+
+```python
+from opentelemetry.instrumentation.valkey import ValkeyInstrumentor
+
+ValkeyInstrumentor().instrument()
+```
+
+For more detailed documentation please have a look at the [`opentelemetry-instrumentation-redis` documentation](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/redis/redis.html) and just replace `[rR]edis` with `[vV]alkey`. 
+
+## 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. 
+
+## How does it work?
+
+This repository is a fork of [opentelemetry-python-contrib](https://github.com/open-telemetry/opentelemetry-python-contrib) and specifically the [instrumentation/opentelemetry-instrumentation-redis](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-redis) folder. 95% and more of the changes in the [`src`](./src) and [`tests`](./tests) folders are just replacing the strings `redis` and `Redis` with `valkey` and `Valkey` respectively.

opentelemetry_python_contrib_external_valkey-0.59b0.dist-info/RECORD

@@ -0,0 +1,11 @@
+opentelemetry/instrumentation/valkey/__init__.py,sha256=IOJ081wIeMvKGe-1b9LR-WAsvXA5duVJGBZykG53wQI,22542
+opentelemetry/instrumentation/valkey/custom_types.py,sha256=AT50F8SH9y5jaRmQSaFsfcZqbKp2CDF-K0fEWFcZpqE,1526
+opentelemetry/instrumentation/valkey/package.py,sha256=kQDLjcUvBI9m2ZHVV0YuFoFRavyPHfSH-um_-YfrJd0,651
+opentelemetry/instrumentation/valkey/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+opentelemetry/instrumentation/valkey/util.py,sha256=X0vjCsd8C2m2QW-rtuTw754q9E5Oh-kR4twSXoJy7kc,6815
+opentelemetry/instrumentation/valkey/version.py,sha256=xmeLuE7OeefuVCoPON9-rRxvSZpvlXduXJ8tKHcJDRA,638
+opentelemetry_python_contrib_external_valkey-0.59b0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentelemetry_python_contrib_external_valkey-0.59b0.dist-info/WHEEL,sha256=3id4o64OvRm9dUknh3mMJNcfoTRK08ua5cU6DFyVy-4,79
+opentelemetry_python_contrib_external_valkey-0.59b0.dist-info/entry_points.txt,sha256=UAykx797M8H87MbfSsUy6dWAnUCJmp1UiBHLOq5uCXk,94
+opentelemetry_python_contrib_external_valkey-0.59b0.dist-info/METADATA,sha256=JFgwemts4QkDBhu6dJIi3qeXD5Be7QBSc5kuk8-wH64,2653
+opentelemetry_python_contrib_external_valkey-0.59b0.dist-info/RECORD,,

opentelemetry_python_contrib_external_valkey-0.59b0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.13
+Root-Is-Purelib: true
+Tag: py3-none-any

opentelemetry_python_contrib_external_valkey-0.59b0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[opentelemetry_instrumentor]
+redis = opentelemetry.instrumentation.valkey:ValkeyInstrumentor
+

opentelemetry_python_contrib_external_valkey-0.59b0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.