opentelemetry-instrumentation-dalli 0.19.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a03bb39395524af8921632daeed21a0b8f9683051a4c3ce26f828a9b90f218a2
-  data.tar.gz: 2f71e04fc5e8c8fe70b5cbec2271d27fe1b229e768e246167ab1b7aa2468dbfa
+  metadata.gz: c7db76142dadc45f67291aee6d863f69f852043d2fa2f8f41243f339f5ccef77
+  data.tar.gz: d592877e112281e939d18d3b89e819142a48d5fd1a389946bb65079499760db4
 SHA512:
-  metadata.gz: bab5523d76836212672a88df71a6b880fe4cd001413889d8ad7e6cd5d217b65023c01e854ce4a72a54079e4bc624520499a5fcc8aa34efb8caab7959068d5dcf
-  data.tar.gz: 0222dc555abaa399a720d5996317a3fd93a09e55d0991164e64d3fc03b99177738576d284cc88aba5efd823f31342b9549101a8f4f24a102dbdccdd9be3fb81c
+  metadata.gz: 7f7a666b3a4cda1882e36c9de578192729c4345639c7ac9e3cdcf14dd2da33f39d62a4ba84f39738600b62e7a061d0cd661f17fefdab25d93c4623315873db33
+  data.tar.gz: 742b4191641ef4acceee51ba9eda176b61f9980f05acd375416c7ddb4fca3b3083be30b7a951189315b58820c88d4e29f2054c702aabf75a5b0f02c5c05d9a5b

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Release History: opentelemetry-instrumentation-dalli
 
+### v0.22.0 / 2022-06-09
+
+* Upgrading Base dependency version
+* FIXED: Broken test file requirements 
+
+### 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)

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.1'
+      VERSION = '0.22.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.1
+  version: 0.22.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.2
+        version: 0.19.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.2
+        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.3
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.3
+        version: 0.21.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,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-test-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -200,10 +214,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.1/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-dalli/v0.22.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.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-dalli/v0.22.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -212,7 +226,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="