feat: add event context #700
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for setting and retrieving event-specific context on the Honeybadger agent, and ensures only that context is sent with events.
- Delegates
Honeybadger.event_contextandHoneybadger.get_event_contextto the agent singleton - Implements
set_event_context/get_event_contextin the context manager with global and block-local scopes - Updates
Agent#eventto include only event-specific context and the hostname when configured
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| spec/unit/honeybadger_spec.rb | Adds tests for delegating module-level event_context and get_event_context |
| spec/unit/honeybadger/agent_spec.rb | Adds comprehensive specs for event context behavior and event payload |
| lib/honeybadger/context_manager.rb | Implements set_event_context, get_event_context, and reset logic |
| lib/honeybadger/agent.rb | Adds public event_context/get_event_context API and payload updates |
Comments suppressed due to low confidence (4)
spec/unit/honeybadger_spec.rb:50
- It’s better to assert that
event_contextis called with the correct arguments. Consider updating this to.with(user_id: 123)to fully validate the delegation.
expect(Honeybadger::Agent.instance).to receive(:event_context)
lib/honeybadger/context_manager.rb:57
- [nitpick] The variable name
localis ambiguous; consider renaming it toblock_contextorwith_blockto clarify its purpose.
local = block_given?
lib/honeybadger/agent.rb:469
- [nitpick] The example uses
Honeybadger.event_context.clear!, butclear!lives on the agent, not on the return ofevent_context. Consider clarifying this or providing an explicitclear_event_contexthelper to avoid confusion.
# Honeybadger.event_context.clear!
lib/honeybadger/agent.rb:416
- [nitpick] The indentation of this comment and the following lines in the
tapblock is inconsistent with the surrounding block; aligning them will improve readability.
# Include only event-specific context in events (not global context)
Comment on lines
+82
to
+84
| return @global_event_context unless @local_event_context | ||
|
|
||
| @global_event_context.merge(@local_event_context.inject({}, :merge)) |
There was a problem hiding this comment.
[nitpick] To prevent external code from mutating the internal state, consider returning a duplicate of the stored hash (e.g., @global_event_context.dup) rather than the original object.
Suggested change
| return @global_event_context unless @local_event_context | |
| @global_event_context.merge(@local_event_context.inject({}, :merge)) | |
| return @global_event_context.dup unless @local_event_context | |
| @global_event_context.merge(@local_event_context.inject({}, :merge)).dup |
Copilot uses AI. Check for mistakes.
Data added to event context will be added to all events reported to the API
stympy
force-pushed
the
699-feature-event-context-support-for-ruby
branch
from
3ba2bb2 to
a389845
Compare
…d to fail Hopefully this will fix the test failures for ruby-head, but if not, at least it should let the other tests continue.
The test "warns the logger when the queue has additional items" was failing intermittently in JRuby because it expected exactly 1 warning but sometimes received 2 warnings due to a race condition between the shutdown method and work method both logging throttled warnings.
rabidpraxis
reviewed
Jun 26, 2025
rabidpraxis
approved these changes
Jun 27, 2025
joshuap
approved these changes
Jun 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data added to event context will be added to all events reported to the API