opentelemetry-instrumentation-openai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd2d758e59ae65650bb0f728a5aeb528b490c0c578fdd38fd5f682d2ce10f85b
+  data.tar.gz: b25990affc49f8f35b5b684d786c3ddf14d5d019c0ed4145e76069983bab02a8
+SHA512:
+  metadata.gz: 7a7c1a0d9c85da6c4d3ce71b1b31fdf2db4cefef1fb03174f79a73001b524116e42771e5a0529e7482d3b02ae431f16ffdff3fc9ca922cb775e535c6e28ef2d4
+  data.tar.gz: 626a32d4ce28d579ed45502e4d7d785b69115484eee8445c8bb964c831d8162a2f25f6323fecd0f412927f31d9cc5938c71a942326e2b03eb98bac1a5d65c8ea

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenTelemetry OpenAI Instrumentation
+--markup=markdown
+--main=README.md
+./lib/opentelemetry/instrumentation/**/*.rb
+./lib/opentelemetry/instrumentation.rb
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Release History: opentelemetry-instrumentation-openai
+
+## v0.1.0 / 2026-10-06
+
+- ADDED: Add instrumentation for openai gem (#1797)
+- ADDED: Update OpenAI instrumentation for logs and CI (#2552)
+- ADDED: Add meter and logger alongside tracer (#2586)
+- ADDED: Emit log records through the instrumentation-base logger (#2613)

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright The OpenTelemetry Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,98 @@
+# OpenTelemetry OpenAI Instrumentation
+
+The OpenAI instrumentation is a community-maintained instrumentation for the [OpenAI][openai-home] gem.
+
+Attributes and events follow the [OpenTelemetry Semantic Conventions for Generative AI][semconv-genai], pinned to core semantic conventions version `1.44.0`.
+
+## How do I get started?
+
+Install the gem using:
+
+```console
+gem install opentelemetry-instrumentation-openai
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-openai` in your `Gemfile`.
+
+## Usage
+
+To use the instrumentation, call `use` with the name of the instrumentation:
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::OpenAI'
+end
+```
+
+Alternatively, you can also call `use_all` to install all the available instrumentation.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use_all
+end
+```
+
+## Configuration options
+
+The instrumentation accepts the following configuration options:
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `:capture_content` | `false` | Captures the content of prompts and responses (chat messages, inputs, prompts, and tool call arguments) as structured `gen_ai` log records emitted through the OpenTelemetry Logs API. Disabled by default to avoid recording potentially sensitive data. This option is overridden at install time by the `OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT` environment variable. |
+| `:allowed_operations` | `["chat", "completions", "embeddings"]` | The list of OpenAI operations to instrument. Only requests whose resolved operation name is included here produce spans; all other operations pass through untouched. |
+
+Options are passed to `use` in the SDK configuration:
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::OpenAI', {
+    capture_content: true,
+    allowed_operations: %w[chat completions embeddings]
+  }
+end
+```
+
+Content capture can also be enabled without changing code by setting the
+environment variable:
+
+```console
+export OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=true
+```
+
+## Emitting log events
+
+[GenAI semantic conventions define events to emit with instrumentation][genai-semconv-events]. Events are emitted using the Logs signal. Without a Logs SDK, log records go to a no-op logger. To export them, add the Logs SDK to your Gemfile:
+
+```ruby
+gem 'opentelemetry-logs-sdk'
+```
+
+## Examples
+
+See [example/trace_demonstration.rb][example-github] for a runnable example that instruments chat completion, streaming, and embeddings requests and prints spans and log records to the console. Set the `OPENAI_API_KEY` environment variable before running it.
+
+```sh
+OPENAI_API_KEY=<openai_api_key> ruby trace_demonstration.rb
+```
+
+## How can I get involved?
+
+The `opentelemetry-instrumentation-openai` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
+
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+
+## License
+
+The `opentelemetry-instrumentation-openai` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
+
+[openai-home]: https://github.com/openai/openai-ruby
+[bundler-home]: https://bundler.io
+[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
+[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
+[community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
+[semconv-genai]: https://github.com/open-telemetry/semantic-conventions-genai
+[example-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/openai/example/trace_demonstration.rb
+[genai-semconv-events]: https://github.com/open-telemetry/semantic-conventions-genai/blob/main/docs/gen-ai/gen-ai-events.md

data/lib/opentelemetry/instrumentation/openai/instrumentation.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module OpenAI
+      # The Instrumentation class contains logic to detect and install the openai instrumentation
+      class Instrumentation < OpenTelemetry::Instrumentation::Base
+        MINIMUM_VERSION = Gem::Version.new('0.35.2')
+        ALLOWED_OPERATIONS = %w[chat completions embeddings].freeze
+
+        install do |_config|
+          require_dependencies
+          determine_the_content_mode
+          patch_client
+        end
+
+        present do
+          defined?(::OpenAI)
+        end
+
+        compatible do
+          gem_version >= MINIMUM_VERSION
+        end
+
+        # Captures the content of prompts and responses (e.g. chat messages, inputs,
+        # prompts, and tool call arguments) as structured `gen_ai` log records.
+        # Disabled by default to avoid recording potentially sensitive data. When
+        # enabled, message content is emitted through the OpenTelemetry Logs API
+        # via the configured logger provider.
+        #
+        # This option is overridden at install time by the
+        # `OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT` environment variable
+        # (see #determine_the_content_mode).
+        option :capture_content, default: false, validate: :boolean
+
+        # The list of OpenAI operations to instrument. Only requests whose resolved
+        # operation name is included here produce spans; all other operations pass
+        # through untouched. Defaults to ALLOWED_OPERATIONS (chat, completions,
+        # embeddings), the operations currently implemented and tested.
+        option :allowed_operations, default: ALLOWED_OPERATIONS, validate: :array
+
+        private
+
+        def gem_version
+          ::OpenAI::VERSION
+        end
+
+        def determine_the_content_mode
+          env_value = ENV['OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT'].to_s
+          config[:capture_content] = env_value.downcase == 'true' unless env_value.empty?
+        end
+
+        def require_dependencies
+          require_relative 'patches/client'
+        end
+
+        def patch_client
+          ::OpenAI::Client.prepend(Patches::Client)
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/openai/patches/client.rb

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative 'operation_name'
+require_relative 'stream_wrapper'
+require_relative 'utils'
+
+module OpenTelemetry
+  module Instrumentation
+    module OpenAI
+      module Patches
+        # OpenAIClient Patch
+        # rubocop:disable-next Metrics/ModuleLength
+        module Client
+          include OperationName
+          include Utils
+
+          # Intercepts outgoing OpenAI requests to create and manage OpenTelemetry spans.
+          def request(req)
+            operation_name = determine_operation_name(req)
+
+            # Only instrument implemented/tested OpenAI operations
+            return super unless config[:allowed_operations].include? operation_name
+
+            model      = get_property_value(req[:body], 'model')
+            span_name  = model.to_s.empty? ? operation_name : "#{operation_name} #{model}"
+            attributes = extract_request_attributes(req, operation_name, model)
+
+            # For streaming, start span manually so it stays open during iteration
+            # Stream mode return OpenAI::Internal::Stream[OpenAI::Models::Chat::ChatCompletionChunk]
+            if req[:stream]
+              span = tracer.start_span(span_name, attributes: attributes, kind: :client)
+              log_request_content(span, req)
+
+              start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+              begin
+                response = super
+              rescue StandardError => e
+                handle_span_exception(span, e)
+                raise
+              end
+              return StreamWrapper.new(response, span, config[:capture_content], start_time)
+            end
+
+            # Non-streaming path
+            tracer.in_span(
+              span_name,
+              attributes: attributes,
+              kind: :client
+            ) do |span|
+              # Log request details if content capture is enabled and
+              log_request_content(span, req)
+
+              response = super
+              handle_response(span, response, req)
+
+              response
+            rescue StandardError => e
+              handle_span_exception(span, e)
+              raise
+            end
+          end
+
+          private
+
+          def tracer
+            OpenAI::Instrumentation.instance.tracer
+          end
+
+          def config
+            OpenAI::Instrumentation.instance.config
+          end
+
+          # Extract comprehensive request attributes following semantic conventions
+          def extract_request_attributes(req, operation_name, model)
+            uri = begin
+              URI.parse(req[:url])
+            rescue StandardError
+              nil
+            end
+
+            request_attributes = {
+              'gen_ai.operation.name' => operation_name,
+              'gen_ai.provider.name' => 'openai',
+              'gen_ai.request.model' => model,
+              'server.address' => uri&.host || 'api.openai.com',
+              'server.port' => uri&.port || 443,
+              'gen_ai.output.type' => get_output_type(operation_name),
+              'gen_ai.request.stream' => req[:stream] ? true : nil,
+              'openai.api.type' => get_api_type(operation_name)
+            }.compact
+
+            # Extract attributes from request body based on operation name
+            merge_body_attributes!(request_attributes, req[:body], operation_name)
+
+            request_attributes
+          end
+
+          # Since only chat and embedding is allowed, so we will only expect 'text' as output
+          def get_output_type(operation_name)
+            case operation_name
+            when 'chat'
+              'text'
+            when 'images.generate', 'images.edit', 'images.variation'
+              'image'
+            when 'audio.transcription', 'audio.translation', 'audio.speech'
+              'speech'
+            else
+              'json'
+            end
+          end
+
+          # Maps the operation name to the underlying OpenAI API family
+          def get_api_type(operation_name)
+            case operation_name
+            when 'chat', 'completions'
+              'chat_completions'
+            when 'responses', 'responses.input_tokens'
+              'responses'
+            end
+          end
+
+          # Merge body attributes based on operation type
+          def merge_body_attributes!(attributes, body, operation_name)
+            return unless body.is_a?(Hash)
+
+            case operation_name
+            when 'chat', 'completions'
+              merge_chat_attributes!(attributes, body)
+            when 'embeddings'
+              merge_embeddings_attributes!(attributes, body)
+            end
+          end
+
+          # Merge chat/completion specific attributes
+          def merge_chat_attributes!(attributes, body)
+            n_count = body[:n]
+            stop_sequences = if body[:stop].is_a?(Array)
+                               body[:stop]
+                             else
+                               (body[:stop] ? [body[:stop]] : nil)
+                             end
+            service_tier = body[:service_tier]&.to_s
+
+            chat_attributes = {
+              'gen_ai.request.temperature' => body[:temperature],
+              'gen_ai.request.max_tokens' => body[:max_tokens] || body[:max_completion_tokens],
+              'gen_ai.request.top_p' => body[:top_p],
+              'gen_ai.request.frequency_penalty' => body[:frequency_penalty],
+              'gen_ai.request.presence_penalty' => body[:presence_penalty],
+              'gen_ai.request.seed' => body[:seed],
+              'gen_ai.request.stop_sequences' => stop_sequences,
+              'gen_ai.request.choice.count' => n_count && n_count != 1 ? n_count : nil,
+              'gen_ai.request.reasoning.level' => body[:reasoning_effort]&.to_s,
+              'openai.request.service_tier' => service_tier && service_tier != 'auto' ? service_tier : nil
+            }.compact
+
+            attributes.merge!(chat_attributes)
+          end
+
+          # Merge embeddings specific attributes
+          def merge_embeddings_attributes!(attributes, body)
+            encoding_formats = body[:encoding_format] ? [body[:encoding_format].to_s] : nil
+
+            embeddings_attributes = {
+              'gen_ai.request.encoding_formats' => encoding_formats
+            }.compact
+
+            attributes.merge!(embeddings_attributes)
+          end
+
+          # Create event with request content if enabled
+          def log_request_content(span, req)
+            return unless config[:capture_content]
+
+            body = req[:body]
+            return unless body.is_a?(Hash)
+
+            return unless body[:messages].is_a?(Array)
+
+            body[:messages].each do |message|
+              event = message_to_log_event(message, capture_content: true)
+              log_structured_event(event)
+            end
+          end
+
+          # Handle different response types and extract telemetry data
+          def handle_response(span, result, req)
+            return unless span.recording?
+
+            # Set basic response attributes (only for non-streaming responses with these methods)
+            response_attributes = {
+              'gen_ai.response.model' => result.respond_to?(:model) ? result.model : nil,
+              'gen_ai.response.id' => result.respond_to?(:id) ? result.id : nil,
+              'openai.response.service_tier' => result.respond_to?(:service_tier) ? result.service_tier&.to_s : nil,
+              'openai.response.system_fingerprint' => result.respond_to?(:system_fingerprint) ? result.system_fingerprint : nil
+            }.compact
+            span.add_attributes(response_attributes)
+
+            # Handle usage/token information
+            set_usage_attributes(span, result.usage) if result.respond_to?(:usage) && result.usage
+
+            # Handle different completion responses
+            if result.respond_to?(:choices) && result.choices&.any?
+              handle_chat_completion_response(span, result)
+            elsif result.respond_to?(:data) && result.data&.any?
+              handle_embeddings_response(span, result) if result.data.first.respond_to?(:embedding)
+            end
+          end
+
+          # Handle chat completion response
+          def handle_chat_completion_response(span, result)
+            finish_reasons = result.choices.map { |x| x.finish_reason.to_s }
+            span.set_attribute('gen_ai.response.finish_reasons', finish_reasons) if finish_reasons.any?
+
+            return unless config[:capture_content]
+
+            result.choices.each do |choice|
+              event = choice_to_log_event(choice, capture_content: true)
+              log_structured_event(event)
+            end
+          end
+
+          # Handle embeddings response
+          def handle_embeddings_response(span, result)
+            embedding_dimensions = result.data.first.respond_to?(:embedding) ? result.data.first.embedding&.size : nil
+
+            attributes = {
+              'gen_ai.embeddings.dimension.count' => embedding_dimensions
+            }.compact
+
+            span.add_attributes(attributes)
+          end
+
+          # Set token usage attributes
+          def set_usage_attributes(span, usage)
+            prompt_tokens_details = usage.respond_to?(:prompt_tokens_details) ? usage.prompt_tokens_details : nil
+            completion_tokens_details = usage.respond_to?(:completion_tokens_details) ? usage.completion_tokens_details : nil
+
+            usage_attributes = {
+              'gen_ai.usage.input_tokens' => usage.respond_to?(:prompt_tokens) ? usage.prompt_tokens : nil,
+              'gen_ai.usage.output_tokens' => usage.respond_to?(:completion_tokens) ? usage.completion_tokens : nil,
+              'gen_ai.usage.cache_read.input_tokens' => prompt_tokens_details.respond_to?(:cached_tokens) ? prompt_tokens_details.cached_tokens : nil,
+              'gen_ai.usage.reasoning.output_tokens' => completion_tokens_details.respond_to?(:reasoning_tokens) ? completion_tokens_details.reasoning_tokens : nil
+            }.compact
+
+            span.add_attributes(usage_attributes)
+          end
+
+          # Handle span exception
+          def handle_span_exception(span, error)
+            span.set_attribute('error.type', error.class.name)
+            span.record_exception(error)
+            span.status = OpenTelemetry::Trace::Status.error(error.message)
+            span.finish
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/openai/patches/operation_name.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module OpenAI
+      module Patches
+        # Determine the operation name from the request path
+        module OperationName
+          # Maps the request path to a canonical OpenAI operation name.
+          def determine_operation_name(req)
+            path = req[:path].to_s
+
+            case path
+            when %r{^chat/completions}
+              'chat'
+            when /^embeddings/
+              'embeddings'
+            when /^completions/
+              'completions'
+            when %r{^images/generations}
+              'images.generate'
+            when %r{^images/edits}
+              'images.edit'
+            when %r{^images/variations}
+              'images.variation'
+            when %r{^audio/transcriptions}
+              'audio.transcription'
+            when %r{^audio/translations}
+              'audio.translation'
+            when %r{^audio/speech}
+              'audio.speech'
+            when /^models/
+              'models'
+            when /^files/
+              'files'
+            when %r{^fine_tuning/jobs}
+              'fine_tuning.jobs'
+            when %r{^fine_tuning/alpha/graders/run}
+              'fine_tuning.graders.run'
+            when %r{^fine_tuning/alpha/graders/validate}
+              'fine_tuning.graders.validate'
+            when /^fine_tuning/
+              'fine_tuning'
+            when /^moderations/
+              'moderations'
+            when /^batches/
+              'batches'
+            when /^uploads/
+              'uploads'
+            when /^vector_stores/
+              'vector_stores'
+            when /^assistants/
+              'assistants'
+            when %r{^threads/runs}
+              'threads.runs'
+            when /^threads/
+              'threads'
+            when /^conversations/
+              'conversations'
+            when %r{^responses/input_tokens}
+              'responses.input_tokens'
+            when /^responses/
+              'responses'
+            when /^containers/
+              'containers'
+            when /^evals/
+              'evals'
+            when /^videos/
+              'videos'
+            when %r{^chatkit/sessions}
+              'chatkit.sessions'
+            when %r{^chatkit/threads}
+              'chatkit.threads'
+            when %r{^realtime/client_secrets}
+              'realtime.client_secrets'
+            else
+              'openai.request'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/openai/patches/stream_wrapper.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative 'utils'
+
+module OpenTelemetry
+  module Instrumentation
+    module OpenAI
+      module Patches
+        # Stream wrapper for chat completion streaming
+        class StreamWrapper
+          include Enumerable
+          include Utils
+
+          attr_reader :stream, :span, :capture_content
+
+          def initialize(stream, span, capture_content, start_time = nil)
+            @stream = stream
+            @span = span
+            @capture_content = capture_content
+            @start_time = start_time
+            @time_to_first_chunk = nil
+            @response_id = nil
+            @response_model = nil
+            @service_tier = nil
+            @finish_reasons = []
+            @prompt_tokens = 0
+            @completion_tokens = 0
+            @cached_tokens = nil
+            @reasoning_tokens = nil
+            @choice_buffers = []
+            @span_started = true
+          end
+
+          # Iterates over streaming events, processing each chunk and yielding it to the caller.
+          def each(&)
+            @stream.each do |event|
+              process_event(event)
+              yield(event) if block_given?
+            end
+          rescue StandardError => e
+            handle_error(e)
+            raise
+          ensure
+            cleanup
+          end
+
+          private
+
+          # @param chunk [OpenAI::Models::Chat::ChatCompletionChunk]
+          def process_event(chunk)
+            record_time_to_first_chunk
+            response_metadata(chunk)
+            build_streaming_response(chunk)
+            usage(chunk)
+          end
+
+          def record_time_to_first_chunk
+            return unless @start_time
+            return if @time_to_first_chunk
+
+            @time_to_first_chunk = Process.clock_gettime(Process::CLOCK_MONOTONIC) - @start_time
+          end
+
+          def response_metadata(chunk)
+            @response_model ||= chunk.model if chunk.respond_to?(:model)
+            @response_id ||= chunk.id if chunk.respond_to?(:id)
+            @service_tier ||= chunk.service_tier if chunk.respond_to?(:service_tier)
+          end
+
+          def build_streaming_response(chunk)
+            return unless chunk.respond_to?(:choices) && chunk.choices
+
+            chunk.choices.each do |choice|
+              next unless choice.respond_to?(:delta) && choice.delta
+
+              # Ensure we have enough choice buffers
+              index = choice.respond_to?(:index) ? choice.index : 0
+              @choice_buffers << ChoiceBuffer.new(@choice_buffers.size) while @choice_buffers.size <= index
+
+              buffer = @choice_buffers[index]
+              buffer.finish_reason = choice.finish_reason if choice.respond_to?(:finish_reason) && choice.finish_reason
+
+              delta = choice.delta
+              buffer.append_content(delta.content) if delta.respond_to?(:content) && delta.content
+              buffer.append_tool_calls(delta.tool_calls) if delta.respond_to?(:tool_calls) && delta.tool_calls
+            end
+          end
+
+          def usage(chunk)
+            return unless chunk.respond_to?(:usage) && chunk.usage
+
+            usage = chunk.usage
+            @completion_tokens = usage.completion_tokens if usage.respond_to?(:completion_tokens)
+            @prompt_tokens = usage.prompt_tokens if usage.respond_to?(:prompt_tokens)
+
+            @cached_tokens = usage.prompt_tokens_details.cached_tokens if usage.respond_to?(:prompt_tokens_details) && usage.prompt_tokens_details.respond_to?(:cached_tokens)
+
+            return unless usage.respond_to?(:completion_tokens_details) && usage.completion_tokens_details.respond_to?(:reasoning_tokens)
+
+            @reasoning_tokens = usage.completion_tokens_details.reasoning_tokens
+          end
+
+          def cleanup
+            return unless @span_started
+
+            # Set final attributes only if span is still recording
+            if @span.recording?
+              finish_reasons = @choice_buffers.map { |x| x.finish_reason.to_s }
+              attributes = {
+                'gen_ai.response.model' => @response_model,
+                'gen_ai.response.id' => @response_id,
+                'gen_ai.usage.input_tokens' => @prompt_tokens.positive? ? @prompt_tokens : nil,
+                'gen_ai.usage.output_tokens' => @completion_tokens.positive? ? @completion_tokens : nil,
+                'gen_ai.usage.cache_read.input_tokens' => @cached_tokens,
+                'gen_ai.usage.reasoning.output_tokens' => @reasoning_tokens,
+                'gen_ai.response.finish_reasons' => finish_reasons.any? ? finish_reasons : nil,
+                'gen_ai.response.time_to_first_chunk' => @time_to_first_chunk,
+                'openai.response.service_tier' => @service_tier.to_s
+              }.compact
+              @span.add_attributes(attributes)
+            end
+
+            # Emit structured log events for each choice (not span events)
+            if @capture_content
+              @choice_buffers.each do |buffer|
+                event = buffer.to_log_event
+                log_structured_event(event)
+              end
+            end
+          ensure
+            @span.finish
+            @span_started = false
+          end
+
+          def handle_error(error)
+            @span.set_attribute('error.type', error.class.name)
+            @span.record_exception(error)
+            @span.status = OpenTelemetry::Trace::Status.error(error.message)
+          end
+
+          # Buffer for accumulating streaming choice data
+          class ChoiceBuffer
+            attr_accessor :finish_reason
+            attr_reader :index, :text_content, :tool_call_buffers
+
+            def initialize(index)
+              @index = index
+              @text_content = []
+              @tool_call_buffers = []
+              @finish_reason = nil
+            end
+
+            # Appends a content chunk to the text buffer.
+            def append_content(content)
+              @text_content << content if content
+            end
+
+            # Appends streaming tool call deltas to their respective buffers.
+            def append_tool_calls(tool_calls)
+              tool_calls.each do |tool_call|
+                # Find or create tool call buffer
+                buffer = @tool_call_buffers.find { |b| b.index == tool_call.index } if tool_call.respond_to?(:index)
+
+                if buffer.nil?
+                  tc_index = tool_call.respond_to?(:index) ? tool_call.index : @tool_call_buffers.size
+                  buffer = ToolCallBuffer.new(tc_index)
+                  @tool_call_buffers << buffer
+                end
+
+                buffer.append(tool_call)
+              end
+            end
+
+            # Converts the accumulated choice buffer into a structured log event hash.
+            def to_log_event
+              body = {
+                index: @index,
+                finish_reason: @finish_reason&.to_s || 'error',
+                message: {
+                  role: 'assistant'
+                }
+              }
+
+              body[:message][:content] = @text_content.join if @text_content.any?
+
+              if @tool_call_buffers.any?
+                tool_calls = @tool_call_buffers.map(&:to_hash)
+                body[:message][:tool_calls] = tool_calls
+              end
+
+              {
+                event_name: 'gen_ai.choice',
+                attributes: {
+                  'gen_ai.provider.name' => 'openai'
+                },
+                body: body
+              }
+            end
+          end
+
+          # Buffer for accumulating tool call data
+          class ToolCallBuffer
+            attr_reader :index
+
+            def initialize(index)
+              @index = index
+              @tool_call_id = nil
+              @function_name = nil
+              @arguments = []
+            end
+
+            # Accumulates tool call delta data into the buffer.
+            def append(tool_call)
+              @tool_call_id ||= tool_call.id if tool_call.respond_to?(:id)
+
+              return unless tool_call.respond_to?(:function) && tool_call.function
+
+              function = tool_call.function
+              @function_name ||= function.name if function.respond_to?(:name)
+              @arguments << function.arguments if function.respond_to?(:arguments) && function.arguments
+            end
+
+            # Serializes the accumulated tool call buffer to a hash.
+            def to_hash
+              {
+                id: @tool_call_id,
+                type: 'function',
+                function: {
+                  name: @function_name,
+                  arguments: @arguments.join
+                }
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/openai/patches/utils.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module OpenAI
+      module Patches
+        # Utils
+        module Utils
+          # Retrieves a property value from a Hash or object by name.
+          def get_property_value(obj, property_name)
+            if obj.is_a?(Hash)
+              obj[property_name] || obj[property_name.to_sym]
+            else
+              obj.respond_to?(property_name) ? obj.public_send(property_name) : nil
+            end
+          end
+
+          # Extracts and normalizes tool call data from a message or choice object.
+          def extract_tool_calls(item, capture_content)
+            tool_calls = get_property_value(item, :tool_calls)
+            return nil unless tool_calls
+
+            calls = []
+            tool_calls.each do |tool_call|
+              tool_call_dict = {}
+
+              call_id = get_property_value(tool_call, :id)
+              tool_call_dict[:id] = call_id if call_id
+
+              tool_type = get_property_value(tool_call, :type)
+              tool_call_dict[:type] = tool_type.to_s if tool_type
+
+              func = get_property_value(tool_call, :function)
+              if func
+                tool_call_dict[:function] = {}
+
+                name = get_property_value(func, :name)
+                tool_call_dict[:function][:name] = name if name
+
+                arguments = get_property_value(func, :arguments)
+                if capture_content && arguments
+                  arguments = arguments.to_s.delete("\n") if arguments.is_a?(String)
+                  tool_call_dict[:function][:arguments] = arguments
+                end
+              end
+
+              calls << tool_call_dict
+            end
+            calls
+          end
+
+          # Converts a request message into a structured gen_ai log event hash.
+          def message_to_log_event(message, capture_content: true)
+            role = get_property_value(message, :role)&.to_s
+            content = get_property_value(message, :content)
+
+            body = {}
+            body[:content] = content.to_s if capture_content && content
+
+            if role == 'assistant'
+              tool_calls = extract_tool_calls(message, capture_content)
+              body = { tool_calls: tool_calls } if tool_calls
+            elsif role == 'tool'
+              tool_call_id = get_property_value(message, :tool_call_id)
+              body[:id] = tool_call_id if tool_call_id
+            end
+
+            {
+              event_name: "gen_ai.#{role}.message",
+              attributes: {
+                'gen_ai.provider.name' => 'openai'
+              },
+              body: body.empty? ? nil : body
+            }
+          end
+
+          # Converts a response choice into a structured gen_ai log event hash.
+          def choice_to_log_event(choice, capture_content: true)
+            index = get_property_value(choice, :index) || 0
+            finish_reason = get_property_value(choice, :finish_reason)&.to_s || 'error'
+
+            body = {
+              index: index,
+              finish_reason: finish_reason
+            }
+
+            message_obj = get_property_value(choice, :message)
+            if message_obj
+              message = {}
+              role = get_property_value(message_obj, :role)
+              message[:role] = role.to_s if role
+
+              tool_calls = extract_tool_calls(message_obj, capture_content)
+              message[:tool_calls] = tool_calls if tool_calls
+
+              content = get_property_value(message_obj, :content)
+              message[:content] = content.to_s if capture_content && content
+
+              body[:message] = message
+            end
+
+            {
+              event_name: 'gen_ai.choice',
+              attributes: {
+                'gen_ai.provider.name' => 'openai'
+              },
+              body: body
+            }
+          end
+
+          # Emits a structured log record through the OpenTelemetry Logs API.
+          def log_structured_event(event)
+            Instrumentation.instance.logger.on_emit(
+              timestamp: Time.now,
+              severity_text: 'INFO',
+              severity_number: OpenTelemetry::Logs::SeverityNumber::SEVERITY_NUMBER_INFO,
+              event_name: event[:event_name],
+              body: event[:body],
+              attributes: event[:attributes],
+              context: OpenTelemetry::Context.current
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/openai/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module OpenAI
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/openai.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry'
+require 'opentelemetry-instrumentation-base'
+
+module OpenTelemetry
+  module Instrumentation
+    # Contains the OpenTelemetry instrumentation for the openai gem
+    module OpenAI
+    end
+  end
+end
+
+require_relative 'openai/instrumentation'
+require_relative 'openai/version'

data/lib/opentelemetry/instrumentation.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+# See the documentation for the `opentelemetry-api` gem for details.
+module OpenTelemetry
+  # Instrumentation should be able to handle the case when the library is not installed on a user's system.
+  module Instrumentation
+  end
+end
+
+require_relative 'instrumentation/openai'

data/lib/opentelemetry-instrumentation-openai.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative 'opentelemetry/instrumentation'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: opentelemetry-instrumentation-openai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OpenTelemetry Authors
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+description: OpenAI instrumentation for the OpenTelemetry framework
+email:
+- cncf-opentelemetry-contributors@lists.cncf.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/opentelemetry-instrumentation-openai.rb
+- lib/opentelemetry/instrumentation.rb
+- lib/opentelemetry/instrumentation/openai.rb
+- lib/opentelemetry/instrumentation/openai/instrumentation.rb
+- lib/opentelemetry/instrumentation/openai/patches/client.rb
+- lib/opentelemetry/instrumentation/openai/patches/operation_name.rb
+- lib/opentelemetry/instrumentation/openai/patches/stream_wrapper.rb
+- lib/opentelemetry/instrumentation/openai/patches/utils.rb
+- lib/opentelemetry/instrumentation/openai/version.rb
+homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
+licenses:
+- Apache-2.0
+metadata:
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-openai/0.1.0/file/CHANGELOG.md
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/openai
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-openai/0.1.0
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: OpenAI instrumentation for the OpenTelemetry framework
+test_files: []