Skip to content

Update doc for OpenAI Instrumentation to support OpenAI Compatible Platforms #3279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shalevr merged 5 commits into from
Feb 26, 2025
+24 −0
Merged

Update doc for OpenAI Instrumentation to support OpenAI Compatible Platforms #3279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7b33adf
Update doc for OpenAI Instrumentation to support DeepSeek
gyliu513 Feb 20, 2025
78dc6ae
Update with Adrian's comments
gyliu513 Feb 21, 2025
91c716a
Merge branch 'main' into ds
gyliu513 Feb 21, 2025
7b95cd6
rollback the blankspace remove
gyliu513 Feb 21, 2025
d4ab4dc
Merge branch 'main' into ds
shalevr Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- `opentelemetry-instrumentation-openai-v2` Update doc for OpenAI Instrumentation to support OpenAI Compatible Platforms
([#3279](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3279))
- `opentelemetry-instrumentation-system-metrics` Add `process` metrics and deprecated `process.runtime` prefixed ones
([#3250](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3250))
- `opentelemetry-instrumentation-botocore` Add support for GenAI user events and lazy initialize tracer
Expand Down
22 changes: 22 additions & 0 deletions instrumentation-genai/opentelemetry-instrumentation-openai-v2/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,28 @@ This library allows tracing LLM requests and logging of messages made by the
`OpenAI Python API library <https://pypi.org/project/openai/>`_. It also captures
the duration of the operations and the number of tokens used as metrics.

Many LLM platforms support the OpenAI SDK. This means systems such as the following are observable with this instrumentation when accessed using it:

.. list-table:: OpenAI Compatible Platforms
:widths: 40 25
:header-rows: 1

* - Name
- gen_ai.system
* - `Azure OpenAI <https://github.com/openai/openai-python?tab=readme-ov-file#microsoft-azure-openai>`_
- ``az.ai.openai``
* - `Gemini <https://developers.googleblog.com/en/gemini-is-now-accessible-from-the-openai-library/>`_
- ``gemini``
* - `Perplexity <https://docs.perplexity.ai/api-reference/chat-completions>`_
- ``perplexity``
* - `xAI <https://x.ai/api>`_ (Compatible with Anthropic)
- ``xai``
* - `DeepSeek <https://api-docs.deepseek.com/>`_
- ``deepseek``
* - `Groq <https://console.groq.com/docs/openai>`_
- ``groq``
* - `MistralAI <https://docs.mistral.ai/api/>`_
- ``mistral_ai``

Installation
------------
Expand Down