Add additional attributes for redis.search methods create_index, search (#2635)

This commit is contained in:
Marcin Poźniak
2024-10-03 00:42:33 +02:00
committed by GitHub
parent 65b703529b
commit 6bb6d3896d
5 changed files with 153 additions and 5 deletions

View File

@ -24,7 +24,7 @@ services:
POSTGRES_PASSWORD: testpassword
POSTGRES_DB: opentelemetry-tests
otredis:
image: redis:4.0-alpine
image: redis/redis-stack:7.2.0-v12
ports:
- "127.0.0.1:6379:6379"
otrediscluster:

View File

@ -18,6 +18,15 @@ from time import time_ns
import redis
import redis.asyncio
from redis.exceptions import ResponseError
from redis.commands.search.indexDefinition import IndexDefinition, IndexType
from redis.commands.search.aggregation import AggregateRequest
from redis.commands.search.query import Query
from redis.commands.search.field import (
TextField,
VectorField,
)
from opentelemetry import trace
from opentelemetry.instrumentation.redis import RedisInstrumentor
from opentelemetry.semconv.trace import SpanAttributes
@ -614,3 +623,63 @@ class TestRedisDBIndexInstrument(TestBase):
self.assertEqual(
span.attributes.get(SpanAttributes.DB_STATEMENT), "GET ?"
)
class TestRedisearchInstrument(TestBase):
def setUp(self):
super().setUp()
self.redis_client = redis.Redis(port=6379)
self.redis_client.flushall()
self.embedding_dim = 256
RedisInstrumentor().instrument(tracer_provider=self.tracer_provider)
self.prepare_data()
self.create_index()
def tearDown(self):
RedisInstrumentor().uninstrument()
super().tearDown()
def prepare_data(self):
try:
self.redis_client.ft("idx:test_vss").dropindex(True)
except ResponseError:
print("No such index")
item = {"name": "test",
"value": "test_value",
"embeddings": [0.1] * 256}
pipeline = self.redis_client.pipeline()
pipeline.json().set(f"test:001", "$", item)
res = pipeline.execute()
assert False not in res
def create_index(self):
schema = (
TextField("$.name", no_stem=True, as_name="name"),
TextField("$.value", no_stem=True, as_name="value"),
VectorField("$.embeddings",
"FLAT",
{
"TYPE": "FLOAT32",
"DIM": self.embedding_dim,
"DISTANCE_METRIC": "COSINE",
},
as_name="vector",),
)
definition = IndexDefinition(prefix=["test:"], index_type=IndexType.JSON)
res = self.redis_client.ft("idx:test_vss").create_index(fields=schema, definition=definition)
assert "OK" in str(res)
def test_redis_create_index(self):
spans = self.memory_exporter.get_finished_spans()
span = next(span for span in spans if span.name == "redis.create_index")
assert "redis.create_index.fields" in span.attributes
def test_redis_query(self):
query = "@name:test"
res = self.redis_client.ft("idx:test_vss").search(Query(query))
spans = self.memory_exporter.get_finished_spans()
span = next(span for span in spans if span.name == "redis.search")
assert span.attributes.get("redis.search.query") == query
assert span.attributes.get("redis.search.total") == 1