redis-instrumentation 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d04217feb47f5d217db782cf7636e61fb9b91dd
-  data.tar.gz: dd50b32ff96d43ade45d29183dc2fee532abc2e6
+SHA256:
+  metadata.gz: b8eab7cfc0b5e410c65e7140d1a3ccc5f959ac30fe3b63f651cede6dc244b946
+  data.tar.gz: 33a4dfcf246154419ff92198a5c5586f1bcdbb00bf3a7cc3a1442054070a7239
 SHA512:
-  metadata.gz: 396b6c3bff9aa492ca40d9a6675c357d9a1b4ee4429ba3dfb53a5375d999c1b1c8ad0126b5912fbb887b288889d7b328aff4008e52c31b447b52db8bab5096e1
-  data.tar.gz: 89795a5a9457dcfdbfb50af35efd28697745908ae6d28db686d43a34cd610b0ad4fe7701e5226d61cbc70b4d9abee4603e5e0d6a5bd21069a14b1462626e784d
+  metadata.gz: 00a5db36b910cf3887c59aaff692130e9af5108e46c54114caf1d2917a80e3792b6227d1366be945cae50fb9fde29b7187f31709a03feb98201851c92bc25eff
+  data.tar.gz: b59526825e138da5a409fe62a351966ac2d83be7f130a380850dcf6e85819a6a4c195cfdc1b441b6cc39697658ff2daa33af996ba888563448ea9f8e059a677f

data/README.md

@@ -31,8 +31,9 @@ require 'redis/instrumentation'
 Redis::Instrumentation.instrument
 ```
 
-`instrument` takes an optional argument, `tracer`, to set a custom OpenTracing
-tracer. It will default to `OpenTracing.global_tracer`.
+`instrument` takes two optional arguments:
+* `tracer`, to set a custom OpenTracing tracer. It will default to `OpenTracing.global_tracer`.
+* `db_statement_length`, to set a maximum value length for the `db.statement` tag.  It will not truncate by default.
 
 ## Development
 

data/lib/redis/instrumentation.rb

@@ -14,8 +14,10 @@ class Redis
     class << self
 
       attr_accessor :tracer
+      attr_accessor :db_statement_length
 
-      def instrument(tracer: OpenTracing.global_tracer)
+      def instrument(tracer: OpenTracing.global_tracer,
+                     db_statement_length: nil)
         begin
           require 'redis'
         rescue LoadError => e
@@ -23,6 +25,7 @@ class Redis
         end
 
         @tracer = tracer
+        @db_statement_length = db_statement_length
 
         patch_client if !@patched_client
         @patched_client = true
@@ -35,7 +38,9 @@ class Redis
 
           def call(command, trace: true, &block)
             tags = ::Redis::Instrumentation::COMMON_TAGS.dup
-            tags['db.statement'] = command.join(' ')
+            statement = command.join(' ')
+            statement = statement.to_s[0, ::Redis::Instrumentation::db_statement_length] if ::Redis::Instrumentation::db_statement_length
+            tags['db.statement'] = statement
             tags['db.instance'] = db
             tags['peer.address'] = "redis://#{host}:#{port}"
 
@@ -46,7 +51,7 @@ class Redis
           rescue => e
             if scope
               scope.span.set_tag("error", true)
-              scope.span.log_kv(key: "message", value: e.message)
+              scope.span.log_kv("error.kind": e.class.name, message: e.message, "error.object": e)
             end
             raise e
           ensure
@@ -56,7 +61,9 @@ class Redis
           def call_pipeline(pipeline)
             commands = pipeline.commands
             tags = ::Redis::Instrumentation::COMMON_TAGS.dup
-            tags['db.statement'] = commands.empty? ? "" : commands.map{ |arr| arr.join(' ') }.join(', ')
+            statement = commands.empty? ? "" : commands.map{ |arr| arr.join(' ') }.join(', ')
+            statement = statement.to_s[0, ::Redis::Instrumentation::db_statement_length] if ::Redis::Instrumentation::db_statement_length
+            tags['db.statement'] = statement
             tags['db.instance'] = db
             tags['peer.address'] = "redis://#{host}:#{port}"
 
@@ -66,7 +73,7 @@ class Redis
           rescue => e
             if scope
               scope.span.set_tag("error", true)
-              scope.span.log_kv(key: "message", value: e.message)
+              scope.span.log_kv("error.kind": e.class.name, message: e.message, "error.object": e)
             end
             raise e
           ensure

data/lib/redis/instrumentation/version.rb

@@ -1,3 +1,3 @@
 module RedisInstrumentation
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - SignalFx, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-14 00:00:00.000000000 Z
+date: 2020-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentracing
@@ -145,8 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: OpenTracing instrumentation for the Redis Ruby client.