polish

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

Author: codefromthecrypt

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

@@ -7,7 +7,10 @@ OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4317
 OTEL_EXPORTER_OTLP_PROTOCOL=grpc
 OTEL_SERVICE_NAME=opentelemetry-instrumentation-openai-v2
 
-# Set to false or remove to disable log events
-OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true
+
+# This automatically configure logging
 OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true
+# Change to 'console' if your OTLP endpoint doesn't support logs
 OTEL_LOGS_EXPORTER=otlp_proto_grpc
+# Set to false to hide prompt and completion content
+OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true

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

@@ -2,8 +2,13 @@ OpenTelemetry OpenAI Instrumentation Example
 ============================================
 
 This is an example of how to instrument OpenAI calls with zero code changes,
-using `opentelemetry-instrument`
+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
+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
 ------------