opentelemetry-instrumentation-trilogy 0.56.3 → 0.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7aa67e08b66f73cd642d5dcaa13122c6c9639b50c35eb224a0978c73c9be1e7
-  data.tar.gz: 014a7d026c44f924a08e81d0c25d42132a114199efafa929aa1172786953fae7
+  metadata.gz: 9f429627ce071719d113b276014d9a29a1fb62ac80f6642bb5539b4af00492fb
+  data.tar.gz: 991fc47cc5ad5035472afd2e63979c88439a1cf8ef267d4b49284bc91f05fa3a
 SHA512:
-  metadata.gz: 7e4b68e200cae859e0117b0ee57e13c79946c52b0231e2a1a3476d43ddc1c6dda637c6af6556e805e2f66e378e92bb8a352c84ca586e6bc24939e32ca3740ae0
-  data.tar.gz: 48a2bc454a232c530d72221ae134b71a3874ee83cd078ce35dd45c3fd9c16f52f76112e555e671333eb9e60a7a3dc4853c7b1bfae26fecefaa705bc1bf45e29c
+  metadata.gz: 73586de29d6e371b1b6e7ccad39c02a98f2f5a25874a051e4b1a746656d600b19ccf72cd7162463a5b990e72b036a5a359574e9470afaf6a88996eed4f5bad7c
+  data.tar.gz: 6128893e616a10574686b3c7968bbf7f0659fcfdd5ce89564c0fc2c47b2d33d71c1c92f2a83e23e0888833a0d5a92e09ca69ea585a6c8acd81269049ecd40f87

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History: opentelemetry-instrumentation-trilogy
 
+### v0.58.0 / 2024-01-06
+
+* BREAKING CHANGE: Change db.mysql.instance.address to db.instance.id
+
+* ADDED: Change db.mysql.instance.address to db.instance.id
+* FIXED: Trilogy only set db.instance.id attribute if there is a value
+
+### v0.57.0 / 2023-10-27
+
+* ADDED: Instrument connect and ping
+
 ### v0.56.3 / 2023-08-03
 
 * FIXED: Remove inline linter rules

data/README.md

@@ -51,6 +51,19 @@ OpenTelemetry::Instrumentation::Trilogy.with_attributes('pizzatoppings' => 'mush
 end
 ```
 
+## Semantic Conventions
+
+This instrumentation generally uses [Database semantic conventions](https://opentelemetry.io/docs/specs/semconv/database/database-spans/).
+
+| Attribute Name | Type | Notes |
+| - | - | - |
+| `db.instance.id` | String | The name of the DB host executing the query e.g. `SELECT @@hostname` |
+| `db.name` | String | The name of the database from connection_options |
+| `db.statement` | String | SQL statement being executed |
+| `db.user` | String | The username from connection_options |
+| `db.system` | String | `mysql` |
+| `net.peer.name` | String | The name of the remote host from connection_options |
+
 ## 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/patches/client.rb

@@ -48,6 +48,28 @@ module OpenTelemetry
 
           FULL_SQL_REGEXP = Regexp.union(MYSQL_COMPONENTS.map { |component| COMPONENTS_REGEX_MAP[component] })
 
+          def initialize(options = {})
+            @connection_options = options # This is normally done by Trilogy#initialize
+
+            tracer.in_span(
+              'connect',
+              attributes: client_attributes.merge!(OpenTelemetry::Instrumentation::Trilogy.attributes),
+              kind: :client
+            ) do
+              super
+            end
+          end
+
+          def ping(...)
+            tracer.in_span(
+              'ping',
+              attributes: client_attributes.merge!(OpenTelemetry::Instrumentation::Trilogy.attributes),
+              kind: :client
+            ) do
+              super
+            end
+          end
+
           def query(sql)
             tracer.in_span(
               database_span_name(sql),
@@ -60,22 +82,24 @@ module OpenTelemetry
 
           private
 
-          def client_attributes(sql)
+          def client_attributes(sql = nil)
             attributes = {
               ::OpenTelemetry::SemanticConventions::Trace::DB_SYSTEM => 'mysql',
-              ::OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => connection_options.fetch(:host, 'unknown sock')
+              ::OpenTelemetry::SemanticConventions::Trace::NET_PEER_NAME => connection_options&.fetch(:host, 'unknown sock') || 'unknown sock'
             }
 
             attributes[::OpenTelemetry::SemanticConventions::Trace::DB_NAME] = database_name if database_name
             attributes[::OpenTelemetry::SemanticConventions::Trace::DB_USER] = database_user if database_user
             attributes[::OpenTelemetry::SemanticConventions::Trace::PEER_SERVICE] = config[:peer_service] unless config[:peer_service].nil?
-            attributes['db.mysql.instance.address'] = @connected_host if defined?(@connected_host)
-
-            case config[:db_statement]
-            when :obfuscate
-              attributes[::OpenTelemetry::SemanticConventions::Trace::DB_STATEMENT] = obfuscate_sql(sql)
-            when :include
-              attributes[::OpenTelemetry::SemanticConventions::Trace::DB_STATEMENT] = sql
+            attributes['db.instance.id'] = @connected_host unless @connected_host.nil?
+
+            if sql
+              case config[:db_statement]
+              when :obfuscate
+                attributes[::OpenTelemetry::SemanticConventions::Trace::DB_STATEMENT] = obfuscate_sql(sql)
+              when :include
+                attributes[::OpenTelemetry::SemanticConventions::Trace::DB_STATEMENT] = sql
+              end
             end
 
             attributes

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module Trilogy
-      VERSION = '0.56.3'
+      VERSION = '0.58.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-trilogy
 version: !ruby/object:Gem::Version
-  version: 0.56.3
+  version: 0.58.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-03 00:00:00.000000000 Z
+date: 2024-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.55.1
+        version: 1.59.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.55.1
+        version: 1.59.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -240,20 +254,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: yard-doctest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.6
 description: Adds auto instrumentation that includes SQL metadata
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -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.56.3/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-trilogy/0.58.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.56.3
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-trilogy/0.58.0
 post_install_message: 
 rdoc_options: []
 require_paths: