Add OTel configuration

Author: christinaexyou

Dockerfile.server

@@ -14,6 +14,7 @@ COPY examples/ ./examples/
 COPY chat-ui/ ./chat-ui/
 COPY scripts/provider-list.yaml ./scripts/
 COPY scripts/filter_guardrails.py ./scripts/
+COPY scripts/setup_otel.py ./scripts/
 COPY scripts/entrypoint.sh ./scripts/
 RUN chmod +x ./scripts/entrypoint.sh
 
@@ -24,7 +25,11 @@ ENV POETRY_VIRTUALENVS_IN_PROJECT=1 \
     POETRY_NO_INTERACTION=1
 
 RUN poetry install --no-ansi --extras="sdd jailbreak openai nvidia tracing" && \
-    poetry run pip install "spacy>=3.4.4,<4.0.0" && \
+    poetry run pip install \
+    "spacy>=3.4.4,<4.0.0" \
+    "opentelemetry-api>=1.27.0,<2.0.0" \
+    "opentelemetry-sdk>=1.27.0,<2.0.0" \
+    "opentelemetry-exporter-otlp>=1.27.0,<2.0.0" && \
     poetry run python -m spacy download en_core_web_lg
 
 FROM registry.access.redhat.com/ubi9/python-312

poetry.lock

@@ -19,9 +19,52 @@ if [[ ! -f "$CONFIG_DIR/rails.co" ]]; then
   exit 1
 fi
 
+# Setup OpenTelemetry
+ENABLE_OTEL="${ENABLE_OTEL:-${AUTO_SETUP_OTEL:-false}}"
+
+if [[ "${ENABLE_OTEL,,}" == "true" ]]; then
+  echo "🔧 Configuring OpenTelemetry:"
+  export OTEL_SERVICE_NAME="${OTEL_SERVICE_NAME:-guardrails}"
+  export OTEL_SERVICE_VERSION="${OTEL_SERVICE_VERSION:-1.0.0}"
+  export OTEL_ENVIRONMENT="${OTEL_ENVIRONMENT:-production}"
+  export OTEL_ENABLE_CONSOLE="${OTEL_ENABLE_CONSOLE:-false}"
+  export OTEL_EXPORTER_OTLP_INSECURE="${OTEL_EXPORTER_OTLP_INSECURE:-true}"
+  export OTEL_EXPORTER_OTLP_ENDPOINT="${OTEL_EXPORTER_OTLP_ENDPOINT:-http://jaeger:4317}"
+
+else
+  echo "📝 OpenTelemetry disabled - starting without tracing"
+fi
+
+echo ""
 echo "✅ Configuration validated. Starting server..."
-exec /app/.venv/bin/nemoguardrails server \
-  --config "/app/config" \
-  --port "$PORT" \
-  --default-config-id "$CONFIG_ID" \
-  --disable-chat-ui
+
+exec /app/.venv/bin/python3 -c "
+import os
+import sys
+
+# Setup OpenTelemetry if enabled
+if os.getenv('ENABLE_OTEL', '').lower() == 'true':
+    print('🔍 Setting up OpenTelemetry within server process...')
+    try:
+        sys.path.insert(0, '/app/scripts')
+        from setup_otel import setup_opentelemetry
+        setup_opentelemetry()
+        print('✅ OpenTelemetry configured in server process')
+    except Exception as e:
+        print(f'❌ OpenTelemetry setup failed: {e}')
+        import traceback
+        traceback.print_exc()
+        sys.exit(1)
+
+# Start the NeMo Guardrails server
+import uvicorn
+from nemoguardrails.server import api
+
+# Set up the server configuration
+api.app.rails_config_path = '/app/config'
+api.app.disable_chat_ui = True
+api.set_default_config_id('${CONFIG_ID}')
+
+# Start the server using uvicorn
+uvicorn.run(api.app, port=${PORT}, log_level='info', host='0.0.0.0')
+"

scripts/entrypoint.sh

@@ -0,0 +1,50 @@
+import os
+
+from opentelemetry import trace
+from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
+from opentelemetry.sdk.resources import Resource
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter
+
+
+def setup_opentelemetry():
+    """Configure OpenTelemetry SDK with OTLP and Console exporters."""
+    # Get configuration from environment variables
+    service_name = os.getenv("OTEL_SERVICE_NAME", "guardrails")
+    service_version = os.getenv("OTEL_SERVICE_VERSION", "1.0.0")
+    environment = os.getenv("OTEL_ENVIRONMENT", "production")
+    otlp_endpoint = os.getenv("OTEL_EXPORTER_OTLP_ENDPOINT")
+    enable_console = os.getenv("OTEL_ENABLE_CONSOLE", "true").lower() == "true"
+
+    # Configure resource (metadata about the service)
+    resource = Resource.create(
+        {
+            "service.name": service_name,
+            "service.version": service_version,
+            "deployment.environment": environment,
+            "service.namespace": "nemo-guardrails",
+        }
+    )
+
+    # Set up the tracer provider
+    tracer_provider = TracerProvider(resource=resource)
+    trace.set_tracer_provider(tracer_provider)
+
+    exporters_configured = []
+
+    # Configure OTLP exporter if endpoint is provided
+    if otlp_endpoint:
+        otlp_exporter = OTLPSpanExporter(
+            endpoint=otlp_endpoint,
+            insecure=os.getenv("OTEL_EXPORTER_OTLP_INSECURE", "true").lower() == "true",
+        )
+
+        tracer_provider.add_span_processor(BatchSpanProcessor(otlp_exporter))
+        exporters_configured.append("OTLP")
+
+    # Configure console exporter for debugging
+    if enable_console:
+        print("📝 Enabling console exporter for debugging")
+        console_exporter = ConsoleSpanExporter()
+        tracer_provider.add_span_processor(BatchSpanProcessor(console_exporter))
+        exporters_configured.append("Console")