docker example

Signed-off-by: Adrian Cole <[email protected]>

Author: codefromthecrypt

instrumentation-genai/opentelemetry-instrumentation-openai-v2/example/.env

@@ -1,15 +1,18 @@
+# Update this with your real OpenAI API key
+OPENAI_API_KEY=sk-YOUR_API_KEY
+
 # Uncomment to use Ollama instead of OpenAI
 # OPENAI_BASE_URL=http://localhost:11434/v1
 # OPENAI_API_KEY=unused
 # CHAT_MODEL=qwen2.5:0.5b
 
 OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
 OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
-OTEL_SERVICE_NAME=opentelemetry-instrumentation-openai-v2
+OTEL_SERVICE_NAME=opentelemetry-python-openai
 
-# This automatically configure logging
+# Change to 'false' to disable logging
 OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true
 # Change to 'console' if your OTLP endpoint doesn't support logs
 OTEL_LOGS_EXPORTER=otlp_proto_http
-# Set to false to hide prompt and completion content
+# Change to 'false' to hide prompt and completion content
 OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true

instrumentation-genai/opentelemetry-instrumentation-openai-v2/example/Dockerfile

@@ -0,0 +1,10 @@
+# Use an alpine image to make the runtime smaller
+FROM docker.io/python:3.12.7-alpine3.20
+RUN python -m pip install --upgrade pip
+
+COPY /requirements.txt /tmp/requirements.txt
+RUN pip install -r /tmp/requirements.txt
+
+COPY main.py /
+
+CMD [ "opentelemetry-instrument", "python", "main.py" ]

instrumentation-genai/opentelemetry-instrumentation-openai-v2/example/README.rst

@@ -4,14 +4,36 @@ OpenTelemetry OpenAI Instrumentation Example
 This is an example of how to instrument OpenAI calls with zero code changes,
 using `opentelemetry-instrument`.
 
-When [main.py](main.py) is run, it exports traces and logs to an
-OTLP-compatible endpoint. Traces include details such as the model used and the
+When `main.py <main.py>`_ is run, it exports traces and logs to an OTLP
+compatible endpoint. Traces include details such as the model used and the
 duration of the chat request. Logs capture the chat request and the generated
 response, providing a comprehensive view of the performance and behavior of
 your OpenAI requests.
 
-Installation
-------------
+Setup
+-----
+
+Minimally, update the `.env <.env>`_ file with your "OPENAI_API_KEY". An
+OTLP compatible endpoint should be listening for traces and logs on
+http://localhost:4318. If not, update "OTEL_EXPORTER_OTLP_ENDPOINT" as well.
+
+Run with Docker
+---------------
+
+If you have Docker installed, you can run the example in one step:
+
+::
+
+    docker-compose run --build --rm python-opentelemetry-openai
+
+You should see a poem generated by OpenAI while traces and logs export to your
+configured observability tool.
+
+Run with Python
+---------------
+
+If you prefer to run the example with Python, set up a virtual environment for
+the example like this:
 
 ::
 
@@ -20,16 +42,11 @@ Installation
     pip install "python-dotenv[cli]"
     pip install -r requirements.txt
 
-Running the Example
--------------------
-
-Update the `.env` file with your OpenAI API key, or to change where to export
-traces and logs. Then, run the example like this:
+Now, run the example like this:
 
 ::
 
     dotenv run -- opentelemetry-instrument python main.py
 
-You should see a poem generated by OpenAI, with traces and logs exported to
-and OTLP compatible endpoint on localhost. You can then view them in your
-preferred observability tool.
+You should see a poem generated by OpenAI while traces and logs export to your
+configured observability tool.

instrumentation-genai/opentelemetry-instrumentation-openai-v2/example/docker-compose.yml

@@ -0,0 +1,9 @@
+services:
+  opentelemetry-python-openai:
+    container_name: opentelemetry-python-openai
+    build:
+      context: .
+    env_file:
+      - .env
+    environment:
+      OTEL_EXPORTER_OTLP_ENDPOINT: "http://host.docker.internal:4318"