rubyllm-observ 0.6.4 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a648839b815f45ded484d1b4e97c83a583fff99b3922d4920694c30500e566d4
-  data.tar.gz: 6bda76d81a50e4171fbc400c4195e76a6db1c270fe57aab6d2d9182e872f5613
+  metadata.gz: 9515276911fc3bbb7170e6a9e5f67e58ae7e4285a5c929ebdd469b13d334fa3c
+  data.tar.gz: 5efd608bda38651dc6e606f9216fd423f0f69b655f7264fe7af51a337e37f9d6
 SHA512:
-  metadata.gz: 8adeb19ae2ea22fc7aef0190b89d87ca60921a34ef21ab7dc385c8882a0590316a2cc29f1d5cefeb7ab0c5cf27cfa766766a1507f4496aef2c14196e967b57e5
-  data.tar.gz: ed4287385ce15431b945d223300213d26a678290fb48a156108a968a76e52476a22dcac1777fbe287842e6fb855bd5c6563de946d0d98e0b2f0eaac410aa66cb
+  metadata.gz: 39e136a3e9ddb512b5231fbd25b7d588550f8476101ac7c9e8f3e278fbe68f0692836bd15f0f45aebcfe82be5d4d74de0195249cd9a1be099088c69ee1c5926c
+  data.tar.gz: 369289406fc87cfc150b86c7d32bdaafdb52fc5a42836068bd21b16745141d0baaa4313ea98fd0630d33ecfe486b460c39a7f42d1b85a4b6416fb79c2069b99d

data/README.md

@@ -196,7 +196,6 @@ Observ.configure do |config|
   
   # UI configuration
   config.back_to_app_path = -> { Rails.application.routes.url_helpers.root_path }
-  config.back_to_app_label = "← Back to App"
   
   # Chat UI (auto-detects if Chat model exists with acts_as_chat)
   # Manually override if needed:

data/app/services/observ/concerns/observable_service.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Observ
+  module Concerns
+    # Concern for adding observability to service objects
+    #
+    # This module provides automatic observability session management for services
+    # that perform LLM operations. It handles session creation, lifecycle management,
+    # and chat instrumentation.
+    #
+    # Usage:
+    #   class MyService
+    #     include Observ::Concerns::ObservableService
+    #
+    #     def initialize(observability_session: nil)
+    #       initialize_observability(
+    #         observability_session,
+    #         service_name: "my_service",
+    #         metadata: { custom: "data" }
+    #       )
+    #     end
+    #
+    #     def perform(input)
+    #       with_observability do |session|
+    #         # Your service logic here
+    #         # Session automatically finalized on success/error
+    #       end
+    #     end
+    #   end
+    module ObservableService
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :observability
+      end
+
+      # Initialize observability for the service
+      #
+      # @param session_or_false [Observ::Session, false, nil] Session to use, false to disable, nil to auto-create
+      # @param service_name [String] Name of the service (used in session metadata)
+      # @param metadata [Hash] Additional metadata to include in the session
+      def initialize_observability(session_or_false = nil, service_name:, metadata: {})
+        if session_or_false == false
+          # Explicitly disable observability
+          @observability = nil
+          @owns_session = false
+        elsif session_or_false
+          # Use provided session
+          @observability = session_or_false
+          @owns_session = false
+        else
+          # Auto-create session for standalone use
+          @observability = create_service_session(service_name, metadata)
+          @owns_session = @observability.present?
+        end
+      end
+
+      # Execute a block with automatic session lifecycle management
+      #
+      # The session will be finalized automatically after the block completes,
+      # whether it succeeds or raises an error. Only sessions owned by this
+      # service instance (i.e., auto-created sessions) will be finalized.
+      #
+      # @yield [session] The observability session (may be nil if disabled)
+      # @return The result of the block
+      #
+      # @example
+      #   with_observability do |session|
+      #     # Your service logic here
+      #     process_data(session)
+      #   end
+      def with_observability(&block)
+        result = block.call(@observability)
+        finalize_service_session if @owns_session
+        result
+      rescue StandardError
+        finalize_service_session if @owns_session
+        raise
+      end
+
+      # Instrument a RubyLLM chat instance for observability
+      #
+      # This wraps the chat's ask method to automatically create traces
+      # and track LLM calls within the observability session.
+      #
+      # @param chat [RubyLLM::Chat] The chat instance to instrument
+      # @param context [Hash] Additional context to include in traces
+      # @return [Observ::ChatInstrumenter, nil] The instrumenter or nil if observability is disabled
+      #
+      # @example
+      #   chat = RubyLLM.chat(model: "gpt-4")
+      #   instrument_chat(chat, context: { operation: "summarize" })
+      #   response = chat.ask("Summarize this text")
+      def instrument_chat(chat, context: {})
+        return unless @observability
+
+        @observability.instrument_chat(chat, context: context)
+      end
+
+      private
+
+      # Create a new observability session for this service
+      #
+      # @param service_name [String] Name of the service
+      # @param metadata [Hash] Additional metadata for the session
+      # @return [Observ::Session, nil] The created session or nil if observability is disabled/failed
+      def create_service_session(service_name, metadata = {})
+        return nil unless Rails.configuration.observability.enabled
+
+        Observ::Session.create!(
+          user_id: "#{service_name}_service",
+          metadata: metadata.merge(
+            agent_type: service_name,
+            standalone: true,
+            created_at: Time.current.iso8601
+          )
+        )
+      rescue StandardError => e
+        Rails.logger.error(
+          "[#{self.class.name}] Failed to create observability session: #{e.message}"
+        )
+        nil
+      end
+
+      # Finalize the observability session if we own it
+      #
+      # This marks the session as complete and triggers aggregation of metrics.
+      # Only called for sessions created by this service instance.
+      def finalize_service_session
+        return unless @observability
+
+        @observability.finalize
+        Rails.logger.debug(
+          "[#{self.class.name}] Session finalized: #{@observability.session_id}"
+        )
+      rescue StandardError => e
+        Rails.logger.error(
+          "[#{self.class.name}] Failed to finalize session: #{e.message}"
+        )
+      end
+    end
+  end
+end

