Skip to content

Commit efae497

Browse files
squash: Apply suggestions from code review
Co-authored-by: Kayla Reopelle <[email protected]>
1 parent db50b48 commit efae497

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

.toys/.data/releases.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ commit_lint:
3232
gems:
3333
- name: opentelemetry-helpers-sql
3434
directory: helpers/sql
35-
version_constant: [OpenTelemetry, helpers, Sql, VERSION]
35+
version_constant: [OpenTelemetry, Helpers, Sql, VERSION]
3636

3737
- name: opentelemetry-instrumentation-gruf
3838
directory: instrumentation/gruf

helpers/sql/.yardopts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
--no-private
2-
--title=OpenTelemetry Sql Instrumentation
2+
--title=OpenTelemetry Sql Helpers
33
--markup=markdown
44
--main=README.md
5-
./lib/opentelemetry/instrumentation/**/*.rb
6-
./lib/opentelemetry/instrumentation.rb
5+
./lib/opentelemetry/helpers/**/*.rb
6+
./lib/opentelemetry/helpers.rb
77
-
88
README.md
99
CHANGELOG.md

helpers/sql/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Or, if you use [bundler][bundler-home], include `opentelemetry-helpers-sql` in y
1616

1717
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.
1818

19-
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.
19+
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.
2020

2121
```ruby
2222
# Higher-level instrumentation e.g. ORM

helpers/sql/lib/opentelemetry/helpers/sql.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@
88

99
module OpenTelemetry
1010
module Helpers
11-
# Contains the OpenTelemetry instrumentation for the Sql gem
11+
# Contains helpers for OpenTelemetry instrumentation related to SQL
1212
module Sql
1313
extend self
1414

1515
CURRENT_ATTRIBUTES_KEY = Context.create_key('sql-attributes-hash')
1616

1717
private_constant :CURRENT_ATTRIBUTES_KEY
1818

19-
# Returns the attributes hash representing the Trilogy context found
19+
# Returns the attributes hash representing the SQL adapter context found
2020
# in the optional context or the current context if none is provided.
2121
#
2222
# @param [optional Context] context The context to lookup the current

helpers/sql/opentelemetry-helpers-sql.gemspec

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ Gem::Specification.new do |spec|
1414
spec.authors = ['OpenTelemetry Authors']
1515
spec.email = ['[email protected]']
1616

17-
spec.summary = 'Sql helpers for the OpenTelemetry framework'
18-
spec.description = 'Sql helpers for the OpenTelemetry framework'
17+
spec.summary = 'SQL helpers for the OpenTelemetry framework'
18+
spec.description = 'SQL helpers for the OpenTelemetry framework'
1919
spec.homepage = 'https://github.com/open-telemetry/opentelemetry-ruby-contrib'
2020
spec.license = 'Apache-2.0'
2121

2222
spec.files = Dir.glob('lib/**/*.rb') +
2323
Dir.glob('*.md') +
2424
['LICENSE', '.yardopts']
2525
spec.require_paths = ['lib']
26-
spec.required_ruby_version = '>= 3.0'
26+
spec.required_ruby_version = '>= 3.1'
2727

2828
spec.add_dependency 'opentelemetry-api', '~> 1.4.0'
2929

@@ -32,8 +32,8 @@ Gem::Specification.new do |spec|
3232
spec.add_development_dependency 'minitest', '~> 5.0'
3333
spec.add_development_dependency 'opentelemetry-test-helpers', '~> 0.3'
3434
spec.add_development_dependency 'rake', '~> 13.0'
35-
spec.add_development_dependency 'rubocop', '~> 1.68.0'
36-
spec.add_development_dependency 'rubocop-performance', '~> 1.22.0'
35+
spec.add_development_dependency 'rubocop', '~> 1.71.0'
36+
spec.add_development_dependency 'rubocop-performance', '~> 1.23.0'
3737
spec.add_development_dependency 'simplecov', '~> 0.17.1'
3838
spec.add_development_dependency 'yard', '~> 0.9'
3939

0 commit comments

Comments
 (0)