Streamlit + LangGraph agent telemetry example

Author: aabmass

instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo/.dockerignore

@@ -0,0 +1,2 @@
+.venv
+docker-compose.yaml

instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo/.python-version

@@ -0,0 +1 @@
+3.13

instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo/Dockerfile

@@ -0,0 +1,14 @@
+FROM ghcr.io/astral-sh/uv:python3.13-bookworm-slim AS build
+RUN apt update && apt install -y git curl
+WORKDIR /build
+ARG GIT_REF
+ENV SCRIPT_URL="https://raw.githubusercontent.com/aabmass/opentelemetry-python-contrib/${GIT_REF?must be set to a git commit}/instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo/run_streamlit.py"
+# Creates the virtualenv
+RUN curl -LO "${SCRIPT_URL}" && curl -LO "${SCRIPT_URL}.lock"
+RUN VIRTUAL_ENV=./venv uv sync --active --frozen --script run_streamlit.py
+
+FROM python:3.13-slim
+WORKDIR /build
+COPY --from=build /build/ .
+ENV PATH="/build/venv/bin:$PATH"
+ENTRYPOINT ["python", "run_streamlit.py"]

instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo/README.md

@@ -0,0 +1,55 @@
+This sample contains a Streamlit + LangGraph chatbot demo. It sends traces and logs to the GCP
+with the OTLP exporter and opentelemetry-exporter-gcp-logging exporters.
+
+The `run_streamlit.py` script allows you to easily run the sample with auto instrumentation
+enabled and sending telemetry to GCP. It just sets some environment variables and runs with
+`opentelemetry-instrument.
+
+## Running the example
+
+First, make sure you have `uv` installed: https://docs.astral.sh/uv/getting-started/installation/.
+
+Optionally, set a project with `export GOOGLE_CLOUD_PROJECT=...`. The app respects ADC.
+
+### Without cloning
+
+```sh
+uv run --upgrade https://raw.githubusercontent.com/aabmass/opentelemetry-python-contrib/refs/heads/vertex-langgraph/instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo/run_streamlit.py
+```
+
+### With cloned repo
+
+```sh
+git clone --branch=vertex-langgraph https://github.com/aabmass/opentelemetry-python-contrib.git
+cd opentelemetry-python-contrib/instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo
+uv run run_streamlit_local.py
+```
+
+### Without auto instrumentation
+
+```sh
+uv run streamlit run src/langgraph_chatbot_demo/langchain_history.py
+```
+
+## Deploy
+
+Build the docker image
+
+```sh
+PROJECT=<...>
+TAG=0.x.y
+
+# Update GIT_REF to a commit SHA to force rebuilding if the branch is updated
+docker build \
+--build-arg GIT_REF=vertex-langgraph \
+-t us-central1-docker.pkg.dev/${PROJECT}/oci/langgraph-chatbot-demo:${TAG} \
+https://raw.githubusercontent.com/aabmass/opentelemetry-python-contrib/refs/heads/vertex-langgraph/instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo/Dockerfile
+```
+
+### App Engine
+
+Use the included app.yaml
+
+```sh
+gcloud app deploy --image-url=us-central1-docker.pkg.dev/${PROJECT}/oci/langgraph-chatbot-demo:${TAG} app.yaml
+```

instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo/app.yaml

@@ -0,0 +1,11 @@
+runtime: custom
+env: flex
+env_variables:
+  STREAMLIT_SERVER_PORT: "8080"
+  PYTHONUNBUFFERED: "1"
+
+network:
+  session_affinity: true
+
+resources:
+  memory_gb: 2

instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "langgraph-chatbot-demo"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "duckduckgo-search>=7.3.0",
+    "google-cloud-storage[tracing]>=2.19.0",
+    "langchain-community>=0.3.16",
+    "langchain-core>=0.3.31",
+    "langchain-google-vertexai>=2.0.7",
+    "langgraph>0.2.27",
+    "opentelemetry-distro>=0.50b0",
+    "opentelemetry-exporter-gcp-logging>=1.9.0a0",
+    "opentelemetry-exporter-gcp-trace>=1.8.0",
+    "opentelemetry-exporter-otlp-proto-grpc>=1.29.0",
+    "opentelemetry-instrumentation-aiohttp-client>=0.50b0",
+    "opentelemetry-instrumentation-httpx>=0.50b0",
+    "opentelemetry-instrumentation-requests>=0.50b0",
+    "opentelemetry-instrumentation-sqlite3>=0.51b0",
+    "opentelemetry-instrumentation-urllib>=0.50b0",
+    "opentelemetry-instrumentation-urllib3>=0.50b0",
+    "opentelemetry-instrumentation-vertexai>=2.0b0",
+    "streamlit>=1.41.1",
+]
+
+[tool.uv.sources]
+opentelemetry-instrumentation-vertexai = { path = "../../" }
+
+[dependency-groups]
+dev = ["ipython>=8.18.1", "ruff>=0.9.2"]
+
+[project.entry-points.opentelemetry_traces_exporter]
+otlp_google_auth = "langgraph_chatbot_demo._otlp_google_auth:OTLPSpanExporterGoogleAuth"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo/run_streamlit.py

@@ -0,0 +1,14 @@
+# /// script
+# requires-python = ">=3.13"
+# dependencies = [
+#  "langgraph-chatbot-demo",
+# ]
+#
+# [tool.uv.sources]
+# langgraph-chatbot-demo = { git = "https://github.com/aabmass/opentelemetry-python-contrib.git", subdirectory = "instrumentation-genai/opentelemetry-instrumentation-vertexai/examples/langgraph-chatbot-demo", branch = "vertex-langgraph" }
+#
+# ///
+
+from langgraph_chatbot_demo.run_streamlit import run_streamlit
+
+run_streamlit()