docs: instrument llama-index example for sessions (#1142)

python/examples/llama-index/backend/app/api/routers/chat.py

@@ -99,8 +99,12 @@ async def chat(
     data: _ChatData,
     chat_engine: BaseChatEngine = Depends(get_chat_engine),
 ):
-    span = tracer.start_span("chat", attributes={SpanAttributes.OPENINFERENCE_SPAN_KIND: "CHAIN"})
-    with trace.use_span(span, end_on_exit=False):
+    attributes = {SpanAttributes.OPENINFERENCE_SPAN_KIND: "CHAIN"}
+    if (session_id := request.headers.get("X-Session-Id", None)) is not None:
+        attributes[SpanAttributes.SESSION_ID] = session_id
+    if (user_id := request.headers.get("X-User-Id", None)) is not None:
+        attributes[SpanAttributes.USER_ID] = user_id
+    with tracer.start_as_current_span("chat", attributes=attributes,end_on_exit=False) as span:
         last_message_content, messages = await parse_chat_data(data)
         span.set_attribute(SpanAttributes.INPUT_VALUE, last_message_content)
         response = await chat_engine.astream_chat(last_message_content, messages)

python/examples/llama-index/backend/instrument.py

@@ -4,12 +4,13 @@
 from opentelemetry.sdk import trace as trace_sdk
 from opentelemetry.sdk.resources import Resource
 from opentelemetry.sdk.trace.export import SimpleSpanProcessor
+from openinference.semconv.resource import ResourceAttributes
 import os
 
 
 def instrument():
     collector_endpoint = os.getenv("COLLECTOR_ENDPOINT")
-    resource = Resource(attributes={})
+    resource = Resource(attributes={ResourceAttributes.PROJECT_NAME: "llama-index-chat"})
     tracer_provider = trace_sdk.TracerProvider(resource=resource)
     span_exporter = OTLPSpanExporter(endpoint=collector_endpoint)
     span_processor = SimpleSpanProcessor(span_exporter=span_exporter)

python/examples/llama-index/compose.yaml

@@ -1,6 +1,6 @@
 services:
   phoenix:
-    image: arizephoenix/phoenix:version-3.21.0
+    image: arizephoenix/phoenix:latest
     ports:
       - "6006:6006"
   backend:

python/examples/llama-index/frontend/app/components/chat-section.tsx

@@ -6,6 +6,28 @@ import { insertDataIntoMessages } from "./transform";
 import { ChatInput, ChatMessages } from "./ui/chat";
 
 export default function ChatSection() {
+  const sessionId = useMemo(() => {
+    if (typeof window === 'undefined') return "";
+    const stored = sessionStorage.getItem("sessionId");
+    if (!stored) {
+      const newId = crypto.randomUUID();
+      sessionStorage.setItem("sessionId", newId);
+      return newId;
+    }
+    return stored;
+  }, []);
+
+  const userId = useMemo(() => {
+    if (typeof window === 'undefined') return "";
+    const stored = sessionStorage.getItem("userId");
+    if (!stored) {
+      const newId = crypto.randomUUID();
+      sessionStorage.setItem("userId", newId);
+      return newId;
+    }
+    return stored;
+  }, []);
+
   const {
     messages,
     input,
@@ -19,6 +41,8 @@ export default function ChatSection() {
     api: process.env.NEXT_PUBLIC_CHAT_API,
     headers: {
       "Content-Type": "application/json", // using JSON because of vercel/ai 2.2.26
+      "X-Session-Id": sessionId,
+      "X-User-Id": userId,
     },
   });