-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ENH]: Local Observability Stack with OTEL and Zipkin (#1279)
## Description of changes *Summarize the changes made by this PR.* - New functionality - Added the possibility to run the observability stack (OTEL collector + Zipkin) alongside Chroma server in a docker-compose ## Test plan *How are these changes tested?* - [x] Manual testing ## Documentation Changes Observability section on chroma docs updated - chroma-core/docs#149
- Loading branch information
Showing
3 changed files
with
78 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Observability | ||
|
||
## Local Observability Stack | ||
|
||
To run the Chroma with local observability stack (OpenTelemetry + Zipkin), | ||
run the following command from the root of the repository: | ||
|
||
```bash | ||
docker compose -f examples/observability/docker-compose.local-observability.yml up --build -d | ||
``` |
52 changes: 52 additions & 0 deletions
52
examples/observability/docker-compose.local-observability.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
version: '3.9' | ||
networks: | ||
net: | ||
|
||
services: | ||
zipkin: | ||
image: openzipkin/zipkin | ||
ports: | ||
- "9411:9411" # you can access Zipkin UI at http://localhost:9411 | ||
depends_on: [otel-collector] | ||
networks: | ||
- net | ||
otel-collector: | ||
image: otel/opentelemetry-collector-contrib | ||
command: ["--config=/etc/otel-collector-config.yaml"] | ||
volumes: | ||
- ${PWD}/examples/observability/otel-collector-config.yaml:/etc/otel-collector-config.yaml | ||
ports: | ||
- "4317:4317" # OTLP | ||
- "55681:55681" # Legacy | ||
networks: | ||
- net | ||
server: | ||
image: server | ||
build: | ||
context: ${PWD} | ||
dockerfile: Dockerfile | ||
volumes: | ||
- ${PWD}/:/chroma | ||
# Be aware that indexed data are located in "/chroma/chroma/" | ||
# Default configuration for persist_directory in chromadb/config.py | ||
command: uvicorn chromadb.app:app --reload --workers 1 --host 0.0.0.0 --port 8000 --log-config chromadb/log_config.yml | ||
environment: | ||
- IS_PERSISTENT=TRUE | ||
- CHROMA_SERVER_AUTH_PROVIDER=${CHROMA_SERVER_AUTH_PROVIDER} | ||
- CHROMA_SERVER_AUTH_CREDENTIALS_FILE=${CHROMA_SERVER_AUTH_CREDENTIALS_FILE} | ||
- CHROMA_SERVER_AUTH_CREDENTIALS=${CHROMA_SERVER_AUTH_CREDENTIALS} | ||
- CHROMA_SERVER_AUTH_CREDENTIALS_PROVIDER=${CHROMA_SERVER_AUTH_CREDENTIALS_PROVIDER} | ||
- PERSIST_DIRECTORY=${PERSIST_DIRECTORY:-/chroma/chroma} | ||
- CHROMA_OTEL_COLLECTION_ENDPOINT=http://otel-collector:4317/ | ||
- CHROMA_OTEL_EXPORTER_HEADERS=${CHROMA_OTEL_EXPORTER_HEADERS} | ||
- CHROMA_OTEL_SERVICE_NAME=${CHROMA_OTEL_SERVICE_NAME:-chroma} | ||
- CHROMA_OTEL_GRANULARITY=${CHROMA_OTEL_GRANULARITY:-all} | ||
ports: | ||
- 8000:8000 | ||
depends_on: [otel-collector] | ||
networks: | ||
- net | ||
|
||
volumes: | ||
backups: | ||
driver: local |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
receivers: | ||
otlp: | ||
protocols: | ||
grpc: | ||
http: | ||
|
||
exporters: | ||
logging: | ||
zipkin: | ||
endpoint: "http://zipkin:9411/api/v2/spans" | ||
|
||
service: | ||
pipelines: | ||
traces: | ||
receivers: [otlp] | ||
exporters: [zipkin] |