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

* Update doc for OpenAI Instrumentation to support DeepSeek

* Update with Adrian's comments

Co-authored-by: Adrian Cole <64215+codefromthecrypt@users.noreply.github.com>

* rollback the blankspace remove

---------

Co-authored-by: Adrian Cole <64215+codefromthecrypt@users.noreply.github.com>
Co-authored-by: Shalev Roda <65566801+shalevr@users.noreply.github.com>
This commit is contained in:
Guangya Liu
2025-02-26 06:03:29 -05:00
committed by GitHub
parent b76119bb8f
commit 139f3e52d9
2 changed files with 24 additions and 0 deletions

View File

@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added ### 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 - `opentelemetry-instrumentation-system-metrics` Add `process` metrics and deprecated `process.runtime` prefixed ones
([#3250](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3250)) ([#3250](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3250))
- `opentelemetry-instrumentation-botocore` Add support for GenAI user events and lazy initialize tracer - `opentelemetry-instrumentation-botocore` Add support for GenAI user events and lazy initialize tracer

View File

@ -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 `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. 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 Installation
------------ ------------