opentelemetry-instrumentation-trilogy 0.51.1 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6241d5ba63c7c5865f7cf548d39aa770f596aeb2c4ee2afecb7cdfa9c49c717
-  data.tar.gz: 1bfd9359a9a17b6e964a5bb820ca97edecfe68c9881bd7ff22ebadb2c969ae9e
+  metadata.gz: 98394ad5f8a94bbc13c06521d80b89c761ec59de025cc0af41d855a13491be86
+  data.tar.gz: d35aa0062e3deefde1a080ae6b49f9d9d2f4fe243c25ac8058901f04a222f93f
 SHA512:
-  metadata.gz: 620b27ac8992366fc522a232c679cc1065b31e2dd3919f922b1e55552f71e23390745242a18f31d25d84876211d216759e2275ff272f25ba8dbe660259287183
-  data.tar.gz: b651e768889aa07c3871516fb12eae564457c5c896f49ed861218a09ed405fab8707b67e61b906ab249d2cdd5a4ab2d420565a6ae453fe9c1f6544300b915831
+  metadata.gz: c12b338b919be130784c76b0d26195d96717115b333c2acfac2b2463fb3ba4f2d33a56735e55d48b44e772c15fc3d6e2a684f4aebf03383d1df3e78b4fb3f061
+  data.tar.gz: 11a064a8f1215e110cf16920dea54dc068a0d72911f7815db21113e9cf423f677bfb3773cab379cedb49255ad2ec70ce03bdf4ac541cc704556608e9affb3dc6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History: opentelemetry-instrumentation-trilogy
 
+### v0.52.0 / 2023-03-06
+
+* ADDED: Add with_attributes context propagation to Trilogy instrumentation 
+* ADDED: Add option to configure span name for trilogy 
+* FIXED: Ensure encoding errors handled during SQL obfuscation for Trilogy 
+
 ### v0.51.1 / 2023-01-14
 
 * DOCS: Fix gem homepage 

data/README.md

@@ -40,6 +40,17 @@ OpenTelemetry::SDK.configure do |c|
 end
 ```
 
+The `trilogy` instrumentation allows the user to supply additional attributes via the `with_attributes` method. This makes it possible to supply additional attributes on trilogy spans. Attributes supplied in `with_attributes` supersede those automatically generated within `trilogy`'s automatic instrumentation. If you supply a `db.statement` attribute in `with_attributes`, this library's `:db_statement` configuration will not be applied.
+
+```ruby
+require 'opentelemetry-instrumentation-trilogy'
+
+client = Trilogy.new(:host => 'localhost', :username => 'root')
+OpenTelemetry::Instrumentation::Trilogy.with_attributes('pizzatoppings' => 'mushrooms') do
+  client.query('SELECT 1')
+end
+```
+
 ## How can I get involved?
 
 The `opentelemetry-instrumentation-trilogy` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.

data/lib/opentelemetry/instrumentation/trilogy/instrumentation.rb

@@ -24,6 +24,7 @@ module OpenTelemetry
 
         option :peer_service, default: nil, validate: :string
         option :db_statement, default: :obfuscate, validate: %I[omit include obfuscate]
+        option :span_name, default: :statement_type, validate: %I[statement_type db_name db_operation_and_name]
 
         private
 

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

@@ -56,7 +56,7 @@ module OpenTelemetry
           def query(sql)
             tracer.in_span(
               database_span_name(sql),
-              attributes: client_attributes(sql),
+              attributes: client_attributes(sql).merge!(OpenTelemetry::Instrumentation::Trilogy.attributes),
               kind: :client
             ) do
               super(sql)
@@ -87,10 +87,14 @@ module OpenTelemetry
             if sql.size > 2000
               'SQL query too large to remove sensitive data ...'
             else
-              obfuscated = sql.gsub(FULL_SQL_REGEXP, '?')
+              obfuscated = OpenTelemetry::Common::Utilities.utf8_encode(sql, binary: true)
+              obfuscated = obfuscated.gsub(FULL_SQL_REGEXP, '?')
               obfuscated = 'Failed to obfuscate SQL query - quote characters remained after obfuscation' if detect_unmatched_pairs(obfuscated)
               obfuscated
             end
+          rescue StandardError => e
+            OpenTelemetry.handle_error(message: 'Failed to obfuscate SQL', exception: e)
+            'OpenTelemetry error: failed to obfuscate sql'
           end
 
           def detect_unmatched_pairs(obfuscated)
@@ -102,20 +106,27 @@ module OpenTelemetry
             %r{'|"|\/\*|\*\/}.match(obfuscated)
           end
 
-          def database_span_name(sql)
-            # Setting span name to the SQL query without obfuscation would
-            # result in PII + cardinality issues.
-            # First attempt to infer the statement type then fallback to
-            # current Otel approach {database.component_name}.{database_instance_name}
-            # https://github.com/open-telemetry/opentelemetry-python/blob/39fa078312e6f41c403aa8cad1868264011f7546/ext/opentelemetry-ext-dbapi/tests/test_dbapi_integration.py#L53
-            # This creates span names like mysql.default, mysql.replica, postgresql.staging etc.
-
-            statement_type = extract_statement_type(sql)
-
-            return statement_type unless statement_type.nil?
+          def database_span_name(sql) # rubocop:disable Metrics/CyclomaticComplexity
+            case config[:span_name]
+            when :statement_type
+              extract_statement_type(sql)
+            when :db_name
+              database_name
+            when :db_operation_and_name
+              op = OpenTelemetry::Instrumentation::Trilogy.attributes['db.operation']
+              name = database_name
+              if op && name
+                "#{op} #{name}"
+              elsif op
+                op
+              elsif name
+                name
+              end
+            end || 'mysql'
+          end
 
-            # fallback
-            'mysql'
+          def database_name
+            connection_options[:database]
           end
 
           def net_peer_name
@@ -140,6 +151,7 @@ module OpenTelemetry
             QUERY_NAME_RE.match(sql) { |match| match[1].downcase } unless sql.nil?
           rescue StandardError => e
             OpenTelemetry.logger.error("Error extracting sql statement type: #{e.message}")
+            nil
           end
         end
       end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Trilogy
-      VERSION = '0.51.1'
+      VERSION = '0.52.0'
     end
   end
 end

data/lib/opentelemetry/instrumentation/trilogy.rb

@@ -11,6 +11,45 @@ module OpenTelemetry
   module Instrumentation
     # Contains the OpenTelemetry instrumentation for the Trilogy gem
     module Trilogy
+      extend self
+
+      CURRENT_ATTRIBUTES_KEY = Context.create_key('trilogy-attributes-hash')
+
+      private_constant :CURRENT_ATTRIBUTES_KEY
+
+      # Returns the attributes hash representing the Trilogy context found
+      # in the optional context or the current context if none is provided.
+      #
+      # @param [optional Context] context The context to lookup the current
+      #   attributes hash. Defaults to Context.current
+      def attributes(context = nil)
+        context ||= Context.current
+        context.value(CURRENT_ATTRIBUTES_KEY) || {}
+      end
+
+      # Returns a context containing the merged attributes hash, derived from the
+      # optional parent context, or the current context if one was not provided.
+      #
+      # @param [optional Context] context The context to use as the parent for
+      #   the returned context
+      def context_with_attributes(attributes_hash, parent_context: Context.current)
+        attributes_hash = attributes(parent_context).merge(attributes_hash)
+        parent_context.set_value(CURRENT_ATTRIBUTES_KEY, attributes_hash)
+      end
+
+      # Activates/deactivates the merged attributes hash within the current Context,
+      # which makes the "current attributes hash" available implicitly.
+      #
+      # On exit, the attributes hash that was active before calling this method
+      # will be reactivated.
+      #
+      # @param [Span] span the span to activate
+      # @yield [Hash, Context] yields attributes hash and a context containing the
+      #   attributes hash to the block.
+      def with_attributes(attributes_hash)
+        attributes_hash = attributes.merge(attributes_hash)
+        Context.with_value(CURRENT_ATTRIBUTES_KEY, attributes_hash) { |c, h| yield h, c }
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-trilogy
 version: !ruby/object:Gem::Version
-  version: 0.51.1
+  version: 0.52.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-14 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -275,10 +275,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-trilogy/0.51.1/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-trilogy/0.52.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/trilogy
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-trilogy/0.51.1
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-trilogy/0.52.0
 post_install_message: 
 rdoc_options: []
 require_paths: