Add OpenAI example

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

Author: codefromthecrypt

.pylintrc

@@ -7,7 +7,7 @@ extension-pkg-whitelist=cassandra
 
 # Add list of files or directories to be excluded. They should be base names, not
 # paths.
-ignore=CVS,gen,Dockerfile,docker-compose.yml,README.md,requirements.txt,docs
+ignore=CVS,gen,Dockerfile,docker-compose.yml,README.md,requirements.txt,docs,.venv
 
 # Add files or directories matching the regex patterns to be excluded. The
 # regex matches against base names, not paths.

CHANGELOG.md

@@ -13,9 +13,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add example to `opentelemetry-instrumentation-openai-v2`
+  ([#0000](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/0000))
 - `opentelemetry-instrumentation-sqlalchemy` Update unit tests to run with SQLALchemy 2
   ([#2976](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2976))
-  - Add `opentelemetry-instrumentation-openai-v2` to `opentelemetry-bootstrap`
+- Add `opentelemetry-instrumentation-openai-v2` to `opentelemetry-bootstrap`
   ([#2996](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2996))
 
 ### Fixed

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

@@ -0,0 +1,13 @@
+# 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
+
+# Set to false or remove to disable log events
+OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true
+OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true
+OTEL_LOGS_EXPORTER=otlp_proto_http

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

@@ -0,0 +1,30 @@
+OpenTelemetry OpenAI Instrumentation Example
+============================================
+
+This is an example of how to instrument OpenAI calls with zero code changes,
+using `opentelemetry-instrument`
+
+
+Installation
+------------
+
+::
+
+    python3 -m venv .venv
+    source .venv/bin/activate
+    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:
+
+::
+
+    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.

instrumentation-genai/opentelemetry-instrumentation-openai-v2/example/main.py

@@ -0,0 +1,26 @@
+import os
+
+from openai import OpenAI
+
+# TODO: remove after opentelemetry-sdk 1.28.2
+from opentelemetry import _events
+from opentelemetry.sdk._events import EventLoggerProvider
+
+_events.set_event_logger_provider(EventLoggerProvider())
+
+
+def main():
+    client = OpenAI()
+    messages = [
+        {
+            "role": "user",
+            "content": "Write a short poem on OpenTelemetry.",
+        },
+    ]
+    model = os.getenv("CHAT_MODEL", "gpt-4o-mini")
+    chat_completion = client.chat.completions.create(model=model, messages=messages)
+    print(chat_completion.choices[0].message.content)
+
+
+if __name__ == "__main__":
+    main()

instrumentation-genai/opentelemetry-instrumentation-openai-v2/example/requirements.txt

@@ -0,0 +1,6 @@
+openai~=1.54.4
+
+opentelemetry-sdk~=1.28.1
+opentelemetry-exporter-otlp-proto-http~=1.28.1
+opentelemetry-distro~=0.49b1
+opentelemetry-instrumentation-openai-v2~=2.0b0