Module: DSPy::Instrumentation

Defined in:
lib/dspy/instrumentation.rb,
lib/dspy/instrumentation/token_tracker.rb

Overview

Core instrumentation module using dry-monitor for event emission Provides extension points for logging, OpenTelemetry, New Relic, Langfuse, and custom monitoring

Defined Under Namespace

Modules: TokenTracker

Class Method Summary collapse

Class Method Details

.emit(event_name, payload = {}) ⇒ Object

Emit event without timing (for discrete events)



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/dspy/instrumentation.rb', line 156

def self.emit(event_name, payload = {})
  # Handle nil payload
  payload ||= {}
  
  enhanced_payload = payload.merge(
    status: payload[:status] || 'success'
  ).merge(generate_timestamp)

  self.emit_event(event_name, enhanced_payload)
end

.emit_event(event_name, payload) ⇒ Object 



184
185
186
187
 
# File 'lib/dspy/instrumentation.rb', line 184

def self.emit_event(event_name, payload)
  # Only emit events - subscribers self-register when explicitly created
  notifications.instrument(event_name, payload)
end

.generate_timestamp ⇒ Object

Generate timestamp in the configured format



270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/dspy/instrumentation.rb', line 270

def self.generate_timestamp
  case DSPy.config.instrumentation.timestamp_format
  when DSPy::TimestampFormat::ISO8601
    { timestamp: Time.now.iso8601 }
  when DSPy::TimestampFormat::RFC3339_NANO
    { timestamp: Time.now.strftime('%Y-%m-%dT%H:%M:%S.%9N%z') }
  when DSPy::TimestampFormat::UNIX_NANO
    { timestamp_ns: (Time.now.to_f * 1_000_000_000).to_i }
  else
    { timestamp: Time.now.iso8601 }  # Fallback to iso8601
  end
end

.instrument(event_name, payload = {}, &block) ⇒ Object

High-precision timing for performance tracking



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/dspy/instrumentation.rb', line 117

def self.instrument(event_name, payload = {}, &block)
  # If no block is given, return early
  return unless block_given?

  start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  start_cpu = Process.clock_gettime(Process::CLOCK_PROCESS_CPUTIME_ID)

  begin
    result = yield

    end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
    end_cpu = Process.clock_gettime(Process::CLOCK_PROCESS_CPUTIME_ID)

    enhanced_payload = payload.merge(
      duration_ms: ((end_time - start_time) * 1000).round(2),
      cpu_time_ms: ((end_cpu - start_cpu) * 1000).round(2),
      status: 'success'
    ).merge(generate_timestamp)

    self.emit_event(event_name, enhanced_payload)
    result
  rescue => error
    end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
    end_cpu = Process.clock_gettime(Process::CLOCK_PROCESS_CPUTIME_ID)

    error_payload = payload.merge(
      duration_ms: ((end_time - start_time) * 1000).round(2),
      cpu_time_ms: ((end_cpu - start_cpu) * 1000).round(2),
      status: 'error',
      error_type: error.class.name,
      error_message: error.message
    ).merge(generate_timestamp)

    self.emit_event(event_name, error_payload)
    raise
  end
end

.langfuse_available? ⇒ Boolean

Returns:

  • (Boolean) 


260
261
262
263
264
265
266
267
 
# File 'lib/dspy/instrumentation.rb', line 260

def self.langfuse_available?
  begin
    require 'langfuse'
    true
  rescue LoadError
    false
  end
end

.langfuse_subscriber(**options) ⇒ Object

Get a Langfuse subscriber instance (creates new instance each time)



30
31
32
33
 
# File 'lib/dspy/instrumentation.rb', line 30

def self.langfuse_subscriber(**options)
  require_relative 'subscribers/langfuse_subscriber'
  DSPy::Subscribers::LangfuseSubscriber.new(**options)
end

.logger_subscriber(**options) ⇒ Object

Get a logger subscriber instance (creates new instance each time)



12
13
14
15
 
# File 'lib/dspy/instrumentation.rb', line 12

def self.logger_subscriber(**options)
  require_relative 'subscribers/logger_subscriber'
  DSPy::Subscribers::LoggerSubscriber.new(**options)
end

.newrelic_available? ⇒ Boolean

Returns:

  • (Boolean) 


251
252
253
254
255
256
257
258
 
# File 'lib/dspy/instrumentation.rb', line 251

def self.newrelic_available?
  begin
    require 'newrelic_rpm'
    true
  rescue LoadError
    false
  end
end

.newrelic_subscriber(**options) ⇒ Object

Get a New Relic subscriber instance (creates new instance each time)



24
25
26
27
 
# File 'lib/dspy/instrumentation.rb', line 24

def self.newrelic_subscriber(**options)
  require_relative 'subscribers/newrelic_subscriber'
  DSPy::Subscribers::NewrelicSubscriber.new(**options)
end

.notifications ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/dspy/instrumentation.rb', line 35

def self.notifications
  @notifications ||= Dry::Monitor::Notifications.new(:dspy).tap do |n|
    # Register all DSPy events
    n.register_event('dspy.lm.request')
    n.register_event('dspy.lm.tokens')
    n.register_event('dspy.lm.response.parsed')
    n.register_event('dspy.predict')
    n.register_event('dspy.predict.validation_error')
    n.register_event('dspy.chain_of_thought')
    n.register_event('dspy.chain_of_thought.reasoning_step')
    n.register_event('dspy.react')
    n.register_event('dspy.react.tool_call')
    n.register_event('dspy.react.iteration_complete')
    n.register_event('dspy.react.max_iterations')
    
    # CodeAct events
    n.register_event('dspy.codeact')
    n.register_event('dspy.codeact.iteration')
    n.register_event('dspy.codeact.code_execution')
    n.register_event('dspy.codeact.iteration_complete')
    n.register_event('dspy.codeact.max_iterations')
    
    # Evaluation events
    n.register_event('dspy.evaluation.start')
    n.register_event('dspy.evaluation.example')
    n.register_event('dspy.evaluation.batch')
    n.register_event('dspy.evaluation.batch_complete')
    
    # Optimization events
    n.register_event('dspy.optimization.start')
    n.register_event('dspy.optimization.complete')
    n.register_event('dspy.optimization.trial_start')
    n.register_event('dspy.optimization.trial_complete')
    n.register_event('dspy.optimization.bootstrap_start')
    n.register_event('dspy.optimization.bootstrap_complete')
    n.register_event('dspy.optimization.bootstrap_example')
    n.register_event('dspy.optimization.minibatch_evaluation')
    n.register_event('dspy.optimization.instruction_proposal_start')
    n.register_event('dspy.optimization.instruction_proposal_complete')
    n.register_event('dspy.optimization.error')
    n.register_event('dspy.optimization.save')
    n.register_event('dspy.optimization.load')
    
    # Storage events
    n.register_event('dspy.storage.save_start')
    n.register_event('dspy.storage.save_complete')
    n.register_event('dspy.storage.save_error')
    n.register_event('dspy.storage.load_start')
    n.register_event('dspy.storage.load_complete')
    n.register_event('dspy.storage.load_error')
    n.register_event('dspy.storage.delete')
    n.register_event('dspy.storage.export')
    n.register_event('dspy.storage.import')
    n.register_event('dspy.storage.cleanup')
    
    # Memory compaction events
    n.register_event('dspy.memory.compaction_check')
    n.register_event('dspy.memory.size_compaction')
    n.register_event('dspy.memory.age_compaction')
    n.register_event('dspy.memory.deduplication')
    n.register_event('dspy.memory.relevance_pruning')
    n.register_event('dspy.memory.compaction_complete')
    
    # Registry events
    n.register_event('dspy.registry.register_start')
    n.register_event('dspy.registry.register_complete')
    n.register_event('dspy.registry.register_error')
    n.register_event('dspy.registry.deploy_start')
    n.register_event('dspy.registry.deploy_complete')
    n.register_event('dspy.registry.deploy_error')
    n.register_event('dspy.registry.rollback_start')
    n.register_event('dspy.registry.rollback_complete')
    n.register_event('dspy.registry.rollback_error')
    n.register_event('dspy.registry.performance_update')
    n.register_event('dspy.registry.export')
    n.register_event('dspy.registry.import')
    n.register_event('dspy.registry.auto_deployment')
    n.register_event('dspy.registry.automatic_rollback')
  end
end

.otel_available? ⇒ Boolean

Dependency checking methods

Returns:

  • (Boolean) 


242
243
244
245
246
247
248
249
 
# File 'lib/dspy/instrumentation.rb', line 242

def self.otel_available?
  begin
    require 'opentelemetry/sdk'
    true
  rescue LoadError
    false
  end
end

.otel_subscriber(**options) ⇒ Object

Get an OpenTelemetry subscriber instance (creates new instance each time)



18
19
20
21
 
# File 'lib/dspy/instrumentation.rb', line 18

def self.otel_subscriber(**options)
  require_relative 'subscribers/otel_subscriber'
  DSPy::Subscribers::OtelSubscriber.new(**options)
end

.register_event(event_name) ⇒ Object

Register additional events dynamically (useful for testing)



168
169
170
 
# File 'lib/dspy/instrumentation.rb', line 168

def self.register_event(event_name)
  notifications.register_event(event_name)
end

.setup_langfuse_subscriber ⇒ Object 



236
237
238
239
 
# File 'lib/dspy/instrumentation.rb', line 236

def self.setup_langfuse_subscriber
  # Create subscriber - it will read configuration when handling events
  langfuse_subscriber
end

.setup_logger_subscriber ⇒ Object 



221
222
223
224
 
# File 'lib/dspy/instrumentation.rb', line 221

def self.setup_logger_subscriber
  # Create subscriber - it will read configuration when handling events
  logger_subscriber
end

.setup_newrelic_subscriber ⇒ Object 



231
232
233
234
 
# File 'lib/dspy/instrumentation.rb', line 231

def self.setup_newrelic_subscriber
  # Create subscriber - it will read configuration when handling events
  newrelic_subscriber
end

.setup_otel_subscriber ⇒ Object 



226
227
228
229
 
# File 'lib/dspy/instrumentation.rb', line 226

def self.setup_otel_subscriber
  # Create subscriber - it will read configuration when handling events
  otel_subscriber
end

.setup_subscriber(subscriber_type) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/dspy/instrumentation.rb', line 204

def self.setup_subscriber(subscriber_type)
  case subscriber_type
  when :logger
    setup_logger_subscriber
  when :otel
    setup_otel_subscriber if otel_available?
  when :newrelic
    setup_newrelic_subscriber if newrelic_available?
  when :langfuse
    setup_langfuse_subscriber if langfuse_available?
  else
    raise ArgumentError, "Unknown subscriber type: #{subscriber_type}"
  end
rescue LoadError => e
  DSPy.logger.warn "Failed to setup #{subscriber_type} subscriber: #{e.message}"
end

.setup_subscribers ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/dspy/instrumentation.rb', line 189

def self.setup_subscribers
  config = DSPy.config.instrumentation
  
  # Return early if instrumentation is disabled
  return unless config.enabled
  
  # Validate configuration first
  DSPy.validate_instrumentation!
  
  # Setup each configured subscriber
  config.subscribers.each do |subscriber_type|
    setup_subscriber(subscriber_type)
  end
end

.setup_subscribers_legacy ⇒ Object

Legacy setup method for backward compatibility



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/dspy/instrumentation.rb', line 284

def self.setup_subscribers_legacy
  # Legacy initialization - will be created when first accessed
  # Force initialization of enabled subscribers
  logger_subscriber
  
  # Only initialize if dependencies are available
  begin
    otel_subscriber if ENV['OTEL_EXPORTER_OTLP_ENDPOINT'] || defined?(OpenTelemetry)
  rescue LoadError
    # OpenTelemetry not available, skip
  end

  begin
    newrelic_subscriber if defined?(NewRelic)
  rescue LoadError
    # New Relic not available, skip
  end

  begin
    langfuse_subscriber if ENV['LANGFUSE_SECRET_KEY'] || defined?(Langfuse)
  rescue LoadError
    # Langfuse not available, skip
  end
end

.subscribe(event_pattern = nil, &block) ⇒ Object

Subscribe to DSPy instrumentation events



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/dspy/instrumentation.rb', line 173

def self.subscribe(event_pattern = nil, &block)
  if event_pattern
    notifications.subscribe(event_pattern, &block)
  else
    # Subscribe to all DSPy events
    %w[dspy.lm.request dspy.lm.tokens dspy.lm.response.parsed dspy.predict dspy.predict.validation_error dspy.chain_of_thought dspy.chain_of_thought.reasoning_step dspy.react dspy.react.tool_call dspy.react.iteration_complete dspy.react.max_iterations].each do |event_name|
      notifications.subscribe(event_name, &block)
    end
  end
end