Skip to content

Support inline context for Rage::Logger #206

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

Merged
rsamoilov merged 1 commit into from
Feb 10, 2026
+148 −14
Merged

Support inline context for Rage::Logger #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 41 additions & 11 deletions lib/rage/logger/logger.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,19 +190,29 @@ def rebuild!
if @logdev.nil? || level_val < @level
# logging is disabled or the log level is higher than the current one
<<-RUBY
def #{level_name}(msg = nil)
def #{level_name}(msg = nil, context = nil)
false
end
RUBY
elsif @external_logger.is_a?(External::Static)
# an object that implements Ruby's Logger interface is used as a logger
write_call = <<~RUBY
@external_logger.wrapped.#{level_name}(
#{build_formatter_call(level_name, level_val)}
)
RUBY

<<~RUBY
def #{level_name}(msg = nil)
def #{level_name}(msg = nil, context = nil)
#{with_dynamic_tags_and_context do
<<~RUBY
@external_logger.wrapped.#{level_name}(
#{build_formatter_call(level_name, level_val)}
)
if context
with_context(context) do
#{write_call}
end
else
#{write_call}
end
RUBY
end}
end
Expand All @@ -223,23 +233,43 @@ def #{level_name}(msg = nil)
request_info: "Fiber[:__rage_logger_final].freeze"
})

write_call = <<~RUBY
@external_logger.wrapped.call(#{parameters})
RUBY

<<~RUBY
def #{level_name}(msg = nil)
def #{level_name}(msg = nil, context = nil)
#{with_dynamic_tags_and_context do
<<~RUBY
@external_logger.wrapped.call(#{parameters})
if context
with_context(context) do
#{write_call}
end
else
#{write_call}
end
RUBY
end}
end
RUBY
else
write_call = <<~RUBY
@logdev.write(
#{build_formatter_call(level_name, level_val)}
)
RUBY

<<~RUBY
def #{level_name}(msg = nil)
def #{level_name}(msg = nil, context = nil)
#{with_dynamic_tags_and_context do
<<~RUBY
@logdev.write(
#{build_formatter_call(level_name, level_val)}
)
if context
with_context(context) do
#{write_call}
end
else
#{write_call}
end
RUBY
end}
end
Expand Down
110 changes: 107 additions & 3 deletions spec/logger_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,39 @@
end
end

context "with inline context" do
it "adds a key to an entry" do
subject.info "passed", test_id: "1133"
expect(io.tap(&:rewind).read).to eq("[my_test_tag] timestamp=very_accurate_timestamp pid=777 level=info test_id=1133 message=passed\n")
end

it "adds multiple keys to an entry" do
subject.info "passed", test_id: "1133", user_id: 12345
expect(io.tap(&:rewind).read).to eq("[my_test_tag] timestamp=very_accurate_timestamp pid=777 level=info test_id=1133 user_id=12345 message=passed\n")
end

it "works correctly with multiple nesting levels" do
subject.tagged("rspec") do
subject.debug "debug message", user_id: 123

subject.with_context(b: 222) do
subject.tagged("test_tag") do
subject.info "info message", user_id: 456

subject.with_context(c: "333", d: "444") do
subject.unknown "unknown message", user_id: 789
end
end
end
end

io.rewind
expect(io.readline).to eq("[my_test_tag][rspec] timestamp=very_accurate_timestamp pid=777 level=debug user_id=123 message=debug message\n")
expect(io.readline).to eq("[my_test_tag][rspec][test_tag] timestamp=very_accurate_timestamp pid=777 level=info b=222 user_id=456 message=info message\n")
expect(io.readline).to eq("[my_test_tag][rspec][test_tag] timestamp=very_accurate_timestamp pid=777 level=unknown b=222 c=333 d=444 user_id=789 message=unknown message\n")
end
end

context "outside the request/response cycle" do
before do
Fiber[:__rage_logger_tags] = nil
Expand Down Expand Up @@ -294,6 +327,12 @@
subject << "this is a test message"
}.not_to raise_error
end

it "doesn't add inline context" do
expect(
subject.fatal("this is a test message", user_id: 567)
).to be(false)
end
end

context "with LogDevice options" do
Expand All @@ -314,9 +353,6 @@
end

it "delegates logger calls to external logger" do
p "grep_me !!!!!!!"
p Fiber.current.storage

expect(external_logger).to receive(:info).with("[my_test_tag] timestamp=very_accurate_timestamp pid=777 level=info message=test\n")
subject.info "test"

Expand All @@ -334,6 +370,23 @@
end
end

context "with custom inline context" do
it "correctly builds log entry" do
expect(external_logger).to receive(:info).with("[my_test_tag] timestamp=very_accurate_timestamp pid=777 level=info rspec=true message=test\n")
subject.info "test", rspec: true
end
end

context "with merged context" do
it "correctly builds log entry" do
expect(external_logger).to receive(:info).with("[my_test_tag] timestamp=very_accurate_timestamp pid=777 level=info rspec=true user_id=123 account_id=456 message=test\n")

subject.with_context(rspec: true) do
subject.info "test", user_id: 123, account_id: 456
end
end
end

context "with custom tags" do
it "correctly builds log entry" do
expect(external_logger).to receive(:info).with("[my_test_tag][rspec][tags_test] timestamp=very_accurate_timestamp pid=777 level=info message=test\n")
Expand Down Expand Up @@ -376,6 +429,13 @@
end
end

context "with custom inline context" do
it "correctly builds log entry" do
expect(external_logger).to receive(:info).with("[my_test_tag] timestamp=very_accurate_timestamp pid=777 level=info id=12345 rspec=true message=test\n")
subject.info "test", rspec: true
end
end

context "with custom tags and context" do
it "correctly builds log entry" do
expect(external_logger).to receive(:info).with("[my_test_tag][rspec][tags_test] timestamp=very_accurate_timestamp pid=777 level=info rspec=true id=12345 message=test\n")
Expand Down Expand Up @@ -443,6 +503,36 @@
end
end

context "with custom inline context" do
it "correctly builds log entry" do
expect(external_logger).to receive(:call).with(
severity: :info,
tags: ["my_test_tag"],
context: { rspec: true },
message: "test",
request_info: nil
)

subject.info "test", rspec: true
end
end

context "with merged context" do
it "correctly builds log entry" do
expect(external_logger).to receive(:call).with(
severity: :info,
tags: ["my_test_tag"],
context: { rspec: true, user_id: 123 },
message: "test",
request_info: nil
)

subject.with_context(rspec: true) do
subject.info "test", user_id: 123
end
end
end

context "with custom tags" do
it "correctly builds log entry" do
expect(external_logger).to receive(:call).with(
Expand Down Expand Up @@ -523,6 +613,20 @@
end
end

context "with custom inline context" do
it "correctly builds log entry" do
expect(external_logger).to receive(:call).with(
severity: :info,
tags: ["my_test_tag"],
context: { id: 12345, rspec: true },
message: "test",
request_info: nil
)

subject.info "test", rspec: true
end
end

context "with custom tags and context" do
it "correctly builds log entry" do
expect(external_logger).to receive(:call).with(
Expand Down