Skip to content

Report isolation level on ActiveRecord transaction #1672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+18 −4
Open

Report isolation level on ActiveRecord transaction #1672

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
243b9d0
Report isolation level on ActiveRecord transaction
kirs Sep 15, 2025
7a9e962
Merge branch 'main' into transaction-isolation
robertlaurin Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions ...ord/lib/opentelemetry/instrumentation/active_record/patches/transactions_class_methods.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@ class << base

# Contains ActiveRecord::Transactions::ClassMethods to be patched
module ClassMethods
def transaction(...)
tracer.in_span('ActiveRecord.transaction', attributes: { 'code.namespace' => name }) do
super
def transaction(*args, **kwargs, &block)
attributes = { 'code.namespace' => name }
Copy link
Contributor

@xuan-cao-swi xuan-cao-swi Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

attributes = {
  'code.namespace' => name,
  'db.transaction_isolation' => kwargs[:isolation]
}.compact!

Copy link
Contributor

@robertlaurin robertlaurin Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xuan-cao-swi this would potentially set the attributes hash to nil.

https://ruby-doc.org/3.4.1/Hash.html#method-i-compact-21

compact! → self or nil
Returns self with all its nil-valued entries removed (in place):
Returns nil if no entries were removed.

if kwargs[:isolation]
attributes['db.transaction_isolation'] = kwargs[:isolation].to_s
Copy link
Contributor

@arielvalentin arielvalentin Sep 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: There is no semantic convention for this.

In practice only 1 other instrumentation implements it and namespaces it under the specific DB vendor since I believe Isolation Levels are rather specific to ACID SQL style databases.

https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/c8000c3a13bc75c5033ab5c0ccbc1dd87f2c8069/receiver/sqlserverreceiver/documentation.md#attributes-11

Having said all that, I think that its fine to be under the db namespace but name it db.tansaction_isolation_level for symmetry with the existing usage.

🙏🏼 if you would kindly submit a PR to add this semconv attribute upstream.

Do you all use db client spans as well? Would you like this attribute to appear on those spans as well or is this span good enough?

Copy link

@thompson-tomo thompson-tomo Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would go with the attribute naming db.tansaction.isolation_level so that we could also have db.tansaction.id. I also suggest raising a pr to add it to semconv.

end
tracer.in_span('ActiveRecord.transaction', attributes: attributes) do
super(*args, **kwargs, &block)
Copy link
Contributor

@xuan-cao-swi xuan-cao-swi Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

super is enough

end
end

Expand Down
8 changes: 8 additions & 0 deletions ...tive_record/test/instrumentation/active_record/patches/transactions_class_methods_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,13 @@ def self.name
transaction_span = spans.find { |s| s.attributes['code.namespace'] == 'ActiveRecord::Base' }
_(transaction_span).wont_be_nil
end

it 'records transaction isolation level' do
ActiveRecord::Base.transaction(isolation: :read_uncommitted) { User.create! }

transaction_span = spans.find { |s| s.attributes['code.namespace'] == 'ActiveRecord::Base' }
_(transaction_span).wont_be_nil
_(transaction_span.attributes['db.transaction.isolation']).must_equal 'read_uncommitted'
end
end
end
4 changes: 3 additions & 1 deletion instrumentation/active_record/test/test_helper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@

ActiveRecord::Base.establish_connection(
adapter: 'sqlite3',
database: 'db/development.sqlite3'
database: 'db/development.sqlite3',
# allow to manipulate the transaction isolation level
flags: ::SQLite3::Constants::Open::READWRITE | SQLite3::Constants::Open::CREATE | ::SQLite3::Constants::Open::SHAREDCACHE
)

# Create ActiveRecord models
Expand Down
Loading