From 134af4aa93d3e178e6651fae8d4766e24626ab46 Mon Sep 17 00:00:00 2001 From: Mikhail Koviazin Date: Wed, 11 Jun 2025 19:07:54 +0200 Subject: [PATCH 1/2] docs: fix OpenTelemetry documentation There's no opentelemetry-instrumentation-valkey as of now, although it is WIP [1]. Fix the link for now, we can revert it later. [1] https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3478 Signed-off-by: Mikhail Koviazin --- docs/examples/opentelemetry/main.py | 4 ++-- docs/opentelemetry.rst | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/examples/opentelemetry/main.py b/docs/examples/opentelemetry/main.py index 91c9268d..d05d0cff 100755 --- a/docs/examples/opentelemetry/main.py +++ b/docs/examples/opentelemetry/main.py @@ -5,7 +5,7 @@ import uptrace import valkey from opentelemetry import trace -from opentelemetry.instrumentation.valkey import ValkeyInstrumentor +from opentelemetry.instrumentation.redis import RedisInstrumentor tracer = trace.get_tracer("app_or_package_name", "1.0.0") @@ -16,7 +16,7 @@ def main(): service_name="myservice", service_version="1.0.0", ) - ValkeyInstrumentor().instrument() + RedisInstrumentor().instrument() client = valkey.StrictValkey(host="localhost", port=6379) diff --git a/docs/opentelemetry.rst b/docs/opentelemetry.rst index 790a98ef..77f61baa 100644 --- a/docs/opentelemetry.rst +++ b/docs/opentelemetry.rst @@ -36,15 +36,15 @@ To install OpenTelemetry `instrumentation `_ that supports distributed tracing, metrics, and logs. You can use it to monitor applications and set up automatic alerts to receive notifications via email, Slack, Telegram, and more. -You can use Uptrace to monitor valkey-py using this `GitHub example `_ as a starting point. +You can use Uptrace to monitor valkey-py using this `GitHub example `_ as a starting point. -.. image:: images/opentelemetry/valkey-py-trace.png +.. image:: images/opentelemetry/redis-py-trace.png :alt: Valkey-py trace You can `install Uptrace `_ by downloading a DEB/RPM package or a pre-compiled binary. @@ -113,9 +113,9 @@ In addition to monitoring valkey-py client, you can also monitor Valkey Server p OpenTelemetry Collector is a proxy/middleman between your application and a `distributed tracing tool `_ such as Uptrace or Jaeger. Collector receives telemetry data, processes it, and then exports the data to APM tools that can store it permanently. -For example, you can use the `OpenTelemetry Valkey receiver ` provided by Otel Collector to monitor Valkey performance: +For example, you can use the `OpenTelemetry Redis receiver `_ provided by Otel Collector to monitor Valkey performance: -.. image:: images/opentelemetry/valkey-metrics.png +.. image:: images/opentelemetry/redis-metrics.png :alt: Valkey metrics See introduction to `OpenTelemetry Collector `_ for details. From cae1f878093082df714a4d051ad4728e568a9c5c Mon Sep 17 00:00:00 2001 From: Ahmed Sobeh Date: Thu, 12 Jun 2025 14:40:14 +0200 Subject: [PATCH 2/2] Update wordlist.txt Signed-off-by: Ahmed Sobeh Signed-off-by: Mikhail Koviazin --- .github/wordlist.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/wordlist.txt b/.github/wordlist.txt index 36b8b386..a62df860 100644 --- a/.github/wordlist.txt +++ b/.github/wordlist.txt @@ -38,6 +38,7 @@ READONLY RediSearch RedisBloom RedisGraph +RedisInstrumentor RedisJSON RedisTimeSeries SHA