Skip to content

feat(core): Create template attributes in consoleLoggingIntegration #17703

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
merged 2 commits into from
Sep 19, 2025
Merged

feat(core): Create template attributes in consoleLoggingIntegration #17703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
043e606
feat(core): Create template attributes in consoleLoggingIntegration
AbhiPrasad Sep 18, 2025
99dcace
Merge branch 'develop' into abhi-template-in-console
AbhiPrasad Sep 19, 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
8 changes: 8 additions & 0 deletions dev-packages/browser-integration-tests/suites/public-api/logger/integration/subject.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,12 @@ console.log('Mixed:', 'prefix', { obj: true }, [4, 5, 6], 'suffix');

console.log('');

// Test console substitution patterns (should NOT generate template attributes)
console.log('String substitution %s %d', 'test', 42);
console.log('Object substitution %o', { key: 'value' });

// Test multiple arguments without substitutions (should generate template attributes)
console.log('first', 0, 1, 2);
console.log('hello', true, null, undefined);

Sentry.flush();
85 changes: 84 additions & 1 deletion dev-packages/browser-integration-tests/suites/public-api/logger/integration/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ sentryTest('should capture console object calls', async ({ getLocalTestUrl, page
expect(envelopeItems[0]).toEqual([
{
type: 'log',
item_count: 11,
item_count: 15,
content_type: 'application/vnd.sentry.items.log+json',
},
{
Expand All @@ -33,6 +33,9 @@ sentryTest('should capture console object calls', async ({ getLocalTestUrl, page
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'sentry.message.template': { value: 'console.trace {} {}', type: 'string' },
'sentry.message.parameter.0': { value: 123, type: 'integer' },
'sentry.message.parameter.1': { value: false, type: 'boolean' },
},
},
{
Expand All @@ -45,6 +48,9 @@ sentryTest('should capture console object calls', async ({ getLocalTestUrl, page
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'sentry.message.template': { value: 'console.debug {} {}', type: 'string' },
'sentry.message.parameter.0': { value: 123, type: 'integer' },
'sentry.message.parameter.1': { value: false, type: 'boolean' },
},
},
{
Expand All @@ -57,6 +63,9 @@ sentryTest('should capture console object calls', async ({ getLocalTestUrl, page
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'sentry.message.template': { value: 'console.log {} {}', type: 'string' },
'sentry.message.parameter.0': { value: 123, type: 'integer' },
'sentry.message.parameter.1': { value: false, type: 'boolean' },
},
},
{
Expand All @@ -69,6 +78,9 @@ sentryTest('should capture console object calls', async ({ getLocalTestUrl, page
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'sentry.message.template': { value: 'console.info {} {}', type: 'string' },
'sentry.message.parameter.0': { value: 123, type: 'integer' },
'sentry.message.parameter.1': { value: false, type: 'boolean' },
},
},
{
Expand All @@ -81,6 +93,9 @@ sentryTest('should capture console object calls', async ({ getLocalTestUrl, page
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'sentry.message.template': { value: 'console.warn {} {}', type: 'string' },
'sentry.message.parameter.0': { value: 123, type: 'integer' },
'sentry.message.parameter.1': { value: false, type: 'boolean' },
},
},
{
Expand All @@ -93,6 +108,9 @@ sentryTest('should capture console object calls', async ({ getLocalTestUrl, page
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'sentry.message.template': { value: 'console.error {} {}', type: 'string' },
'sentry.message.parameter.0': { value: 123, type: 'integer' },
'sentry.message.parameter.1': { value: false, type: 'boolean' },
},
},
{
Expand All @@ -117,6 +135,8 @@ sentryTest('should capture console object calls', async ({ getLocalTestUrl, page
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'sentry.message.template': { value: 'Object: {}', type: 'string' },
'sentry.message.parameter.0': { value: '{"key":"value","nested":{"prop":123}}', type: 'string' },
},
},
{
Expand All @@ -129,6 +149,8 @@ sentryTest('should capture console object calls', async ({ getLocalTestUrl, page
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'sentry.message.template': { value: 'Array: {}', type: 'string' },
'sentry.message.parameter.0': { value: '[1,2,3,"string"]', type: 'string' },
},
},
{
Expand All @@ -141,6 +163,11 @@ sentryTest('should capture console object calls', async ({ getLocalTestUrl, page
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'sentry.message.template': { value: 'Mixed: {} {} {} {}', type: 'string' },
'sentry.message.parameter.0': { value: 'prefix', type: 'string' },
'sentry.message.parameter.1': { value: '{"obj":true}', type: 'string' },
'sentry.message.parameter.2': { value: '[4,5,6]', type: 'string' },
'sentry.message.parameter.3': { value: 'suffix', type: 'string' },
},
},
{
Expand All @@ -155,6 +182,62 @@ sentryTest('should capture console object calls', async ({ getLocalTestUrl, page
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
},
},
{
timestamp: expect.any(Number),
level: 'info',
severity_number: 10,
trace_id: expect.any(String),
body: 'String substitution %s %d test 42',
attributes: {
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
},
},
{
timestamp: expect.any(Number),
level: 'info',
severity_number: 10,
trace_id: expect.any(String),
body: 'Object substitution %o {"key":"value"}',
attributes: {
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
},
},
{
timestamp: expect.any(Number),
level: 'info',
severity_number: 10,
trace_id: expect.any(String),
body: 'first 0 1 2',
attributes: {
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'sentry.message.template': { value: 'first {} {} {}', type: 'string' },
'sentry.message.parameter.0': { value: 0, type: 'integer' },
'sentry.message.parameter.1': { value: 1, type: 'integer' },
'sentry.message.parameter.2': { value: 2, type: 'integer' },
},
},
{
timestamp: expect.any(Number),
level: 'info',
severity_number: 10,
trace_id: expect.any(String),
body: 'hello true null undefined',
attributes: {
'sentry.origin': { value: 'auto.console.logging', type: 'string' },
'sentry.sdk.name': { value: 'sentry.javascript.browser', type: 'string' },
'sentry.sdk.version': { value: expect.any(String), type: 'string' },
'sentry.message.template': { value: 'hello {} {} {}', type: 'string' },
'sentry.message.parameter.0': { value: true, type: 'boolean' },
'sentry.message.parameter.1': { value: 'null', type: 'string' },
'sentry.message.parameter.2': { value: '', type: 'string' },
},
},
],
},
]);
Expand Down
18 changes: 14 additions & 4 deletions packages/core/src/logs/console-integration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import type { ConsoleLevel } from '../types-hoist/instrument';
import type { IntegrationFn } from '../types-hoist/integration';
import { CONSOLE_LEVELS, debug } from '../utils/debug-logger';
import { _INTERNAL_captureLog } from './internal';
import { formatConsoleArgs } from './utils';
import { createConsoleTemplateAttributes, formatConsoleArgs, hasConsoleSubstitutions } from './utils';

interface CaptureConsoleOptions {
levels: ConsoleLevel[];
Expand Down Expand Up @@ -36,9 +36,11 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
return;
}

const firstArg = args[0];
const followingArgs = args.slice(1);

if (level === 'assert') {
if (!args[0]) {
const followingArgs = args.slice(1);
if (!firstArg) {
const assertionMessage =
followingArgs.length > 0
? `Assertion failed: ${formatConsoleArgs(followingArgs, normalizeDepth, normalizeMaxBreadth)}`
Expand All @@ -49,11 +51,19 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
}

const isLevelLog = level === 'log';

const shouldGenerateTemplate =
args.length > 1 && typeof args[0] === 'string' && !hasConsoleSubstitutions(args[0]);
const attributes = {
...DEFAULT_ATTRIBUTES,
...(shouldGenerateTemplate ? createConsoleTemplateAttributes(firstArg, followingArgs) : {}),
};

_INTERNAL_captureLog({
level: isLevelLog ? 'info' : level,
message: formatConsoleArgs(args, normalizeDepth, normalizeMaxBreadth),
severityNumber: isLevelLog ? 10 : undefined,
attributes: DEFAULT_ATTRIBUTES,
attributes,
});
});
},
Expand Down
32 changes: 32 additions & 0 deletions packages/core/src/logs/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,35 @@ export function safeJoinConsoleArgs(values: unknown[], normalizeDepth: number, n
)
.join(' ');
}

/**
* Checks if a string contains console substitution patterns like %s, %d, %i, %f, %o, %O, %c.
*
* @param str - The string to check
* @returns true if the string contains console substitution patterns
*/
export function hasConsoleSubstitutions(str: string): boolean {
// Match console substitution patterns: %s, %d, %i, %f, %o, %O, %c
return /%[sdifocO]/.test(str);
}

/**
* Creates template attributes for multiple console arguments.
*
* @param args - The console arguments
* @returns An object with template and parameter attributes
*/
export function createConsoleTemplateAttributes(firstArg: unknown, followingArgs: unknown[]): Record<string, unknown> {
const attributes: Record<string, unknown> = {};

// Create template with placeholders for each argument
const template = new Array(followingArgs.length).fill('{}').join(' ');
attributes['sentry.message.template'] = `${firstArg} ${template}`;

// Add each argument as a parameter
followingArgs.forEach((arg, index) => {
attributes[`sentry.message.parameter.${index}`] = arg;
});

return attributes;
}
Copy link

@cursor cursor bot Sep 19, 2025

Choose a reason for hiding this comment

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

Bug: Console Template Attributes Formatting Issues

The createConsoleTemplateAttributes function has two issues. The sentry.message.template attribute includes an unintended trailing space when no followingArgs are present. Additionally, sentry.message.parameter attributes are stored as raw values instead of structured objects with value/type, and null/undefined values are not converted to their expected string representations.

Fix in Cursor Fix in Web