otel support

getzep · Nov 15, 2023 · e2b8d5e · e2b8d5e
1 parent 578d5ba
commit e2b8d5e
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 4 deletions.
diff --git a/docs/deployment/config.md b/docs/deployment/config.md
@@ -30,9 +30,10 @@ Note the defaults below for the embedding models and review the [Selecting Embed
 | server.port                                 | ZEP_SERVER_PORT                                 | 8000                                                         |
 | server.web_enabled                          | ZEP_SERVER_WEB_ENABLED                          | true                                                         |
 | server.max_request_size                     | ZEP_SERVER_MAX_REQUEST_SIZE                     | 5242880                                                      |
-| nlp.server_url                              | ZEP_NLP_SERVER_URL                              | Installation dependent.                                      |
-| development                                 | ZEP_DEVELOPMENT                                 | false                                                        |
-| log.level                                   | ZEP_LOG_LEVEL                                   | info                                                         |
+ nlp.server_url                              | ZEP_NLP_SERVER_URL                              | Installation dependent.                                      |
+ opentelemetry.enabled                       | ZEP_OPENTELEMETRY_ENABLED                       | false                                                        |
+ development                                 | ZEP_DEVELOPMENT                                 | false                                                        |
+ log.level                                   | ZEP_LOG_LEVEL                                   | info                                                         |
 
 ### Authentication Config
 

diff --git a/docs/deployment/index.md b/docs/deployment/index.md
@@ -5,7 +5,8 @@
 3. Deploying to [Kubernetes](kubernetes.md).
 3. Deploying to [production environments.](production.md)
 4. [Securing Zep](security.md) and [Configuring authentication.](auth.md)
-5. [Data management](data.md) with Zep.
+5. Configuring [OpenTelemetry](otel.md) tracing.
+6. [Data management](data.md) with Zep.
 
 Next Steps:
 

diff --git a/docs/deployment/otel.md b/docs/deployment/otel.md
@@ -0,0 +1,16 @@
+# OpenTelemetry Tracing
+
+Zep supports [OpenTelemetry](https://opentelemetry.io/) tracing. This allows you to trace requests through the Zep service, identify bottlenecks, and understand the performance of your Zep deployment. In particular, this is useful to understand how LLM service latency might be impacting your Zep operations.
+
+## Enabling OpenTelemetry
+
+Set `opentelemetry.enabled` to true in your `config.yaml` file or set the `ZEP_OPENTELEMETRY_ENABLED` environment variable to true. 
+
+Then, set your OpenTelemetry Exporter config in your environment. This is vendor specific, but you can an example below.
+
+```
+OTEL_SERVICE_NAME="zep"
+OTEL_EXPORTER_OTLP_ENDPOINT="<your endpoint>"
+OTEL_EXPORTER_OTLP_TRACES_ENDPOINT="<your endpoint>"
+OTEL_EXPORTER_OTLP_HEADERS="YOUR-AUTH-HEADER"
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -51,6 +51,7 @@ nav:
       - Authentication: deployment/auth.md
       - LLM API Config: deployment/llm_config.md
       - Custom Prompts: deployment/prompts.md
+      - OpenTelemetry: deployment/otel.md
       - Data Management: deployment/data.md
 
   - Support: support/index.md