tracebook 0.1.1 → 1.0.0

data/lib/tracebook/seeds/pricing_rules.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Tracebook
+  module Seeds
+    module PricingRules
+      # All prices are in cents per 1,000,000 tokens.
+      # effective_from is set to provider's approximate release date.
+      DEFAULTS = [
+        # Gemini (Google)
+        { provider: "gemini", model_glob: "gemini-2.0-flash*", input_cents_per_unit: 10, output_cents_per_unit: 40, effective_from: Date.new(2024, 12, 11) },
+        { provider: "gemini", model_glob: "gemini-1.5-pro*", input_cents_per_unit: 125, output_cents_per_unit: 500, effective_from: Date.new(2024, 5, 14) },
+        { provider: "gemini", model_glob: "gemini-1.5-flash*", input_cents_per_unit: 8, output_cents_per_unit: 30, effective_from: Date.new(2024, 5, 14) },
+
+        # OpenAI
+        { provider: "openai", model_glob: "gpt-4o", input_cents_per_unit: 250, output_cents_per_unit: 1000, effective_from: Date.new(2024, 5, 13) },
+        { provider: "openai", model_glob: "gpt-4o-mini*", input_cents_per_unit: 15, output_cents_per_unit: 60, effective_from: Date.new(2024, 7, 18) },
+        { provider: "openai", model_glob: "gpt-4-turbo*", input_cents_per_unit: 1000, output_cents_per_unit: 3000, effective_from: Date.new(2024, 4, 9) },
+
+        # Anthropic
+        { provider: "anthropic", model_glob: "claude-3-5-sonnet*", input_cents_per_unit: 300, output_cents_per_unit: 1500, effective_from: Date.new(2024, 6, 20) },
+        { provider: "anthropic", model_glob: "claude-3-5-haiku*", input_cents_per_unit: 80, output_cents_per_unit: 400, effective_from: Date.new(2024, 10, 22) },
+        { provider: "anthropic", model_glob: "claude-3-opus*", input_cents_per_unit: 1500, output_cents_per_unit: 7500, effective_from: Date.new(2024, 3, 4) },
+
+        # Ollama (local/free)
+        { provider: "ollama", model_glob: "*", input_cents_per_unit: 0, output_cents_per_unit: 0, effective_from: Date.new(2023, 1, 1) }
+      ].freeze
+
+      class << self
+        # Seeds default pricing rules idempotently.
+        # Uses find_or_create_by on provider + model_glob to avoid duplicates.
+        #
+        # @return [Hash] Summary with :created and :skipped counts
+        def seed!
+          created = 0
+          skipped = 0
+
+          DEFAULTS.each do |attrs|
+            rule = Tracebook::PricingRule.find_or_initialize_by(
+              provider: attrs[:provider],
+              model_glob: attrs[:model_glob]
+            )
+
+            if rule.new_record?
+              rule.assign_attributes(
+                input_cents_per_unit: attrs[:input_cents_per_unit],
+                output_cents_per_unit: attrs[:output_cents_per_unit],
+                effective_from: attrs[:effective_from],
+                currency: "USD"
+              )
+              rule.save!
+              created += 1
+            else
+              skipped += 1
+            end
+          end
+
+          { created:, skipped: }
+        end
+      end
+    end
+  end
+end

data/lib/tracebook/version.rb

@@ -1,3 +1,3 @@
 module Tracebook
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/tracebook.rb

@@ -2,163 +2,80 @@ require "pagy"
 require "tracebook/version"
 require "tracebook/engine"
 require "tracebook/errors"
-require "tracebook/redactors"
-require "tracebook/mappers"
+require "tracebook/redaction/pattern"
+require "tracebook/redaction/pipeline"
 require "tracebook/config"
-require "tracebook/result"
-require "tracebook/normalized_interaction"
-require "tracebook/redaction_pipeline"
 require "tracebook/pricing"
 require "tracebook/adapters"
+require "tracebook/seeds/pricing_rules"
 
-# TraceBook is a Rails engine for capturing, storing, and reviewing LLM interactions.
+# TraceBook is a Rails engine for cost tracking and review of LLM conversations.
 #
