langchainrb_datadog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abb023d18e8b8502d417d70b5cf6e004aa4d490f47bf5eb7f71af13ea6d48fc7
+  data.tar.gz: 8d8be0154c9707258f9a306834c2818a302225294001ab3155c2b9584e05ddd6
+SHA512:
+  metadata.gz: 3cb22c5a223473a51557211ebdfcfb0d41b309e39469fcd01b193e5cccb702f483d5d3a7033adbdd90c86eefa7a1b769f8550a53088783a18a471d1f0ef140c3
+  data.tar.gz: 998cbea79f0ca64a80622816e036d8ad4af6ce6abc2552491d6b9c604ff5828b052b59b2e3ee2516a281c8c513502f7cb2f2bc4c5dbbaf2034d2086538955f6c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Metrics:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/RescueModifier:
+  Enabled: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Nikolaos Anastopoulos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Langchain.rb Datadog
+
+Enables LLM observability with Datadog for Langchain.rb.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add langchainrb_datadog
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install langchainrb_datadog
+
+## Usage
+
+Its function is automatic: it hooks into Langchain.rb methods to capture LLM calls and report them to the Datadog LLM Observability API.
+
+Configure with the following environment variables or Ruby methods:
+
+- `DD_SITE` (optional, default: `datadoghq.com`)
+  ```ruby
+  Langchain::Datadog.site = 'datadoghq.com'
+  ```
+  The Datadog site to submit your LLM data.
+
+- `DD_API_KEY` (required)
+  ```ruby
+  Langchain::Datadog.api_key = '1a2b3c4d5e6f'
+  ```
+  Your Datadog API key.
+
+- `DD_LLMOBS_ENABLED` (optional, default: `1`)
+  ```ruby
+  Langchain::Datadog.enabled = true
+  ```
+  Toggle to disable submitting data to LLM Observability.
+
+- `DD_LLMOBS_ML_APP` (required)
+  ```ruby
+  Langchain::Datadog.ml_app = 'langchainrb_datadog'
+  ```
+  The name of your LLM application, service, or project, under which all traces and spans are grouped. This helps distinguish between different applications or experiments.
+  See [Application naming guidelines](https://docs.datadoghq.com/llm_observability/setup/api/#application-naming-guidelines) for allowed characters and other constraints.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GaggleAMP/langchainrb_datadog.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/langchainrb_datadog.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/langchain/datadog/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'langchainrb_datadog'
+  spec.version = Langchain::Datadog::VERSION
+  spec.authors = ['GaggleAMP', 'Nikolaos Anastopoulos']
+  spec.email = ['info@gaggleamp.com', 'ebababi@ebababi.net']
+
+  spec.summary = 'Enables LLM observability with Datadog for Langchain.rb.'
+  spec.description = 'Hooks into Langchain.rb methods to capture LLM calls and ' \
+                     'report them to the Datadog LLM Observability API.'
+  spec.homepage = 'https://github.com/GaggleAMP/langchainrb_datadog'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/GaggleAMP/langchainrb_datadog'
+  spec.metadata['github_repo'] = 'git@github.com:GaggleAMP/langchainrb_datadog.git'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'langchainrb', '~> 0.17.1'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/langchain/datadog/llm.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Langchain
+  module Datadog
+    # Implements hooks for Langchain::LLM module classes to capture LLM calls
+    # and report them to the Datadog LLM Observability API.
+    module LLM
+      include Langchain::Datadog::Tracing
+
+      def chat(params = {}, ...)
+        return super unless Datadog.enabled?
+
+        parameters = chat_parameters.to_params(params)
+
+        span(parameters) { super }
+      end
+
+      def complete(prompt:, **)
+        return super unless Datadog.enabled?
+
+        parameters = { prompt: }
+
+        span(parameters) { super }
+      end
+
+      def embed(text:, **)
+        return super unless Datadog.enabled?
+
+        parameters = { text: }
+
+        span(parameters, kind: 'embedding') { super }
+      end
+
+      def summarize(text:, **)
+        return super unless Datadog.enabled?
+
+        parameters = { text: }
+
+        span(parameters, kind: 'task') { super }
+      end
+
+      private
+
+      def span(parameters, kind: 'llm')
+        previous_parent_id = Tracing.active_parent_id
+        Tracing.start_span
+
+        start_ns = (Time.now.to_r * 1_000_000_000).to_i
+        response = yield
+        duration = (Time.now.to_r * 1_000_000_000).to_i - start_ns
+
+        trace([{
+          name: caller_locations(1, 1)[0].label,
+          span_id: Tracing.active_span_id.to_s,
+          trace_id: Tracing.active_trace_id.to_s,
+          parent_id: Tracing.active_parent_id&.to_s || 'undefined',
+          start_ns:,
+          duration:,
+          meta: {
+            kind:,
+            input: input(parameters),
+            output: output(response),
+            metadata: metadata(parameters, response)
+          }.compact,
+          metrics: metrics(response)
+        }.compact])
+
+        response
+      ensure
+        Tracing.end_span(parent_id: previous_parent_id)
+      end
+
+      def input(parameters)
+        case parameters
+        in { messages: messages } then { messages: }
+        in { prompt: value } then { value: }
+        in { text: value } then { value: }
+        else nil
+        end
+      end
+
+      def output(response)
+        completions = begin; response.completions; rescue NotImplementedError; nil; end
+        embeddings  = begin; response.embeddings; rescue NotImplementedError; nil; end
+
+        if completions
+          { messages: [completions.dig(0, 'message')&.slice('content', 'role')] }
+        elsif embeddings
+          { value: embeddings.first&.to_s }
+        end
+      end
+
+      def metadata(parameters, response)
+        temperature    = parameters[:temperature]
+        max_tokens     = parameters[:max_tokens] || parameters[:maxTokens]
+        model_name     = begin; response.model; rescue NotImplementedError; nil; end
+        model_provider = response.class.name.split('::').last.sub(/Response$/, '')
+
+        metadata = { temperature:, max_tokens:, model_name:, model_provider: }.compact
+
+        metadata.empty? ? nil : metadata
+      end
+
+      def metrics(response)
+        input_tokens  = begin; response.prompt_tokens; rescue NotImplementedError; nil; end
+        output_tokens = begin; response.completion_tokens; rescue NotImplementedError; nil; end
+        total_tokens  = begin; response.total_tokens; rescue NotImplementedError; nil; end
+
+        metrics = { input_tokens:, output_tokens:, total_tokens: }.compact
+
+        metrics.empty? ? nil : metrics
+      end
+    end
+  end
+end

data/lib/langchain/datadog/tracing.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Langchain
+  module Datadog
+    # Implements the Datadog LLM Observability API tracing.
+    module Tracing
+      # Returns the active trace ID.
+      def self.active_trace_id
+        @active_trace_id ||=
+          (::Datadog::Tracing.active_trace&.id if defined? ::Datadog) ||
+          next_id
+      end
+
+      # Returns the active span ID.
+      def self.active_span_id
+        @active_span_id ||
+          (::Datadog::Tracing.active_span&.id if defined? ::Datadog)
+      end
+
+      # Returns the active parent span ID.
+      def self.active_parent_id
+        @active_parent_id
+      end
+
+      # Starts a new span, setting the parent ID to the active span ID.
+      def self.start_span(parent_id: active_span_id)
+        @active_parent_id = parent_id
+        @active_span_id   = next_id
+      end
+
+      # Ends the active span, setting the parent ID to the given value.
+      def self.end_span(parent_id: nil)
+        @active_span_id   = active_parent_id
+        @active_parent_id = parent_id
+      end
+
+      # Starts a new workflow span.
+      def self.workflow(input = nil, name: nil, &block)
+        span(input, name:, kind: 'workflow', &block)
+      end
+
+      # Starts a new agent span.
+      def self.agent(input = nil, name: nil, &block)
+        span(input, name:, kind: 'agent', &block)
+      end
+
+      private_class_method def self.span(input = nil, name: nil, kind: 'workflow')
+        previous_parent_id = active_parent_id
+        start_span
+
+        start_ns = (Time.now.to_r * 1_000_000_000).to_i
+        output   = yield
+        duration = (Time.now.to_r * 1_000_000_000).to_i - start_ns
+
+        input_value  = { value: input } if input
+        output_value = { value: output } if output
+
+        trace([{
+          name: name || caller_locations(1, 1)[0].label.gsub(' ', '_'),
+          span_id: active_span_id.to_s,
+          trace_id: active_trace_id.to_s,
+          parent_id: active_parent_id&.to_s || 'undefined',
+          start_ns:,
+          duration:,
+          meta: {
+            kind:,
+            input: input_value,
+            output: output_value
+          }.compact
+        }.compact])
+
+        output
+      ensure
+        end_span(parent_id: previous_parent_id)
+      end
+
+      module_function
+
+      def next_id
+        return ::Datadog::Tracing::Utils.next_id if defined? ::Datadog
+
+        rand 1..((1 << 62) - 1)
+      end
+      private_class_method :next_id
+
+      def trace(spans)
+        datadog_client.post do |request|
+          request.url 'trace/spans'
+          request.body = {
+            data: {
+              type: 'span',
+              attributes: {
+                ml_app: Datadog.ml_app,
+                spans:
+              }
+            }
+          }
+        end
+      end
+      private_class_method :trace
+
+      def datadog_client
+        @datadog_client ||= Faraday.new(
+          url: "https://api.#{Datadog.site}/api/intake/llm-obs/v1/",
+          headers: { 'DD-API-KEY' => Datadog.api_key, 'Content-Type' => 'application/json' }
+        ) do |faraday|
+          faraday.request :json
+          faraday.response :json
+          faraday.response :logger, Langchain.logger, headers: true, bodies: true do |formatter|
+            formatter.filter(/(DD-API-KEY: )("\w+")/, '\1[REDACTED]')
+          end
+        end
+      end
+      private_class_method :datadog_client
+    end
+  end
+end

data/lib/langchain/datadog/vectorsearch.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Langchain
+  module Datadog
+    # Implements hooks for Langchain::Vectorsearch module classes to capture LLM
+    # calls and report them to the Datadog LLM Observability API.
+    module Vectorsearch
+      include Langchain::Datadog::Tracing
+
+      # List of various attributes that store vectors.
+      VECTOR_ATTRIBUTES = %w[embedding vector input_vector values].freeze
+
+      def add_texts(...)
+        return super unless Datadog.enabled?
+
+        span(kind: 'workflow') { super }
+      end
+
+      def update_texts(...)
+        return super unless Datadog.enabled?
+
+        span(kind: 'workflow') { super }
+      end
+
+      def similarity_search(query:, **)
+        return super unless Datadog.enabled?
+
+        parameters = { query: }
+
+        # Retrieval is not a valid root span kind, therefore when called
+        # directly it's wrapped in a workflow span.
+        if Tracing.active_parent_id == 'undefined'
+          return span(parameters, kind: 'workflow') do
+            span(parameters) { super }
+          end
+        end
+
+        span(parameters) { super }
+      end
+
+      def similarity_search_with_hyde(query:, **)
+        return super unless Datadog.enabled?
+
+        parameters = { query: }
+
+        span(parameters, kind: 'workflow') { super }
+      end
+
+      def ask(question:, **)
+        return super unless Datadog.enabled?
+
+        parameters = { question: }
+
+        span(parameters, kind: 'workflow') { super }
+      end
+
+      private
+
+      def span(parameters = {}, kind: 'retrieval')
+        previous_parent_id = Tracing.active_parent_id
+        Tracing.start_span
+
+        start_ns = (Time.now.to_r * 1_000_000_000).to_i
+        results  = yield
+        duration = (Time.now.to_r * 1_000_000_000).to_i - start_ns
+
+        trace([{
+          name: caller_locations(1, 1)[0].label.gsub(' ', '_'),
+          span_id: Tracing.active_span_id.to_s,
+          trace_id: Tracing.active_trace_id.to_s,
+          parent_id: Tracing.active_parent_id&.to_s || 'undefined',
+          start_ns:,
+          duration:,
+          meta: {
+            kind:,
+            input: input(parameters),
+            output: (output(results) if kind == 'retrieval')
+          }.compact
+        }.compact])
+
+        results
+      ensure
+        Tracing.end_span(parent_id: previous_parent_id)
+      end
+
+      def input(parameters)
+        case parameters
+        in { query: value } then { value: }
+        in { question: value } then { value: }
+        else nil
+        end
+      end
+
+      def output(results)
+        documents = results.map do |result|
+          next { text: result.to_s } unless result.is_a? Hash
+
+          id    = result['id']
+          score = result['score']
+
+          name =
+            result['name'] ||
+            result.dig('metadata', 'name') ||
+            result.dig('metadata', 'title') ||
+            result.dig('metadata', 'filename') ||
+            result.dig('metadata', 'url') ||
+            result.dig('metadata', 'id')
+
+          text =
+            result['content'] ||
+            result['document'] ||
+            result['input'] ||
+            result['payload'] ||
+            result.dig('data', 'content') ||
+            result.dig('metadata', 'content') ||
+            result.except(*VECTOR_ATTRIBUTES, 'name', 'score', 'id').to_json
+
+          { text: text&.to_s, name:, score:, id: }.compact
+        end
+
+        { documents: }
+      end
+    end
+  end
+end

data/lib/langchain/datadog/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Langchain
+  module Datadog
+    VERSION = '0.1.0'
+  end
+end

data/lib/langchain/datadog.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'langchainrb'
+require 'faraday'
+
+require_relative 'datadog/version'
+require_relative 'datadog/tracing'
+require_relative 'datadog/llm'
+require_relative 'datadog/vectorsearch'
+
+module Langchain
+  # Datadog LLM Observability integration with Langchain.rb.
+  module Datadog
+    extend self # rubocop:disable Style/ModuleFunction
+
+    # Values that are considered false when parsing environment variables..
+    FALSE_VALUES = [false, 0, '0', 'f', 'F', 'false', 'FALSE', 'off', 'OFF'].freeze
+
+    # @!attribute [rw] enabled
+    #   @return [Boolean] whether to submit data to LLM Observability
+    #
+    # @!attribute [rw] site
+    #   @return [String] the Datadog site to submit the LLM data.
+    #
+    # @!attribute [rw] api_key
+    #   @return [String] the Datadog API key
+    #
+    # @!attribute [rw] ml_app
+    #   @return [String] the name of the LLM application
+    attr_writer :enabled, :site, :api_key, :ml_app
+
+    def enabled
+      return @enabled unless @enabled.nil?
+
+      @enabled = !FALSE_VALUES.include?(ENV.fetch('DD_LLMOBS_ENABLED', '1'))
+    end
+
+    def enabled? = !!enabled
+
+    def site
+      @site ||= if defined? ::Datadog
+                  ::Datadog.configuration.site
+                else
+                  ENV.fetch('DD_SITE', 'datadoghq.com')
+                end
+    end
+
+    def api_key
+      @api_key ||= if defined? ::Datadog
+                     ::Datadog.configuration.api_key
+                   else
+                     ENV.fetch('DD_API_KEY')
+                   end
+    end
+
+    def ml_app
+      @ml_app ||= ENV['DD_LLMOBS_ML_APP'] || \
+                  if defined? ::Datadog
+                    ::Datadog.configuration.service
+                  else
+                    ENV.fetch('DD_LLMOBS_ML_APP')
+                  end
+    end
+  end
+end
+
+# Eager load all Langchain::LLM classes to ensure that the Datadog::LLM
+# module is prepended to all of them.
+Zeitwerk::Loader.eager_load_namespace(Langchain::LLM) rescue Zeitwerk::NameError ? nil : raise \
+  if defined?(Zeitwerk)
+
+# Find all classes inheriting from Langchain::LLM::Base and prepend the
+# Datadog::LLM module to capture LLM calls and report them to the Datadog
+# LLM Observability API.
+Langchain::LLM::Base.subclasses.each do |klass|
+  klass.prepend Langchain::Datadog::LLM
+end
+
+# Eager load all Langchain::Vectorsearch classes to ensure that the
+# Datadog::Vectorsearch module is prepended to all of them.
+Zeitwerk::Loader.eager_load_namespace(Langchain::Vectorsearch) rescue Zeitwerk::NameError ? nil : raise \
+  if defined?(Zeitwerk)
+
+# Find all classes inheriting from Langchain::Vectorsearch::Base and prepend the
+# Datadog::Vectorsearch module to capture LLM calls and report them to the
+# Datadog LLM Observability API.
+Langchain::Vectorsearch::Base.subclasses.each do |klass|
+  klass.prepend Langchain::Datadog::Vectorsearch
+end

data/lib/langchainrb_datadog.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'langchain/datadog'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: langchainrb_datadog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GaggleAMP
+- Nikolaos Anastopoulos
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: langchainrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: Hooks into Langchain.rb methods to capture LLM calls and report them
+  to the Datadog LLM Observability API.
+email:
+- info@gaggleamp.com
+- ebababi@ebababi.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- langchainrb_datadog.gemspec
+- lib/langchain/datadog.rb
+- lib/langchain/datadog/llm.rb
+- lib/langchain/datadog/tracing.rb
+- lib/langchain/datadog/vectorsearch.rb
+- lib/langchain/datadog/version.rb
+- lib/langchainrb_datadog.rb
+homepage: https://github.com/GaggleAMP/langchainrb_datadog
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/GaggleAMP/langchainrb_datadog
+  source_code_uri: https://github.com/GaggleAMP/langchainrb_datadog
+  github_repo: git@github.com:GaggleAMP/langchainrb_datadog.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Enables LLM observability with Datadog for Langchain.rb.
+test_files: []