Uh oh!
There was an error while loading. Please reload this page.
feat(consola): Enhance Consola integration to extract objects as searchable attributes - #18602
feat(consola): Enhance Consola integration to extract objects as searchable attributes#18602s1gr1d wants to merge 6 commits into
Conversation
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
node-overhead report 🧳Note: This is a synthetic benchmark with a minimal express app and does not necessarily reflect the real-world performance impact in an application.
|
Uh oh!
There was an error while loading. Please reload this page.
| // Non-plain objects (Date, Error, Map, Set, etc.) and arrays: Store as args attribute so they get properly serialized | ||
| // Special handling for Map and Set to preserve their data | ||
| attributes[`consola.args.${contextIndex++}`] = | ||
| arg instanceof Map ? Object.fromEntries(arg) : arg instanceof Set ? Array.from(arg) : arg; |
There was a problem hiding this comment.
Non-plain objects can overwrite existing attribute keys
When storing non-plain objects (arrays, Date, Error, etc.), the code unconditionally sets attributes[\consola.args.${contextIndex++}`]without checking if the key already exists. This is inconsistent with the conflict prevention at lines 241-245 for plain objects. If a plain object contains a key like'consola.args.0'and is followed by an array in the args, the plain object's value will be silently overwritten by the array. This could cause unexpected data loss in edge cases where users happen to use keys matching theconsola.args.N` pattern.
| 'server.address': { value: expect.any(String), type: 'string' }, | ||
| 'consola.type': { value: 'info', type: 'string' }, | ||
| 'consola.level': { value: 3, type: 'integer' }, | ||
| key: { value: 'value', type: 'string' }, |
There was a problem hiding this comment.
Test missing assertion for array attribute extraction (Bugbot Rules)
Per the review rules: "Check that tests actually test the newly added behaviour. When checking on sent payloads by the SDK, ensure that the newly added data is asserted thoroughly." The test subject at subject-args.ts line 24 includes an array [1, 2, 3] in the args, which per the new feature should be stored as consola.args.0. However, the test's expected attributes at lines 285-295 only assert key: 'value' but not the consola.args.0 attribute for the array, leaving the array extraction behavior unverified in this test case.
0e601fd to
44ce3bbCompare44ce3bb to
aefd5feComparesize-limit report 📦
|
s1gr1d
commented
Feb 26, 2026
Closing this in favor of this PR: #19534 |
The JS doc states that extra keys are added as `consola.` log
attributes. However, this is not the case.
Extra keys can be added by, for example, calling the Consola reporter
directly or by calling `consola.[type]({ message: '', ... })`.
Part of this PR (split up for better reviewing):
#18602Closes#19512 (added automatically)
When logging with Consola, objects passed as arguments were being serialized into the log message string, making the data non-searchable in Sentry:
Before
Screenshot from Sentry (Consola vs Pino vs Winston)
After
Extract object properties as individual log attributes, making them searchable and filterable in Sentry:
consola.args.NattributesAligns with how the Pino integration handles structured data. Example:
sentry-javascript/dev-packages/node-integration-tests/suites/pino/test.ts
Lines 64 to 74 in 0ae9369
Now with the Consola integration in Sentry:
Closes#18593