Chroma (tracing) | Respan Docs

Chroma is an open-source vector database for building semantic search and Retrieval-Augmented Generation systems.

Set up Respan

Create an account at platform.respan.ai and grab an API key.

Run npx @respan/cli setup to set up with your coding agent.

Example projects

Python examples

Tracing

Setup

Install packages

$ pip install respan-ai respan-instrumentation-chroma chromadb

Set environment variables

$ export RESPAN_API_KEY="YOUR_RESPAN_API_KEY"

RESPAN_API_KEY is used to export traces to Respan.

Initialize and run

1 import os
2 
3 import chromadb
4 from respan import Respan, workflow
5 from respan_instrumentation_chroma import ChromaInstrumentor
6 
7 respan = Respan(
8     api_key=os.environ["RESPAN_API_KEY"],
9     instrumentations=[ChromaInstrumentor()],
10 )
11 
12 
13 @workflow(name="chroma_query_and_filters_workflow")
14 def run_chroma_query() -> dict:
15     client = chromadb.Client()
16     collection = client.get_or_create_collection("respan_docs")
17 
18     collection.upsert(
19         ids=["doc-1"],
20         embeddings=[[0.1, 0.2, 0.3]],
21         documents=["Respan traces Chroma operations."],
22         metadatas=[{"topic": "observability"}],
23     )
24 
25     return collection.query(
26         query_embeddings=[[0.1, 0.2, 0.3]],
27         n_results=1,
28         include=["documents", "metadatas", "distances"],
29     )
30 
31 
32 print(run_chroma_query())
33 respan.flush()
34 respan.shutdown()

View your trace

Open the Traces page and search for workflow name chroma_query_and_filters_workflow.

Configuration

Parameter	Type	Default	Description
`api_key`	`str \| None`	`None`	Falls back to `RESPAN_API_KEY` env var.
`base_url`	`str \| None`	`None`	Falls back to `RESPAN_BASE_URL` env var.
`instrumentations`	`list`	`[]`	Plugin instrumentations to activate (e.g. `ChromaInstrumentor()`).
`customer_identifier`	`str \| None`	`None`	Default customer identifier for all spans.
`metadata`	`dict \| None`	`None`	Default metadata attached to all spans.
`environment`	`str \| None`	`None`	Environment tag (e.g. `"production"`).

Attributes

In Respan()

1 from respan import Respan
2 from respan_instrumentation_chroma import ChromaInstrumentor
3 
4 respan = Respan(
5     instrumentations=[ChromaInstrumentor()],
6     customer_identifier="user_123",
7     metadata={"service": "chroma-vector-db", "version": "1.0.0"},
8 )

With propagate_attributes

1 import chromadb
2 
3 from respan import Respan, propagate_attributes
4 from respan_instrumentation_chroma import ChromaInstrumentor
5 
6 respan = Respan(instrumentations=[ChromaInstrumentor()])
7 
8 
9 def run_query_with_attributes(user_id: str):
10     with propagate_attributes(
11         customer_identifier=user_id,
12         thread_identifier="chroma_thread",
13         metadata={"index": "respan_docs"},
14     ):
15         collection = chromadb.Client().get_or_create_collection("respan_docs")
16         return collection.query(query_embeddings=[[0.1, 0.2, 0.3]], n_results=3)

Attribute	Type	Description
`customer_identifier`	`str`	Identifies the end user in Respan analytics.
`thread_identifier`	`str`	Groups related messages into a conversation.
`metadata`	`dict`	Custom key-value pairs. Merged with default metadata.