-# It provides:
-# - Automatic redaction of PII from request/response payloads
-# - Encrypted storage of sensitive data using ActiveRecord::Encryption
-# - Cost tracking based on token usage and configurable pricing rules
-# - Review workflow (approve/flag/reject) with audit trail
-# - Hotwire-powered dashboard UI with filtering and export
-# - Built-in adapters for OpenAI, Anthropic, Ollama
-# - Support for hierarchical agent sessions (parent-child relationships)
+# It works as a layer on top of RubyLLM, adding:
+# - Cost calculation per message based on pricing rules
+# - Review workflow (approve/flag) per chat
+# - Dashboard UI for monitoring LLM usage
 #
-# @example Basic configuration
-#   TraceBook.configure do |config|
-#     config.authorize = ->(user, action, resource) { user&.admin? }
-#     config.project_name = "My App"
-#     config.persist_async = Rails.env.production?
+# @example Configuration
+#   Tracebook.configure do |config|
+#     config.chat_class = "Chat"
+#     config.message_class = "Message"
+#     config.default_currency = "USD"
+#     config.actor_display = ->(actor) { actor.try(:name) }
 #   end
 #
-# @example Recording an interaction
-#   TraceBook.record!(
-#     provider: "openai",
-#     model: "gpt-4o",
-#     request_payload: { messages: messages },
-#     response_payload: response,
-#     input_tokens: 100,
-#     output_tokens: 50,
-#     user: current_user,
-#     tags: ["production", "support"]
-#   )
-#
-# @see https://github.com/dpaluy/tracebook README for full documentation
+# @example Cost calculation
+#   Tracebook.calculate_cost!(message)
 module Tracebook
   class << self
-    # Returns the current configuration instance.
-    #
-    # @return [Tracebook::Config] the configuration object
     def config
       @config ||= Config.new
     end
 
-    # Configures TraceBook with a block.
-    #
-    # Configuration is frozen after the block executes. Call {#reset_configuration!}
-    # in tests to reset.
-    #
-    # @yield [config] Yields the config object for modification
-    # @yieldparam config [Tracebook::Config] the configuration object
-    # @return [Tracebook::Config] the finalized configuration
-    # @raise [ConfigurationError] if configuration is already finalized
-    #
-    # @example
-    #   TraceBook.configure do |config|
-    #     config.authorize = ->(user, action, resource) { user&.admin? }
-    #     config.persist_async = true
-    #     config.project_name = "Support App"
-    #   end
     def configure
       ensure_configurable!
-
       yield(config)
       finalize_configuration!
       config
     end
 
-    # Resets configuration to a clean state.
-    #
-    # Used in tests to start with fresh configuration between test cases.
-    #
-    # @return [void]
-    #
-    # @example In test setup
-    #   setup do
-    #     TraceBook.reset_configuration!
-    #     TraceBook.configure do |config|
-    #       config.authorize = ->(*) { true }
-    #     end
-    #   end
     def reset_configuration!
       @config = Config.new
       @configuration_finalized = false
     end
 
-    # Records an LLM interaction.
-    #
-    # When `config.persist_async` is true, the interaction is enqueued via
-    # {PersistInteractionJob}. Otherwise, it's persisted inline.
+    # Redact PII from text using configured patterns and custom redactors.
     #
-    # @param attributes [Hash] Interaction attributes
-    # @option attributes [String] :provider Provider name (e.g., "openai", "anthropic") **required**
-    # @option attributes [String] :model Model identifier (e.g., "gpt-4o", "claude-3-5-sonnet") **required**
-    # @option attributes [String, nil] :project Project name for filtering
-    # @option attributes [Hash, nil] :request_payload Full request sent to provider (will be encrypted)
-    # @option attributes [Hash, nil] :response_payload Full response from provider (will be encrypted)
-    # @option attributes [String, nil] :request_text Human-readable request summary
-    # @option attributes [String, nil] :response_text Human-readable response summary
-    # @option attributes [Integer, nil] :input_tokens Prompt token count
-    # @option attributes [Integer, nil] :output_tokens Completion token count
-    # @option attributes [Integer, nil] :latency_ms Request duration in milliseconds
-    # @option attributes [Symbol, String] :status :success, :error, or :canceled (default: :success)
-    # @option attributes [String, nil] :error_class Exception class name on failure
-    # @option attributes [String, nil] :error_message Exception message on failure
-    # @option attributes [Array<String>] :tags Labels for filtering (e.g., ["prod", "urgent"])
-    # @option attributes [Hash] :metadata Custom metadata (e.g., { ticket_id: 123 })
-    # @option attributes [ActiveRecord::Base, nil] :user Associated user (polymorphic)
-    # @option attributes [String, nil] :session_id Session identifier for grouping related calls
-    # @option attributes [Integer, nil] :parent_id Parent interaction ID for hierarchical chains
-    # @option attributes [String, nil] :idempotency_key Key for deduplication
-    #
-    # @return [Tracebook::Result] Result object with success/error information
-    #
-    # @example Recording a successful completion
-    #   result = TraceBook.record!(
-    #     provider: "openai",
-    #     model: "gpt-4o-mini",
-    #     request_payload: { messages: [{ role: "user", content: "Hello" }] },
-    #     response_payload: { choices: [{ message: { content: "Hi!" } }] },
-    #     input_tokens: 10,
-    #     output_tokens: 5,
-    #     latency_ms: 150,
-    #     status: :success,
-    #     user: current_user,
-    #     tags: ["greeting"]
-    #   )
+    # @param text [String] the text to redact
+    # @return [String] redacted text
+    def redact(text)
+      config.redaction_pipeline.call(text)
+    end
+
+    # Calculate and store cost for a message.
     #
-    # @example Recording a failed request
-    #   TraceBook.record!(
-    #     provider: "anthropic",
-    #     model: "claude-3-5-sonnet",
-    #     request_payload: request,
-    #     response_payload: nil,
-    #     status: :error,
-    #     error_class: "Faraday::TimeoutError",
-    #     error_message: "Request timed out after 30s",
-    #     latency_ms: 30000
-    #   )
-    def record!(**attributes)
-      payload = build_normalized_interaction(attributes)
-      result = Result.new(idempotency_key: attributes[:idempotency_key])
+    # @param message [ActiveRecord::Base] a message record with input_tokens, output_tokens
+    # @param provider [String] provider name (e.g., "openai", "anthropic")
+    # @param model [String] model identifier (e.g., "gpt-4o")
+    # @param latency_ms [Integer, nil] request duration in milliseconds
+    # @return [Tracebook::MessageCost] the created cost record
+    def calculate_cost!(message, provider:, model:, latency_ms: nil)
+      cost = Pricing::Calculator.call(
+        provider: provider,
+        model: model,
+        input_tokens: message.input_tokens,
+        output_tokens: message.output_tokens,
+        occurred_at: message.created_at
+      )
 
-      if config.persist_async
-        PersistInteractionJob.perform_later(payload.to_h)
-        result
-      else
-        interaction = PersistInteractionJob.perform_now(payload.to_h)
-        Result.new(interaction: interaction, idempotency_key: attributes[:idempotency_key])
-      end
-    rescue StandardError => error
-      Result.new(error: error, idempotency_key: attributes[:idempotency_key])
+      MessageCost.create!(
+        message: message,
+        cost_input_cents: cost.input_cents,
+        cost_output_cents: cost.output_cents,
+        cost_total_cents: cost.total_cents,
+        currency: cost.currency || config.default_currency,
+        latency_ms: latency_ms
+      )
     end
 
     private
@@ -171,30 +88,7 @@ module Tracebook
     def ensure_configurable!
       return unless @configuration_finalized || config.finalized?
 
-      raise ConfigurationError, "TraceBook configuration is already finalized"
-    end
-
-    def build_normalized_interaction(attributes)
-      NormalizedInteraction.new(
-        provider: attributes.fetch(:provider),
-        model: attributes.fetch(:model),
-        project: attributes[:project],
-        request_payload: attributes[:request_payload],
-        response_payload: attributes[:response_payload],
-        request_text: attributes[:request_text],
-        response_text: attributes[:response_text],
-        input_tokens: attributes[:input_tokens],
-        output_tokens: attributes[:output_tokens],
-        latency_ms: attributes[:latency_ms],
-        status: attributes.fetch(:status, "success"),
-        error_class: attributes[:error_class],
-        error_message: attributes[:error_message],
-        tags: Array(attributes[:tags]).compact,
-        metadata: attributes[:metadata] || {},
-        user: attributes[:user],
-        parent_id: attributes[:parent_id],
-        session_id: attributes[:session_id]
-      )
+      raise ConfigurationError, "Tracebook configuration is already finalized"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tracebook
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - dpaluy
@@ -51,20 +51,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: csv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: pagy
   requirement: !ruby/object:Gem::Requirement
@@ -79,9 +65,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '43.0'
-description: TraceBook provides a Rails engine for capturing, storing, and reviewing
-  LLM API interactions with built-in support for OpenAI, Anthropic, and Ollama. Features
-  include PII redaction, cost tracking, review workflows, and export capabilities.
+description: Tracebook is a Rails engine that adds cost tracking, review workflows,
+  and a dashboard UI on top of RubyLLM's Chat and Message models. Features include
+  per-message cost calculation with configurable pricing rules, chat-level approval
+  workflows, and a Hotwire-powered dashboard.
 email:
 - dpaluy@users.noreply.github.com
 executables: []
@@ -100,29 +87,25 @@ files:
 - app/assets/stylesheets/tracebook/application.css
 - app/controllers/concerns/.keep
 - app/controllers/tracebook/application_controller.rb
-- app/controllers/tracebook/exports_controller.rb
-- app/controllers/tracebook/interactions_controller.rb
+- app/controllers/tracebook/chats_controller.rb
+- app/controllers/tracebook/comments_controller.rb
 - app/helpers/tracebook/application_helper.rb
-- app/helpers/tracebook/interactions_helper.rb
+- app/helpers/tracebook/chats_helper.rb
 - app/jobs/tracebook/application_job.rb
-- app/jobs/tracebook/daily_rollups_job.rb
-- app/jobs/tracebook/export_job.rb
-- app/jobs/tracebook/persist_interaction_job.rb
-- app/mailers/tracebook/application_mailer.rb
 - app/models/concerns/.keep
 - app/models/tracebook/application_record.rb
-- app/models/tracebook/interaction.rb
+- app/models/tracebook/chat_review.rb
+- app/models/tracebook/comment.rb
+- app/models/tracebook/message_cost.rb
 - app/models/tracebook/pricing_rule.rb
-- app/models/tracebook/redaction_rule.rb
-- app/models/tracebook/rollup_daily.rb
 - app/views/layouts/tracebook/application.html.erb
-- app/views/tracebook/interactions/index.html.erb
-- app/views/tracebook/interactions/show.html.erb
+- app/views/tracebook/chats/index.html.erb
+- app/views/tracebook/chats/show.html.erb
 - config/routes.rb
-- db/migrate/20241112000100_create_tracebook_interactions.rb
-- db/migrate/20241112000200_create_tracebook_rollups_dailies.rb
-- db/migrate/20241112000300_create_tracebook_pricing_rules.rb
-- db/migrate/20241112000400_create_tracebook_redaction_rules.rb
+- db/migrate/20260325000100_create_tracebook_message_costs.rb
+- db/migrate/20260325000200_create_tracebook_chat_reviews.rb
+- db/migrate/20260325000300_create_tracebook_pricing_rules.rb
+- db/migrate/20260325000500_create_tracebook_comments.rb
 - lib/generators/tracebook/install/USAGE
 - lib/generators/tracebook/install/install_generator.rb
 - lib/generators/tracebook/install/templates/initializer.rb.tt
@@ -130,26 +113,15 @@ files:
 - lib/tasks/yard.rake
 - lib/tracebook.rb
 - lib/tracebook/adapters.rb
-- lib/tracebook/adapters/active_agent.rb
 - lib/tracebook/adapters/ruby_llm.rb
 - lib/tracebook/config.rb
 - lib/tracebook/engine.rb
 - lib/tracebook/errors.rb
-- lib/tracebook/mappers.rb
-- lib/tracebook/mappers/anthropic.rb
-- lib/tracebook/mappers/base.rb
-- lib/tracebook/mappers/ollama.rb
-- lib/tracebook/mappers/openai.rb
-- lib/tracebook/normalized_interaction.rb
 - lib/tracebook/pricing.rb
 - lib/tracebook/pricing/calculator.rb
-- lib/tracebook/redaction_pipeline.rb
-- lib/tracebook/redactors.rb
-- lib/tracebook/redactors/base.rb
-- lib/tracebook/redactors/card_pan.rb
-- lib/tracebook/redactors/email.rb
-- lib/tracebook/redactors/phone.rb
-- lib/tracebook/result.rb
+- lib/tracebook/redaction/pattern.rb
+- lib/tracebook/redaction/pipeline.rb
+- lib/tracebook/seeds/pricing_rules.rb
 - lib/tracebook/version.rb
 homepage: https://github.com/dpaluy/tracebook
 licenses:
@@ -159,7 +131,7 @@ metadata:
   homepage_uri: https://github.com/dpaluy/tracebook
   documentation_uri: https://rubydoc.info/gems/tracebook
   source_code_uri: https://github.com/dpaluy/tracebook
-  changelog_uri: https://github.com/dpaluy/tracebook/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/dpaluy/tracebook/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/dpaluy/tracebook/issues
 rdoc_options: []
 require_paths:
@@ -168,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -177,5 +149,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Rails engine for LLM interaction telemetry and review.
+summary: Cost tracking and review dashboard for RubyLLM conversations.
 test_files: []

data/app/controllers/tracebook/exports_controller.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Tracebook
-  class ExportsController < ApplicationController
-    def create
-      blob = ExportJob.perform_now(format: params.fetch(:format, :csv), filters: export_filters)
-      redirect_to export_path(blob.signed_id), notice: "Export ready"
-    end
-
-    def show
-      blob = ActiveStorage::Blob.find_signed(params[:id])
-      send_data blob.download, filename: blob.filename.to_s, type: blob.content_type
-    rescue ActiveSupport::MessageVerifier::InvalidSignature
-      head :not_found
-    end
-
-    private
-
-    def export_filters
-      params.fetch(:filters, {}).permit(:provider, :model, :project, :status, :review_state, :from, :to)
-    end
-  end
-end
-
-TraceBook = Tracebook unless defined?(TraceBook)

data/app/controllers/tracebook/interactions_controller.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-module Tracebook
-  class InteractionsController < ApplicationController
-    include Pagy::Method
-
-    before_action :set_interaction, only: [ :show, :review ]
-    helper InteractionsHelper
-
-    def index
-      @filters = filter_params
-      scope = Interaction.filtered(@filters)
-      @kpis = kpis_for(scope)
-      @pagy, @interactions = pagy(scope.order(created_at: :desc), limit: Tracebook.config.per_page)
-      @providers = Interaction.distinct.order(:provider).pluck(:provider)
-      @models = Interaction.distinct.order(:model).pluck(:model)
-      @projects = Interaction.distinct.order(:project).pluck(:project).compact
-    end
-
-    def show
-    end
-
-    def review
-      state = params.require(:review_state).to_s
-      unless Interaction.review_states.key?(state)
-        redirect_to interaction_path(@interaction), alert: "Invalid review state: #{state}"
-        return
-      end
-
-      if @interaction.update(review_state: state)
-        redirect_to interaction_path(@interaction), notice: "Review updated"
-      else
-        render :show, status: :unprocessable_entity
-      end
-    end
-
-    def bulk_review
-      ids = Array(params[:interaction_ids])
-      state = params.require(:review_state).to_s
-      unless Interaction.review_states.key?(state)
-        redirect_to interactions_path, alert: "Invalid review state: #{state}"
-        return
-      end
-
-      Interaction.where(id: ids).update_all(review_state: Interaction.review_states.fetch(state))
-      redirect_to interactions_path, notice: "Updated #{ids.size} interactions"
-    end
-
-    private
-
-    def set_interaction
-      @interaction = Interaction.find(params[:id])
-    end
-
-    def filter_params
-      params.fetch(:filters, {}).permit(:provider, :model, :project, :status, :review_state, :tag, :from, :to)
-    end
-
-    def kpis_for(scope)
-      {
-        total: scope.count,
-        success: scope.status_success.count,
-        cost_cents: scope.sum(:cost_total_cents),
-        input_tokens: scope.sum(:input_tokens),
-        output_tokens: scope.sum(:output_tokens)
-      }
-    end
-  end
-end
-
-TraceBook = Tracebook unless defined?(TraceBook)

data/app/helpers/tracebook/interactions_helper.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-module Tracebook
-  module InteractionsHelper
-    def payload_for(interaction, type)
-      inline = interaction.public_send("#{type}_payload")
-      return inline unless inline.nil? || (inline.respond_to?(:empty?) && inline.empty?)
-
-      blob = interaction.public_send("#{type}_payload_blob")
-      return nil unless blob
-
-      raw = blob.download
-      JSON.parse(raw)
-    rescue JSON::ParserError
-      raw
-    end
-
-    def formatted_payload(payload, fallback_text = nil)
-      case payload
-      when Hash, Array
-        JSON.pretty_generate(payload)
-      when String
-        payload
-      when nil
-        fallback_text.to_s
-      else
-        JSON.pretty_generate(payload.as_json)
-      end
-    rescue JSON::GeneratorError, TypeError
-      fallback_text ? fallback_text.to_s : payload.to_s
-    end
-  end
-end