Skip to content

Commit

Permalink
squash: update readme with feedback from Kayla
Browse files Browse the repository at this point in the history
  • Loading branch information
arielvalentin committed Jan 24, 2025
1 parent efae497 commit 5efc4d4
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions helpers/sql/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
# OpenTelemetry Sql Helpers

Todo: Add a description.
This gem is intended to be used by the instrumentation libraries to provide a common set of helpers for SQL-related spans. It is not intended to be used directly by applications.

## Installation

Add a line similar to this in your `gemspec`:

## How do I get started?
```ruby

Install the gem using:
spec.add_dependency 'opentelemetry-helpers-sql', '~> 0.3' # Use the approprite version

```console
gem install opentelemetry-helpers-sql
```

Or, if you use [bundler][bundler-home], include `opentelemetry-helpers-sql` in your `Gemfile`.
Update your `Gemfile` to use the latest version of the gem in the contrib, e.g.

## Usage
```ruby

This gem is intended to be used by the instrumentation libraries to provide a common set of helpers for SQL-related spans. It is not intended to be used directly by applications.
group :test do
gem 'opentelemetry-helpers-sql', path: '../../helpers/sql' # Use the approprite path
end

```

## Usage

Some database libraries do not have enough context to add sufficient details to client spans. In these cases, you can use the `OpenTelemetry::Helpers::Sql.with_attributes` to create a set of shared attributes to amend to a database span.

Expand Down Expand Up @@ -44,7 +52,6 @@ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special int

The `opentelemetry-helpers-sql` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information.

[bundler-home]: https://bundler.io
[repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
[license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
[ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
Expand Down

0 comments on commit 5efc4d4

Please sign in to comment.