opentelemetry-instrumentation-pg

OpenTelemetry PG Instrumentation

The OpenTelemetry PG Ruby gem is a community maintained instrumentation for PG.

How do I get started?

Install the gem using:

gem install opentelemetry-instrumentation-pg

Or, if you use bundler, include opentelemetry-instrumentation-pg in your Gemfile.

Usage

To use the instrumentation, call use with the name of the instrumentation:

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::PG'
end

Alternatively, you can also call use_all to install all the available instrumentation.

OpenTelemetry::SDK.configure do |c|
  c.use_all
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.

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

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::PG', {
    # You may optionally set a value for 'peer.service', which
    # will be included on all spans from this instrumentation:
    peer_service: 'postgres:readonly',

    # By default, this instrumentation obfuscates/sanitizes the executed SQL as the `db.statement`
    # semantic attribute. Optionally, you may disable the inclusion of this attribute entirely by
    # setting this option to :omit or disable sanitization of the attribute by setting it to :include
    db_statement: :include,
  }
end

Examples

An example of usage can be seen in example/pg.rb.

How can I get involved?

The opentelemetry-instrumentation-pg gem source is on 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 GitHub Discussions, Slack Channel or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.

License

The opentelemetry-instrumentation-pg gem is distributed under the Apache 2.0 license. See LICENSE for more information.