data/app/views/layouts/observ/application.html.erb

@@ -86,7 +86,7 @@
       <div class="observ-sidebar__footer">
         <%= link_to main_app.instance_exec(&Observ.config.back_to_app_path), class: "observ-sidebar__back-link" do %>
           <span>&larr;</span>
-          <span><%= Observ.config.back_to_app_label %></span>
+          <span>Back to App</span>
         <% end %>
       </div>
     </aside>

data/lib/observ/configuration.rb

@@ -17,7 +17,6 @@ module Observ
                   :prompt_config_schema,
                   :prompt_config_schema_strict,
                   :back_to_app_path,
-                  :back_to_app_label,
                   :chat_ui_enabled,
                   :agent_path,
                   :pagination_per_page
@@ -38,7 +37,6 @@ module Observ
       @prompt_config_schema = default_prompt_config_schema
       @prompt_config_schema_strict = false
       @back_to_app_path = -> { "/" }
-      @back_to_app_label = "← Back to App"
       @chat_ui_enabled = -> { defined?(::Chat) && ::Chat.respond_to?(:acts_as_chat) }
       @agent_path = nil # Defaults to Rails.root.join("app", "agents")
       @pagination_per_page = 25

data/lib/observ/version.rb

@@ -1,3 +1,3 @@
 module Observ
-  VERSION = "0.6.4"
+  VERSION = "0.6.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyllm-observ
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.6
 platform: ruby
 authors:
 - Franck D'agostini
@@ -309,6 +309,7 @@ files:
 - app/services/observ/agent_provider.rb
 - app/services/observ/agent_selection_service.rb
 - app/services/observ/chat_instrumenter.rb
+- app/services/observ/concerns/observable_service.rb
 - app/services/observ/dataset_runner_service.rb
 - app/services/observ/evaluator_runner_service.rb
 - app/services/observ/evaluators/base_evaluator.rb