opentelemetry-instrumentation-redis 0.10.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a93d653f708181eb2444eb61c70e36aa2952af1feed88bc51b577a13b8ceeba
-  data.tar.gz: 2c7d4e6502891c82db5ca55a9a0f741818e00bff1146dcd265fb8730df44e4bf
+  metadata.gz: b3ed1b8c5e5325161458aacff91c98222a5d8725ca4553e1b4014abadf1c01cd
+  data.tar.gz: df6b178a826a281cd6b1487860a45dfa08e92b411f40691855d9a79babd98e43
 SHA512:
-  metadata.gz: '01946188e0f89d528e359eede3796d87928882b60861b84e9759f812b140ea300c60f4527be595d947fb648095cbe57c9a9a7e7dec6e3614afb5b1a47625815b'
-  data.tar.gz: 37adb69dca5235cdd89fe6363d159fddd365dc3a5186e7dc764f44208231758e3d9a3cf23e8cd55fb1eabf5d4f98e805ab6917907eb07642a42b30e2cf37d823
+  metadata.gz: 29254b91daef97db3703e96d84f1bd44ae6229cf5db558a5a7d5e48b4322b3cf987eece0826a1565c978202e241194690c04a2152ee8bdb898ef54189e046a24
+  data.tar.gz: 223ba45f7b5a1ed4d975418b58487d45400394fcf215f2c2e16c7941eb2c5514280fbd7e7bfbede9812cc94c2e8987b3e3e40766a9ecb70072cb305a8e33ac40

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Release History: opentelemetry-instrumentation-redis
 
+### v0.15.0 / 2021-02-18
+
+* ADDED: Add instrumentation config validation 
+
+### v0.14.0 / 2021-02-03
+
+* (No significant changes)
+
+### v0.13.0 / 2021-01-29
+
+* (No significant changes)
+
+### v0.12.0 / 2020-12-24
+
+* (No significant changes)
+
+### v0.11.0 / 2020-12-11
+
+* ADDED: Accept config for redis peer service attribute 
+* ADDED: Move utf8 encoding to common utils 
+* FIXED: Copyright comments to not reference year 
+
 ### v0.10.1 / 2020-12-09
 
 * FIXED: Semantic conventions db.type -> db.system 

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 OpenTelemetry Authors
+   Copyright The OpenTelemetry Authors
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -43,7 +43,7 @@ end
 
 ## Example
 
-An example of usage can be seen in [`example/redis.rb`](https://github.com/open-telemetry/opentelemetry-ruby/blob/master/instrumentation/redis/example/redis.rb).
+An example of usage can be seen in [`example/redis.rb`](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/redis/example/redis.rb).
 
 ## How can I get involved?
 
@@ -58,7 +58,7 @@ Apache 2.0 license. See [LICENSE][license-github] for more information.
 [redis-home]: https://redis.io
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/master/LICENSE
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
 [ruby-gitter]: https://gitter.im/open-telemetry/opentelemetry-ruby

data/lib/opentelemetry-instrumentation-redis.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 

data/lib/opentelemetry/instrumentation/redis.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
 require 'opentelemetry'
+require 'opentelemetry/common'
 
 module OpenTelemetry
   module Instrumentation

data/lib/opentelemetry/instrumentation/redis/instrumentation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -19,6 +19,8 @@ module OpenTelemetry
           defined?(::Redis)
         end
 
+        option :peer_service, default: nil, validate: :string
+
         private
 
         def require_dependencies

data/lib/opentelemetry/instrumentation/redis/patches/client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -48,18 +48,24 @@ module OpenTelemetry
             host = options[:host]
             port = options[:port]
 
-            OpenTelemetry::Instrumentation::Redis.attributes.merge(
+            attributes = {
               'db.system' => 'redis',
               'db.instance' => options[:db].to_s,
               'db.url' => "redis://#{host}:#{port}",
               'net.peer.name' => host,
               'net.peer.port' => port
-            )
+            }
+            attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+            attributes.merge(OpenTelemetry::Instrumentation::Redis.attributes)
           end
 
           def tracer
             Redis::Instrumentation.instance.tracer
           end
+
+          def config
+            Redis::Instrumentation.instance.config
+          end
         end
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -11,7 +11,6 @@ module OpenTelemetry
       module Utils
         extend self
 
-        STRING_PLACEHOLDER = ''.encode(::Encoding::UTF_8).freeze
         PLACEHOLDER = '?'
         VALUE_MAX_LEN = 50
         CMD_MAX_LEN = 500
@@ -36,7 +35,7 @@ module OpenTelemetry
 
         def format_arg(arg)
           str = arg.is_a?(Symbol) ? arg.to_s.upcase : arg.to_s
-          str = utf8_encode(str, binary: true, placeholder: PLACEHOLDER)
+          str = OpenTelemetry::Common::Utilities.utf8_encode(str, binary: true)
           truncate(str, VALUE_MAX_LEN)
         rescue StandardError => e
           OpenTelemetry.logger.debug("non formattable Redis arg #{str}: #{e}")
@@ -60,24 +59,6 @@ module OpenTelemetry
         def truncate(string, size)
           string.size > size ? "#{string[0...size - 3]}..." : string
         end
-
-        def utf8_encode(str, options = {})
-          str = str.to_s
-
-          if options[:binary]
-            # This option is useful for "gracefully" displaying binary data that
-            # often contains text such as marshalled objects
-            str.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
-          elsif str.encoding == ::Encoding::UTF_8
-            str
-          else
-            str.encode(::Encoding::UTF_8)
-          end
-        rescue StandardError => e
-          OpenTelemetry.logger.debug("Error encoding string in UTF-8: #{e}")
-
-          options.fetch(:placeholder, STRING_PLACEHOLDER)
-        end
       end
     end
   end

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-# Copyright 2020 OpenTelemetry Authors
+# Copyright The OpenTelemetry Authors
 #
 # SPDX-License-Identifier: Apache-2.0
 
 module OpenTelemetry
   module Instrumentation
     module Redis
-      VERSION = '0.10.1'
+      VERSION = '0.15.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-redis
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.15.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -186,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-redis/v0.10.1/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/master/instrumentation/redis
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.15.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/redis
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.10.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-redis/v0.15.0
 post_install_message: 
 rdoc_options: []
 require_paths: