Skip to content

Commit 5efc4d4

Browse files
committed
squash: update readme with feedback from Kayla
1 parent efae497 commit 5efc4d4

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

helpers/sql/README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,28 @@
11
# OpenTelemetry Sql Helpers
22

3-
Todo: Add a description.
3+
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.
4+
5+
## Installation
6+
7+
Add a line similar to this in your `gemspec`:
48

5-
## How do I get started?
9+
```ruby
610

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

9-
```console
10-
gem install opentelemetry-helpers-sql
1113
```
1214

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

15-
## Usage
17+
```ruby
1618

17-
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.
19+
group :test do
20+
gem 'opentelemetry-helpers-sql', path: '../../helpers/sql' # Use the approprite path
21+
end
22+
23+
```
24+
25+
## Usage
1826

1927
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.
2028

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

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

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

0 commit comments

Comments
 (0)