feat: basic, configurable structured logging

Author: vicentereig

.gitignore

@@ -1,3 +1,4 @@
+log/*.log
 .idea
 .byebug_history
 .env

.rspec_status

@@ -1,20 +1,20 @@
 example_id                                    | status | run_time        |
 --------------------------------------------- | ------ | --------------- |
-./spec/dspy/chain_of_thought_spec.rb[1:1:1]   | passed | 0.03328 seconds |
-./spec/dspy/chain_of_thought_spec.rb[1:1:2]   | passed | 0.00204 seconds |
-./spec/dspy/colbertv2_rag_spec.rb[1:1]        | passed | 0.00093 seconds |
-./spec/dspy/colbertv2_rag_spec.rb[1:2]        | passed | 0.00308 seconds |
-./spec/dspy/ext/dry_schema_ext_spec.rb[1:1]   | passed | 0.001 seconds   |
-./spec/dspy/ext/dry_schema_ext_spec.rb[1:2]   | passed | 0.00008 seconds |
-./spec/dspy/ext/dry_schema_ext_spec.rb[1:3]   | passed | 0.00103 seconds |
+./spec/dspy/chain_of_thought_spec.rb[1:1:1]   | passed | 0.03684 seconds |
+./spec/dspy/chain_of_thought_spec.rb[1:1:2]   | passed | 0.0017 seconds  |
+./spec/dspy/colbertv2_rag_spec.rb[1:1]        | passed | 0.00079 seconds |
+./spec/dspy/colbertv2_rag_spec.rb[1:2]        | passed | 0.00291 seconds |
+./spec/dspy/ext/dry_schema_ext_spec.rb[1:1]   | passed | 0.00091 seconds |
+./spec/dspy/ext/dry_schema_ext_spec.rb[1:2]   | passed | 0.00014 seconds |
+./spec/dspy/ext/dry_schema_ext_spec.rb[1:3]   | passed | 0.00088 seconds |
 ./spec/dspy/ext/dry_schema_ext_spec.rb[1:4]   | passed | 0.00007 seconds |
-./spec/dspy/multi_stage_pipeline_spec.rb[1:1] | passed | 0.00164 seconds |
-./spec/dspy/multi_stage_pipeline_spec.rb[1:2] | passed | 0.00139 seconds |
-./spec/dspy/multi_stage_pipeline_spec.rb[1:3] | passed | 0.005 seconds   |
-./spec/dspy/multi_stage_pipeline_spec.rb[1:4] | passed | 0.00336 seconds |
-./spec/dspy/predict_spec.rb[1:1:1]            | passed | 0.00153 seconds |
-./spec/dspy/predict_spec.rb[1:1:2]            | passed | 0.00115 seconds |
+./spec/dspy/multi_stage_pipeline_spec.rb[1:1] | passed | 0.00167 seconds |
+./spec/dspy/multi_stage_pipeline_spec.rb[1:2] | passed | 0.00137 seconds |
+./spec/dspy/multi_stage_pipeline_spec.rb[1:3] | passed | 0.00367 seconds |
+./spec/dspy/multi_stage_pipeline_spec.rb[1:4] | passed | 0.00536 seconds |
+./spec/dspy/predict_spec.rb[1:1:1]            | passed | 0.0017 seconds  |
+./spec/dspy/predict_spec.rb[1:1:2]            | passed | 0.00166 seconds |
 ./spec/dspy/signature_spec.rb[1:1]            | passed | 0.00006 seconds |
-./spec/dspy/signature_spec.rb[1:2]            | passed | 0.00006 seconds |
-./spec/dspy_spec.rb[1:1:1]                    | passed | 0.00031 seconds |
-./spec/dspy_spec.rb[1:1:2]                    | passed | 0.00004 seconds |
+./spec/dspy/signature_spec.rb[1:2]            | passed | 0.00005 seconds |
+./spec/dspy_spec.rb[1:1:1]                    | passed | 0.00035 seconds |
+./spec/dspy_spec.rb[1:1:2]                    | passed | 0.00006 seconds |

Gemfile.lock

@@ -3,6 +3,7 @@ PATH
   specs:
     dspy (0.1.0)
       dry-configurable (~> 1.0)
+      dry-logger (~> 1.0)
       dry-schema (~> 1.14)
       ruby_llm (~> 1.0)
 
@@ -29,6 +30,7 @@ GEM
       zeitwerk (~> 2.6)
     dry-inflector (1.2.0)
     dry-initializer (3.2.0)
+    dry-logger (1.0.4)
     dry-logic (1.6.0)
       bigdecimal
       concurrent-ruby (~> 1.0)

dspy.gemspec

@@ -25,5 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ruby_llm", "~> 1.0"
   spec.add_dependency "dry-schema", "~> 1.14"
   spec.add_dependency "dry-configurable", "~> 1.0"
+  spec.add_dependency "dry-logger", "~> 1.0"
   # Development dependencies are already specified in the Gemfile
 end

lib/dspy.rb

@@ -2,11 +2,17 @@
 require 'ruby_llm'
 require 'dry-schema'
 require 'dry-configurable'
+require 'dry/logger'
 require_relative 'dspy/ext/dry_schema'
 
 module DSPy
   extend Dry::Configurable
   setting :lm
+  setting :logger, default: Dry.Logger(:dspy, formatter: :string)
+
+  def self.logger
+    config.logger
+  end
 end
 
 require_relative 'dspy/types'

lib/dspy/ext/dry_schema.rb

@@ -1,3 +1,9 @@
+require 'dry/schema/version'
+
+if Dry::Schema::VERSION > Gem::Version.new('1.15')
+  raise 'Double check this monkey path before upgrading drys-schema.'
+end
+
 Dry::Schema.load_extensions(:json_schema)
 # Monkey patch Macros::Core to add meta method
 module Dry

lib/dspy/predict.rb

@@ -52,6 +52,7 @@ def lm
     end
 
     def forward(**input_values)
+      DSPy.logger.info( module: self.class.to_s, **input_values)
       result = @signature_class.input_schema.call(input_values)
       if result.success?
         output_attributes = lm.chat(self, input_values)

log/.gitkeep

@@ -9,6 +9,7 @@
 
   describe 'sentiment classification example' do
     before do
+
       VCR.use_cassette('openai/gpt4o-mini/classify_sentiment_v2') do
         class Classify < DSPy::Signature
           description "Classify sentiment of a given sentence."
@@ -23,7 +24,6 @@ class Classify < DSPy::Signature
             required(:confidence).value(:float).meta(description: 'The confidence score for the classification')
           end
         end
-
         # Create the predictor
         @classify = DSPy::Predict.new(Classify)
 

spec/dspy/predict_spec.rb

@@ -5,6 +5,9 @@
 
 require 'dspy'
 
+DSPy.configure do |c|
+  c.logger = Dry.Logger(:dspy, formatter: :string) { |s| s.add_backend(stream: "log/test.log") }
+end
 
 VCR.configure do |config|
   config.cassette_library_dir = "spec/vcr_cassettes"