opentelemetry-instrumentation-pg 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c17d678538a40a8e89380dfd35e69c42ca123214469f2b9f1d0acfff40b56053
-  data.tar.gz: 2cb6540eee8ce5308f2403a22f84e11262f4db768face759a1459960795822e0
+  metadata.gz: d58f12ed858f82af3aa55e4c2962706477dcfcb72bfc4d16daab6366dc1abeee
+  data.tar.gz: d00d8d3ada02014905b0c91621f69734e859d27ad01f8d7b097ce4ce89eb70dc
 SHA512:
-  metadata.gz: 2aff8b3172336c6835fe619fc008ec9eaa3ec1a8d80adec949b199fc8dd21364a6ffd97d4410f3bc4dfa009820c519b9ce0e5ba69ffe5a267bc4bfa203046017
-  data.tar.gz: 5dcef18383237d99a30f6769cf9f49b34794eb7acca720fbb5fc56b8164b22506c3d1891e09b584554b5a5414ca2788e0568d7b8c05f6cafee76a985a4c7c08e
+  metadata.gz: f2478f862fa99d49340c803410bca43091a26dd02bb522090eb405be01ae5855b2cbe8c57836d6c244e8aa198b4ece17e60dc6bf12116c10abde250d91e4fb2e
+  data.tar.gz: 83494bdc37be6ae03813c323946b56ad5f007759d0db96971a3813f013403edd4535f80f7c2f610329b5c4b119bdbf5e9cc038323ff2ef4c13763bfc0d0947ba

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-pg
 
+### v0.22.0 / 2022-10-04
+
+* ADDED: Add `with_attributes` context propagation for PG instrumentation 
+
 ### v0.21.0 / 2022-06-09
 
 * Upgrading Base dependency version

data/README.md

@@ -30,6 +30,17 @@ OpenTelemetry::SDK.configure do |c|
 end
 ```
 
+The `PG` instrumentation allows the user to supply additional attributes via the `with_attributes` method. This makes it possible to supply additional attributes on PG spans. Attributes supplied in `with_attributes` supersede those automatically generated within `PG`'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/pg'
+
+conn = PG::Connection.open(host: "localhost", user: "root", dbname: "postgres")
+OpenTelemetry::Instrumentation::PG.with_attributes('pizzatoppings' => 'mushrooms') do
+  conn.exec("SELECT 1")
+end
+```
+
 ### Configuration options
 
 ```ruby
@@ -49,7 +60,7 @@ end
 
 ## Examples
 
-An example of usage can be seen in [`example/pg.rb`](https://github.com/open-telemetry/opentelemetry-ruby/blob/main/instrumentation/pg/example/pg.rb).
+An example of usage can be seen in [`example/pg.rb`](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/pg/example/pg.rb).
 
 ## How can I get involved?
 
@@ -64,7 +75,7 @@ The `opentelemetry-instrumentation-pg` gem is distributed under the Apache 2.0 l
 [pg-home]: https://github.com/ged/ruby-pg
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/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/pg/patches/connection.rb

@@ -66,7 +66,7 @@ module OpenTelemetry
           # But, getting that metric in line would force us over the
           # module size limit! We can't win here unless we want to start
           # abstracting things into a million pieces.
-          def span_attrs(kind, *args) # rubocop:disable Metrics/AbcSize
+          def span_attrs(kind, *args)
             if kind == :query
               operation = extract_operation(args[0])
               sql = obfuscate_sql(args[0]).to_s
@@ -85,6 +85,7 @@ module OpenTelemetry
 
             attrs = { 'db.operation' => validated_operation(operation), 'db.postgresql.prepared_statement_name' => statement_name }
             attrs['db.statement'] = sql unless config[:db_statement] == :omit
+            attrs.merge!(OpenTelemetry::Instrumentation::PG.attributes)
             attrs.reject! { |_, v| v.nil? }
 
             [span_name(operation), client_attributes.merge(attrs)]

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module PG
-      VERSION = '0.21.0'
+      VERSION = '0.22.0'
     end
   end
 end

data/lib/opentelemetry/instrumentation/pg.rb

@@ -11,6 +11,35 @@ module OpenTelemetry
   module Instrumentation
     # Contains the OpenTelemetry instrumentation for the Pg gem
     module PG
+      extend self
+
+      CURRENT_ATTRIBUTES_KEY = Context.create_key('pg-attributes-hash')
+
+      private_constant :CURRENT_ATTRIBUTES_KEY
+
+      # Returns the attributes hash representing the postgres client 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
+
+      # 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-pg
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.73.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -239,14 +239,14 @@ files:
 - lib/opentelemetry/instrumentation/pg/lru_cache.rb
 - lib/opentelemetry/instrumentation/pg/patches/connection.rb
 - lib/opentelemetry/instrumentation/pg/version.rb
-homepage: https://github.com/open-telemetry/opentelemetry-ruby
+homepage: https://github.com/open-telemetry/opentelemetry-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-pg/v0.21.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/pg
-  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-pg/v0.21.0
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-pg/v0.22.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/pg
+  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-pg/v0.22.0
 post_install_message: 
 rdoc_options: []
 require_paths: