File: test_instrumentation.rb

package info (click to toggle)
ruby-dalli 5.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 992 kB
  • sloc: ruby: 9,447; sh: 19; makefile: 4
file content (462 lines) | stat: -rw-r--r-- 13,834 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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
115
116
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# frozen_string_literal: true

require_relative 'helper'

# Mock OpenTelemetry classes for testing
module MockOpenTelemetry
  class MockSpan
    attr_reader :name, :attributes, :kind, :recorded_exceptions
    attr_accessor :status

    def initialize(name, attributes:, kind:)
      @name = name
      @attributes = attributes.dup
      @kind = kind
      @recorded_exceptions = []
      @status = nil
    end

    def record_exception(exception)
      @recorded_exceptions << exception
    end

    def set_attribute(key, value)
      @attributes[key] = value
    end

    def add_attributes(attrs)
      @attributes.merge!(attrs)
    end
  end

  class MockTracer
    attr_reader :spans

    def initialize
      @spans = []
    end

    def in_span(name, attributes:, kind:)
      span = MockSpan.new(name, attributes: attributes, kind: kind)
      @spans << span
      yield span
    end
  end

  class MockTracerProvider
    def initialize(tracer)
      @mock_tracer = tracer
    end

    def tracer(_name, _version)
      @mock_tracer
    end
  end

  class MockStatus
    attr_reader :code, :description

    def initialize(code, description)
      @code = code
      @description = description
    end

    def self.error(message)
      new(:error, message)
    end
  end
end

describe Dalli::Instrumentation do
  def clear_tracer_cache
    return unless Dalli::Instrumentation.instance_variable_defined?(:@tracer)

    Dalli::Instrumentation.remove_instance_variable(:@tracer)
  end

  describe '.tracer' do
    it 'returns nil when OpenTelemetry is not defined' do
      clear_tracer_cache

      refute defined?(OpenTelemetry), 'OpenTelemetry should not be defined in this test environment'
      assert_nil Dalli::Instrumentation.tracer
    end
  end

  describe '.enabled?' do
    it 'returns false when OpenTelemetry is not available' do
      clear_tracer_cache

      refute_predicate Dalli::Instrumentation, :enabled?
    end
  end

  describe '.trace without OpenTelemetry' do
    it 'yields the block and returns its result when tracing is disabled' do
      clear_tracer_cache

      result = Dalli::Instrumentation.trace('test_operation', { 'test.key' => 'value' }) do
        'block result'
      end

      assert_equal 'block result', result
    end

    it 'propagates exceptions from the block' do
      clear_tracer_cache

      assert_raises(RuntimeError) do
        Dalli::Instrumentation.trace('test_operation') do
          raise 'test error'
        end
      end
    end
  end

  describe 'DEFAULT_ATTRIBUTES' do
    it 'includes db.system.name set to memcached' do
      assert_equal({ 'db.system.name' => 'memcached' }, Dalli::Instrumentation::DEFAULT_ATTRIBUTES)
    end

    it 'is frozen' do
      assert_predicate Dalli::Instrumentation::DEFAULT_ATTRIBUTES, :frozen?
    end
  end

  describe '.trace with mock OpenTelemetry' do
    before do
      clear_tracer_cache
      @mock_tracer = MockOpenTelemetry::MockTracer.new
      @mock_provider = MockOpenTelemetry::MockTracerProvider.new(@mock_tracer)

      # Define mock OpenTelemetry module
      Object.const_set(:OpenTelemetry, Module.new) unless defined?(OpenTelemetry)
      mock_provider = @mock_provider
      OpenTelemetry.define_singleton_method(:tracer_provider) { mock_provider }

      # Define mock Status class
      unless defined?(OpenTelemetry::Trace::Status)
        OpenTelemetry.const_set(:Trace, Module.new)
        OpenTelemetry::Trace.const_set(:Status, MockOpenTelemetry::MockStatus)
      end
    end

    after do
      clear_tracer_cache
      # Remove mock OpenTelemetry
      Object.send(:remove_const, :OpenTelemetry) if defined?(OpenTelemetry)
    end

    it 'returns true for enabled? when OpenTelemetry is available' do
      assert_predicate Dalli::Instrumentation, :enabled?
    end

    it 'creates a span with correct name and attributes' do
      Dalli::Instrumentation.trace('get', { 'db.operation.name' => 'get' }) { 'result' }

      assert_equal 1, @mock_tracer.spans.size
      span = @mock_tracer.spans.first

      assert_equal 'get', span.name
      assert_equal 'memcached', span.attributes['db.system.name']
      assert_equal 'get', span.attributes['db.operation.name']
      assert_equal :client, span.kind
    end

    it 'returns the block result' do
      result = Dalli::Instrumentation.trace('set', {}) { 'cached_value' }

      assert_equal 'cached_value', result
    end

    # Exception recording and error status are handled automatically by
    # OpenTelemetry's in_span method, so we don't test those explicitly here.
    # See: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/api/lib/opentelemetry/trace/tracer.rb

    it 're-raises exceptions' do
      assert_raises(Dalli::DalliError) do
        Dalli::Instrumentation.trace('get', {}) do
          raise Dalli::DalliError, 'memcached error'
        end
      end
    end

    it 'merges default attributes with provided attributes' do
      Dalli::Instrumentation.trace('get_multi', { 'custom.attr' => 'value' }) { 'result' }

      span = @mock_tracer.spans.first

      assert_equal 'memcached', span.attributes['db.system.name']
      assert_equal 'value', span.attributes['custom.attr']
    end
  end

  describe '.trace_with_result with mock OpenTelemetry' do
    before do
      clear_tracer_cache
      @mock_tracer = MockOpenTelemetry::MockTracer.new
      @mock_provider = MockOpenTelemetry::MockTracerProvider.new(@mock_tracer)

      Object.const_set(:OpenTelemetry, Module.new) unless defined?(OpenTelemetry)
      mock_provider = @mock_provider
      OpenTelemetry.define_singleton_method(:tracer_provider) { mock_provider }

      unless defined?(OpenTelemetry::Trace::Status)
        OpenTelemetry.const_set(:Trace, Module.new)
        OpenTelemetry::Trace.const_set(:Status, MockOpenTelemetry::MockStatus)
      end
    end

    after do
      clear_tracer_cache
      Object.send(:remove_const, :OpenTelemetry) if defined?(OpenTelemetry)
    end

    it 'yields the span to the block' do
      yielded_span = nil
      Dalli::Instrumentation.trace_with_result('get_multi', {}) do |span|
        yielded_span = span
        'result'
      end

      assert_equal @mock_tracer.spans.first, yielded_span
    end

    it 'allows setting attributes on the span after execution' do
      Dalli::Instrumentation.trace_with_result('get_multi', { 'db.operation.name' => 'get_multi' }) do |span|
        span.set_attribute('db.memcached.hit_count', 5)
        span.set_attribute('db.memcached.miss_count', 2)
        'result'
      end

      span = @mock_tracer.spans.first

      assert_equal 5, span.attributes['db.memcached.hit_count']
      assert_equal 2, span.attributes['db.memcached.miss_count']
    end

    it 'yields nil when tracing is disabled' do
      clear_tracer_cache
      Object.send(:remove_const, :OpenTelemetry)

      yielded_value = :not_set
      result = Dalli::Instrumentation.trace_with_result('get_multi', {}) do |span|
        yielded_value = span
        'result'
      end

      assert_nil yielded_value
      assert_equal 'result', result
    end

    # Exception recording is handled automatically by OpenTelemetry's in_span method
  end

  describe 'client integration with mock OpenTelemetry' do
    before do
      clear_tracer_cache
      @mock_tracer = MockOpenTelemetry::MockTracer.new
      @mock_provider = MockOpenTelemetry::MockTracerProvider.new(@mock_tracer)

      Object.const_set(:OpenTelemetry, Module.new) unless defined?(OpenTelemetry)
      mock_provider = @mock_provider
      OpenTelemetry.define_singleton_method(:tracer_provider) { mock_provider }

      unless defined?(OpenTelemetry::Trace::Status)
        OpenTelemetry.const_set(:Trace, Module.new)
        OpenTelemetry::Trace.const_set(:Status, MockOpenTelemetry::MockStatus)
      end
    end

    after do
      clear_tracer_cache
      Object.send(:remove_const, :OpenTelemetry) if defined?(OpenTelemetry)
    end

    describe 'server.address and server.port attributes' do
      it 'splits server.address and server.port for TCP servers' do
        memcached_persistent(:meta) do |dc|
          dc.set('otel_test', 'value')

          span = @mock_tracer.spans.last

          assert_kind_of String, span.attributes['server.address']
          refute_nil span.attributes['server.port']
          assert_kind_of Integer, span.attributes['server.port']
          refute_includes span.attributes['server.address'], ':'
        end
      end

      it 'uses socket path for server.address on Unix sockets and omits server.port' do
        memcached_persistent(:meta, MemcachedMock::UNIX_SOCKET_PATH) do |dc|
          dc.set('otel_unix_test', 'value')

          span = @mock_tracer.spans.last

          assert span.attributes['server.address'].start_with?('/')
          assert_nil span.attributes['server.port']
        end
      end
    end

    describe 'db.query.text attribute' do
      it 'includes full key text when otel_db_statement is :include' do
        memcached_persistent(:meta, 21_345, '', otel_db_statement: :include) do |dc|
          dc.set('mykey', 'value')

          span = @mock_tracer.spans.last

          assert_equal 'set mykey', span.attributes['db.query.text']
        end
      end

      it 'obfuscates key when otel_db_statement is :obfuscate' do
        memcached_persistent(:meta, 21_345, '', otel_db_statement: :obfuscate) do |dc|
          dc.set('mykey', 'value')

          span = @mock_tracer.spans.last

          assert_equal 'set ?', span.attributes['db.query.text']
        end
      end

      it 'omits db.query.text by default' do
        memcached_persistent(:meta) do |dc|
          dc.set('mykey', 'value')

          span = @mock_tracer.spans.last

          assert_nil span.attributes['db.query.text']
        end
      end

      it 'includes multiple keys for set_multi with :include' do
        memcached_persistent(:meta, 21_345, '', otel_db_statement: :include) do |dc|
          dc.set_multi({ 'key1' => 'v1', 'key2' => 'v2' })

          span = @mock_tracer.spans.last
          text = span.attributes['db.query.text']

          assert_includes text, 'set_multi'
          assert_includes text, 'key1'
          assert_includes text, 'key2'
        end
      end

      it 'includes keys for get_multi with :include' do
        memcached_persistent(:meta, 21_345, '', otel_db_statement: :include) do |dc|
          dc.set('gm1', 'v1')
          dc.set('gm2', 'v2')
          @mock_tracer.spans.clear

          dc.get_multi('gm1', 'gm2')

          span = @mock_tracer.spans.first
          text = span.attributes['db.query.text']

          assert_includes text, 'get_multi'
          assert_includes text, 'gm1'
          assert_includes text, 'gm2'
        end
      end

      it 'includes keys for delete_multi with :include' do
        memcached_persistent(:meta, 21_345, '', otel_db_statement: :include) do |dc|
          dc.set('dm1', 'v1')
          dc.set('dm2', 'v2')
          @mock_tracer.spans.clear

          dc.delete_multi(%w[dm1 dm2])

          span = @mock_tracer.spans.last
          text = span.attributes['db.query.text']

          assert_includes text, 'delete_multi'
          assert_includes text, 'dm1'
          assert_includes text, 'dm2'
        end
      end
    end

    describe 'peer.service attribute' do
      it 'includes peer.service when otel_peer_service is configured' do
        memcached_persistent(:meta, 21_345, '', otel_peer_service: 'my-cache') do |dc|
          dc.set('ps_test', 'value')

          span = @mock_tracer.spans.last

          assert_equal 'my-cache', span.attributes['peer.service']
        end
      end

      it 'omits peer.service by default' do
        memcached_persistent(:meta) do |dc|
          dc.set('ps_test', 'value')

          span = @mock_tracer.spans.last

          assert_nil span.attributes['peer.service']
        end
      end
    end

    describe 'get_with_metadata includes server attributes' do
      it 'includes server.address and server.port' do
        memcached_persistent(:meta) do |dc|
          dc.set('meta_test', 'value')
          @mock_tracer.spans.clear

          dc.get_with_metadata('meta_test')

          span = @mock_tracer.spans.last

          assert_equal 'get_with_metadata', span.name
          assert_equal 'get_with_metadata', span.attributes['db.operation.name']
          refute_nil span.attributes['server.address']
          refute_nil span.attributes['server.port']
        end
      end
    end

    describe 'fetch_with_lock includes server attributes' do
      it 'includes server.address and server.port' do
        memcached_persistent(:meta) do |dc|
          @mock_tracer.spans.clear

          dc.fetch_with_lock('lock_test', ttl: 300, lock_ttl: 30) { 'computed' }

          span = @mock_tracer.spans.first

          assert_equal 'fetch_with_lock', span.name
          assert_equal 'fetch_with_lock', span.attributes['db.operation.name']
          refute_nil span.attributes['server.address']
          refute_nil span.attributes['server.port']
        end
      end
    end

    describe 'stable semantic convention attribute names' do
      it 'uses db.operation.name instead of db.operation' do
        memcached_persistent(:meta) do |dc|
          dc.get('nonexistent')

          span = @mock_tracer.spans.last

          assert_equal 'get', span.attributes['db.operation.name']
          assert_nil span.attributes['db.operation']
        end
      end

      it 'uses db.system.name instead of db.system' do
        memcached_persistent(:meta) do |dc|
          dc.get('nonexistent')

          span = @mock_tracer.spans.last

          assert_equal 'memcached', span.attributes['db.system.name']
          assert_nil span.attributes['db.system']
        end
      end
    end
  end
end