opentelemetry-instrumentation-dalli 0.19.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cceeeb7c1f582abcb6b3d6677c22f3b40a6ec72e71b4d4586754506d24e5b139
-  data.tar.gz: 59c779f3c5177014fe2f2ee94f78f3e37dce8bd77e1d595b99f1334da103710c
+  metadata.gz: 71c0594ea7e11a8d6a0ac1ef5a4d605783fe81b71c87dcb8f33b67f56cb221b3
+  data.tar.gz: 976be448e6529b4025dad1ff76dbe03f363b9da8941815a5a10f5b792175013e
 SHA512:
-  metadata.gz: 0e88fd339959b664fa8078ebca52d19cb37bb1628a71f462726d650e9a23fabf73ac28ec6a7ceec2ca34ac7889e23e5ad91dc9f7f582851fcbeb4e0a09f2f6a3
-  data.tar.gz: cf8dc30579dee9238af8c0e4dba61b24784c4512e440b926a9b4bafe508662c7be089af2032049bc9081411ec7ce3601f85162bd645bd8d995eb4c542262cf37
+  metadata.gz: 33eb692c99e9442f12a090832592edf0af40835c85feea7cf603a2b79f863e64e54c0bcc1bc84f84e2cd24ad168057d781d0799efd85cb057fed9c42a37e98a9
+  data.tar.gz: 0a9c6be5d04016ccfc28d5145cee50e78047f491148c8b3197e5ef8f76b326f296edf5c04bdfb6e1ac8c44c87b0a9bdf6638ed3a319c5baa6ff4c545fcf41c4b

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Release History: opentelemetry-instrumentation-dalli
 
+### v0.21.0 / 2022-05-02
+
+* ADDED: Validate Using Enums 
+
+### v0.20.0 / 2021-12-01
+
+* ADDED: Add dalli obfuscation for db_statement 
+* FIXED: Resolve Dalli::Server deprecation in 3.0+ 
+
+### v0.19.1 / 2021-09-29
+
+* (No significant changes)
+
 ### v0.19.0 / 2021-08-12
 
 * ADDED: Add configuration options for dalli 

data/lib/opentelemetry/instrumentation/dalli/instrumentation.rb

@@ -20,7 +20,7 @@ module OpenTelemetry
         end
 
         option :peer_service, default: nil, validate: :string
-        option :db_statement, default: :include, validate: ->(opt) { %I[omit include].include?(opt) }
+        option :db_statement, default: :include, validate: %I[omit obfuscate include]
 
         private
 
@@ -30,7 +30,11 @@ module OpenTelemetry
         end
 
         def add_patches
-          ::Dalli::Server.prepend(Patches::Server)
+          if Gem::Version.new(::Dalli::VERSION) < Gem::Version.new('3.0.0')
+            ::Dalli::Server.prepend(Patches::Server)
+          else
+            ::Dalli::Protocol::Binary.prepend(Patches::Server)
+          end
         end
       end
     end

data/lib/opentelemetry/instrumentation/dalli/patches/server.rb

@@ -8,7 +8,7 @@ module OpenTelemetry
   module Instrumentation
     module Dalli
       module Patches
-        # Module to prepend to Dalli::Server for instrumentation
+        # Module to prepend to Dalli::Server (or Dalli::Protocol::Binary in 3.0+) for instrumentation
         module Server
           def request(op, *args)
             operation = Utils.opname(op, multi?)
@@ -17,7 +17,12 @@ module OpenTelemetry
               'net.peer.name' => hostname,
               'net.peer.port' => port
             }
-            attributes['db.statement'] = Utils.format_command(operation, args) if config[:db_statement] == :include
+            if config[:db_statement] == :include
+              attributes['db.statement'] = Utils.format_command(operation, args)
+            elsif config[:db_statement] == :obfuscate
+              attributes['db.statement'] = "#{operation} ?"
+            end
+
             attributes['peer.service'] = config[:peer_service] if config[:peer_service]
             tracer.in_span(operation, attributes: attributes, kind: :client) do
               super

data/lib/opentelemetry/instrumentation/dalli/utils.rb

@@ -26,6 +26,13 @@ module OpenTelemetry
         'write_noop' => 'noop',
         'version' => 'version',
         'send_multiget' => 'getkq',
+        # TODO: add better support for PipelinedGetter
+        # In dalli 3.1, multiget has been refactored to use a more robust PipelinedGetter class.
+        # The `pipelined_get` method has been introduced to the Dalli::Server to support this new class.
+        # If PipelinedGetter makes instrumentation of multi operations easier, we should then migrate
+        # instrumentation to Dalli::Client, since it seems to be a more stable chokepoint.
+        # For now we're just ensuring we support this new Dalli::Server method.
+        'pipelined_get' => 'getkq',
         'append' => 'append',
         'prepend' => 'prepend',
         'stats' => 'stat',

data/lib/opentelemetry/instrumentation/dalli/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Dalli
-      VERSION = '0.19.0'
+      VERSION = '0.21.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-dalli
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.21.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.19.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.19.3
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +84,14 @@ dependencies:
   name: dalli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.rc1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -200,10 +200,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-dalli/v0.19.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-dalli/v0.21.0/file.CHANGELOG.html
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/dalli
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-dalli/v0.19.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-dalli/v0.21.0
 post_install_message: 
 rdoc_options: []
 require_paths: