README.md in opentelemetry-instrumentation-pg-0.21.0 vs README.md in opentelemetry-instrumentation-pg-0.22.0

- old
+ new

@@ -28,10 +28,21 @@ 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. + +```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 OpenTelemetry::SDK.configure do |c| c.use 'OpenTelemetry::Instrumentation::PG', { @@ -47,11 +58,11 @@ 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? The `opentelemetry-instrumentation-pg` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`. @@ -62,9 +73,9 @@ 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 +[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