opentelemetry-instrumentation-pg 0.17.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 722b3565568cfc7008142ab78fdffdb894b5e202bf950be9305fbd7df9ddf06e
+  data.tar.gz: 66d7e432e0b70239b64c6486fcf53c5d23c7dc8640ac0cc77a0adb151631d763
+SHA512:
+  metadata.gz: 7f4beb6dfb67adf122a82f66e4c4eb7f79dda5f14f56334546e44d0de848d5d7dbbcd96408b66b61d389e8f997be258d07346c4d77aeebc5d7e0b3f9d32a97d7
+  data.tar.gz: d0a2ee1ed362c63fbc653ec32bccb72fd162f1492c4d9e18e08bf13deea243c225fc4db46a7469c21afcc6a1f0eaf3cfcb7d6113df9e8aed3d4d691c9ad2bb91

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--title=OpenTelemetry PG Instrumentation
+--markup=markdown
+--main=README.md
+./lib/opentelemetry/instrumentation/**/*.rb
+./lib/opentelemetry/instrumentation.rb
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Release History: opentelemetry-instrumentation-pg
+
+### v0.17.1 / 2021-04-23
+
+* Initial release.
+* ADDED: Initial postgresql instrumentation

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   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.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,69 @@
+# OpenTelemetry PG Instrumentation
+
+The OpenTelemetry PG Ruby gem is a community maintained instrumentation for [PG][pg-home].
+
+## How do I get started?
+
+Install the gem using:
+
+```
+gem install opentelemetry-instrumentation-pg
+```
+
+Or, if you use [bundler][bundler-home], include `opentelemetry-instrumentation-pg` in your `Gemfile`.
+
+## Usage
+
+To use the instrumentation, call `use` with the name of the instrumentation:
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::PG'
+end
+```
+
+Alternatively, you can also call `use_all` to install all the available instrumentation.
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use_all
+end
+```
+
+### Configuration options
+
+```ruby
+OpenTelemetry::SDK.configure do |c|
+  c.use 'OpenTelemetry::Instrumentation::PG', {
+    # The obfuscation of SQL in the db.statement attribute is disabled by default.
+    # To enable, set enable_sql_obfuscation to true.
+    enable_sql_obfuscation: false,
+
+    # You may optionally set a value for 'peer.service', which
+    # will be included on all spans from this instrumentation:
+    peer_service: 'postgres:readonly',
+  }
+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).
+
+## How can I get involved?
+
+The `opentelemetry-instrumentation-pg` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
+
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us on our [gitter channel][ruby-gitter] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+
+## License
+
+The `opentelemetry-instrumentation-pg` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.
+
+[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
+[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.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative './opentelemetry/instrumentation'

data/lib/opentelemetry/instrumentation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# OpenTelemetry is an open source observability framework, providing a
+# general-purpose API, SDK, and related tools required for the instrumentation
+# of cloud-native software, frameworks, and libraries.
+#
+# The OpenTelemetry module provides global accessors for telemetry objects.
+# See the documentation for the `opentelemetry-api` gem for details.
+module OpenTelemetry
+  # "Instrumentation" are specified by
+  # https://github.com/open-telemetry/opentelemetry-specification/blob/784635d01d8690c8f5fcd1f55bdbc8a13cf2f4f2/specification/glossary.md#instrumentation-library
+  #
+  # Instrumentation should be able to handle the case when the library is not installed on a user's system.
+  module Instrumentation
+  end
+end
+
+require_relative './instrumentation/pg'

data/lib/opentelemetry/instrumentation/pg.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry'
+require 'opentelemetry-instrumentation-base'
+
+module OpenTelemetry
+  module Instrumentation
+    # Contains the OpenTelemetry instrumentation for the Pg gem
+    module PG
+    end
+  end
+end
+
+require_relative './pg/instrumentation'
+require_relative './pg/version'

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

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module PG
+      module Constants
+        # A list of SQL commands, from: https://www.postgresql.org/docs/current/sql-commands.html
+        # Commands are truncated to their first word, and all duplicates
+        # are removed, This favors brevity and low-cardinality over descriptiveness.
+        SQL_COMMANDS = %w[
+          ABORT
+          ALTER
+          ANALYZE
+          BEGIN
+          CALL
+          CHECKPOINT
+          CLOSE
+          CLUSTER
+          COMMENT
+          COMMIT
+          COPY
+          CREATE
+          DEALLOCATE
+          DECLARE
+          DELETE
+          DISCARD
+          DO
+          DROP
+          END
+          EXECUTE
+          EXPLAIN
+          FETCH
+          GRANT
+          IMPORT
+          INSERT
+          LISTEN
+          LOAD
+          LOCK
+          MOVE
+          NOTIFY
+          PREPARE
+          PREPARE
+          REASSIGN
+          REFRESH
+          REINDEX
+          RELEASE
+          RESET
+          REVOKE
+          ROLLBACK
+          SAVEPOINT
+          SECURITY
+          SELECT
+          SELECT
+          SET
+          SHOW
+          START
+          TRUNCATE
+          UNLISTEN
+          UPDATE
+          VACUUM
+          VALUES
+        ].freeze
+
+        # From: https://github.com/newrelic/newrelic-ruby-agent/blob/9787095d4b5b2d8fcaf2fdbd964ed07c731a8b6b/lib/new_relic/agent/database/obfuscation_helpers.rb#L9-L34
+        COMPONENTS_REGEX_MAP = {
+          single_quotes: /'(?:[^']|'')*?(?:\\'.*|'(?!'))/,
+          dollar_quotes: /(\$(?!\d)[^$]*?\$).*?(?:\1|$)/,
+          uuids: /\{?(?:[0-9a-fA-F]\-*){32}\}?/,
+          numeric_literals: /-?\b(?:[0-9]+\.)?[0-9]+([eE][+-]?[0-9]+)?\b/,
+          boolean_literals: /\b(?:true|false|null)\b/i,
+          comments: /(?:#|--).*?(?=\r|\n|$)/i,
+          multi_line_comments: %r{\/\*(?:[^\/]|\/[^*])*?(?:\*\/|\/\*.*)}
+        }.freeze
+
+        POSTGRES_COMPONENTS = %i[
+          single_quotes
+          dollar_quotes
+          uuids
+          numeric_literals
+          boolean_literals
+          comments
+          multi_line_comments
+        ].freeze
+
+        UNMATCHED_PAIRS_REGEX = %r{'|\/\*|\*\/|\$(?!\?)}.freeze
+
+        # These are all alike in that they will have a SQL statement as the first parameter.
+        # That statement may possibly be parameterized, but we can still use it - the
+        # obfuscation code will just transform $1 -> $? in that case (which is fine enough).
+        EXEC_ISH_METHODS = %i[
+          exec
+          query
+          sync_exec
+          async_exec
+          exec_params
+          async_exec_params
+          sync_exec_params
+        ].freeze
+
+        # The following methods all take a statement name as the first
+        # parameter, and a SQL statement as the second - and possibly
+        # further parameters after that. We can trace them all alike.
+        PREPARE_ISH_METHODS = %i[
+          prepare
+          async_prepare
+          sync_prepare
+        ].freeze
+
+        # The following methods take a prepared statement name as their first
+        # parameter - everything after that is either potentially quite sensitive
+        # (an array of bind params) or not useful to us. We trace them all alike.
+        EXEC_PREPARED_ISH_METHODS = %i[
+          exec_prepared
+          async_exec_prepared
+          sync_exec_prepared
+        ].freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module PG
+      # The Instrumentation class contains logic to detect and install the Pg instrumentation
+      class Instrumentation < OpenTelemetry::Instrumentation::Base
+        MINIMUM_VERSION = Gem::Version.new('1.1.0')
+
+        install do |_config|
+          require_dependencies
+          patch_client
+        end
+
+        present do
+          defined?(::PG)
+        end
+
+        compatible do
+          Gem.loaded_specs['pg'].version > Gem::Version.new(MINIMUM_VERSION)
+        end
+
+        option :peer_service, default: nil, validate: :string
+        option :enable_sql_obfuscation, default: false, validate: :boolean
+
+        private
+
+        def require_dependencies
+          require_relative 'patches/connection'
+        end
+
+        def patch_client
+          ::PG::Connection.prepend(Patches::Connection)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module PG
+      # A simple LRU cache for the postgres instrumentation.
+      class LruCache
+        # Rather than take a dependency on another gem, we implement a very, very basic
+        # LRU cache here. We can take advantage of the fact that Ruby hashes are ordered
+        # to always keep the recently-accessed keys at the top.
+        def initialize(size)
+          raise ArgumentError, 'Invalid size' if size < 1
+
+          @limit = size
+          @store = {}
+        end
+
+        def [](key)
+          # We need to check for the key explicitly, because `nil` is a valid hash value.
+          return unless @store.key?(key)
+
+          # Since the cache contains the item, we delete and re-insert into the hash.
+          # This guarantees that hash keys are ordered by access recency.
+          value = @store.delete(key)
+          @store[key] = value
+
+          value
+        end
+
+        def []=(key, value)
+          # We remove the value if it's already present, so that the hash keys remain ordered
+          # by access recency.
+          @store.delete(key)
+          @store[key] = value
+          @store.shift if @store.length > @limit
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/instrumentation/pg/patches/connection.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require_relative '../constants'
+require_relative '../lru_cache'
+
+module OpenTelemetry
+  module Instrumentation
+    module PG
+      module Patches
+        # Module to prepend to PG::Connection for instrumentation
+        module Connection
+          PG::Constants::EXEC_ISH_METHODS.each do |method|
+            define_method method do |*args|
+              span_name, attrs = span_attrs(:query, *args)
+              tracer.in_span(span_name, attributes: attrs, kind: :client) do
+                super(*args)
+              end
+            end
+          end
+
+          PG::Constants::PREPARE_ISH_METHODS.each do |method|
+            define_method method do |*args|
+              span_name, attrs = span_attrs(:prepare, *args)
+              tracer.in_span(span_name, attributes: attrs, kind: :client) do
+                super(*args)
+              end
+            end
+          end
+
+          PG::Constants::EXEC_PREPARED_ISH_METHODS.each do |method|
+            define_method method do |*args|
+              span_name, attrs = span_attrs(:execute, *args)
+              tracer.in_span(span_name, attributes: attrs, kind: :client) do
+                super(*args)
+              end
+            end
+          end
+
+          private
+
+          def tracer
+            PG::Instrumentation.instance.tracer
+          end
+
+          def config
+            PG::Instrumentation.instance.config
+          end
+
+          def lru_cache
+            # When SQL is being sanitized, we know that this cache will
+            # never be more than 50 entries * 2000 characters (so, presumably
+            # 100k bytes - or 97k). When not sanitizing SQL, then this cache
+            # could grow much larger - but the small cache size should otherwise
+            # help contain memory growth. The intended use here is to cache
+            # prepared SQL statements, so that we can attach a reasonable
+            # `db.sql.statement` value to spans when those prepared statements
+            # are executed later on.
+            @lru_cache ||= LruCache.new(50)
+          end
+
+          # Rubocop is complaining about 19.31/18 for Metrics/AbcSize.
+          # 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
+            if kind == :query
+              operation = extract_operation(args[0])
+              sql = obfuscate_sql(args[0])
+            else
+              statement_name = args[0]
+
+              if kind == :prepare
+                sql = obfuscate_sql(args[1])
+                lru_cache[statement_name] = sql
+                operation = 'PREPARE'
+              else
+                sql = lru_cache[statement_name]
+                operation = 'EXECUTE'
+              end
+            end
+
+            attrs = { 'db.operation' => validated_operation(operation), 'db.statement' => sql, 'db.postgresql.prepared_statement_name' => statement_name }
+            attrs.reject! { |_, v| v.nil? }
+
+            [span_name(operation), client_attributes.merge(attrs)]
+          end
+
+          def extract_operation(sql)
+            # From: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/9244a08a8d014afe26b82b91cf86e407c2599d73/plugins/node/opentelemetry-instrumentation-pg/src/utils.ts#L35
+            sql.to_s.split[0].to_s.upcase
+          end
+
+          def span_name(operation)
+            [validated_operation(operation), database_name].compact.join(' ')
+          end
+
+          def validated_operation(operation)
+            operation if PG::Constants::SQL_COMMANDS.include?(operation)
+          end
+
+          def obfuscate_sql(sql)
+            return sql unless config[:enable_sql_obfuscation]
+
+            # Borrowed from opentelemetry-instrumentation-mysql2
+            return 'SQL query too large to remove sensitive data ...' if sql.size > 2000
+
+            # From:
+            # https://github.com/newrelic/newrelic-ruby-agent/blob/9787095d4b5b2d8fcaf2fdbd964ed07c731a8b6b/lib/new_relic/agent/database/obfuscator.rb
+            # https://github.com/newrelic/newrelic-ruby-agent/blob/9787095d4b5b2d8fcaf2fdbd964ed07c731a8b6b/lib/new_relic/agent/database/obfuscation_helpers.rb
+            obfuscated = sql.gsub(generated_postgres_regex, '?')
+            obfuscated = 'Failed to obfuscate SQL query - quote characters remained after obfuscation' if PG::Constants::UNMATCHED_PAIRS_REGEX.match(obfuscated)
+
+            obfuscated
+          end
+
+          def generated_postgres_regex
+            @generated_postgres_regex ||= Regexp.union(PG::Constants::POSTGRES_COMPONENTS.map { |component| PG::Constants::COMPONENTS_REGEX_MAP[component] })
+          end
+
+          def database_name
+            conninfo_hash[:dbname]&.to_s
+          end
+
+          def client_attributes
+            attributes = {
+              'db.system' => 'postgresql',
+              'db.user' => conninfo_hash[:user]&.to_s,
+              'db.name' => database_name,
+              'net.peer.name' => conninfo_hash[:host]&.to_s
+            }
+            attributes['peer.service'] = config[:peer_service] if config[:peer_service]
+
+            attributes.merge(transport_attrs).reject { |_, v| v.nil? }
+          end
+
+          def transport_attrs
+            if conninfo_hash[:host]&.start_with?('/')
+              { 'net.transport' => 'Unix' }
+            else
+              {
+                'net.transport' => 'IP.TCP',
+                'net.peer.ip' => conninfo_hash[:hostaddr]&.to_s,
+                'net.peer.port' => conninfo_hash[:port]&.to_s
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module PG
+      VERSION = '0.17.1'
+    end
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: opentelemetry-instrumentation-pg
+version: !ruby/object:Gem::Version
+  version: 0.17.1
+platform: ruby
+authors:
+- OpenTelemetry Authors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-instrumentation-base
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.73.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.73.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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: PG (PostgreSQL) instrumentation for the OpenTelemetry framework
+email:
+- cncf-opentelemetry-contributors@lists.cncf.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/opentelemetry-instrumentation-pg.rb
+- lib/opentelemetry/instrumentation.rb
+- lib/opentelemetry/instrumentation/pg.rb
+- lib/opentelemetry/instrumentation/pg/constants.rb
+- lib/opentelemetry/instrumentation/pg/instrumentation.rb
+- 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
+licenses:
+- Apache-2.0
+metadata:
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-pg/v0.17.1/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.17.1
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: PG (PostgreSQL) instrumentation for the OpenTelemetry framework
+test_files: []