Skip to content

fix(core): Do not abbreviate message parameter attribute #15987

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
Apr 7, 2025
Merged

fix(core): Do not abbreviate message parameter attribute #15987

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
45d2890
fix(core): Make message parameter attribute key signular
AbhiPrasad Apr 7, 2025
58b5b06
fix tests
AbhiPrasad Apr 7, 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
48 changes: 24 additions & 24 deletions dev-packages/browser-integration-tests/suites/public-api/logger/simple/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,25 +115,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
},
},
{
key: 'sentry.message.param.0',
key: 'sentry.message.parameter.0',
value: {
stringValue: 'trace',
},
},
{
key: 'sentry.message.param.1',
key: 'sentry.message.parameter.1',
value: {
stringValue: 'stringArg',
},
},
{
key: 'sentry.message.param.2',
key: 'sentry.message.parameter.2',
value: {
boolValue: false,
},
},
{
key: 'sentry.message.param.3',
key: 'sentry.message.parameter.3',
value: {
doubleValue: 123,
},
Expand All @@ -160,25 +160,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
},
},
{
key: 'sentry.message.param.0',
key: 'sentry.message.parameter.0',
value: {
stringValue: 'debug',
},
},
{
key: 'sentry.message.param.1',
key: 'sentry.message.parameter.1',
value: {
stringValue: 'stringArg',
},
},
{
key: 'sentry.message.param.2',
key: 'sentry.message.parameter.2',
value: {
boolValue: false,
},
},
{
key: 'sentry.message.param.3',
key: 'sentry.message.parameter.3',
value: {
doubleValue: 123,
},
Expand All @@ -205,25 +205,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
},
},
{
key: 'sentry.message.param.0',
key: 'sentry.message.parameter.0',
value: {
stringValue: 'info',
},
},
{
key: 'sentry.message.param.1',
key: 'sentry.message.parameter.1',
value: {
stringValue: 'stringArg',
},
},
{
key: 'sentry.message.param.2',
key: 'sentry.message.parameter.2',
value: {
boolValue: false,
},
},
{
key: 'sentry.message.param.3',
key: 'sentry.message.parameter.3',
value: {
doubleValue: 123,
},
Expand All @@ -250,25 +250,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
},
},
{
key: 'sentry.message.param.0',
key: 'sentry.message.parameter.0',
value: {
stringValue: 'warn',
},
},
{
key: 'sentry.message.param.1',
key: 'sentry.message.parameter.1',
value: {
stringValue: 'stringArg',
},
},
{
key: 'sentry.message.param.2',
key: 'sentry.message.parameter.2',
value: {
boolValue: false,
},
},
{
key: 'sentry.message.param.3',
key: 'sentry.message.parameter.3',
value: {
doubleValue: 123,
},
Expand All @@ -295,25 +295,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
},
},
{
key: 'sentry.message.param.0',
key: 'sentry.message.parameter.0',
value: {
stringValue: 'error',
},
},
{
key: 'sentry.message.param.1',
key: 'sentry.message.parameter.1',
value: {
stringValue: 'stringArg',
},
},
{
key: 'sentry.message.param.2',
key: 'sentry.message.parameter.2',
value: {
boolValue: false,
},
},
{
key: 'sentry.message.param.3',
key: 'sentry.message.parameter.3',
value: {
doubleValue: 123,
},
Expand All @@ -340,25 +340,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
},
},
{
key: 'sentry.message.param.0',
key: 'sentry.message.parameter.0',
value: {
stringValue: 'fatal',
},
},
{
key: 'sentry.message.param.1',
key: 'sentry.message.parameter.1',
value: {
stringValue: 'stringArg',
},
},
{
key: 'sentry.message.param.2',
key: 'sentry.message.parameter.2',
value: {
boolValue: false,
},
},
{
key: 'sentry.message.param.3',
key: 'sentry.message.parameter.3',
value: {
doubleValue: 123,
},
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/logs/exports.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ export function _INTERNAL_captureLog(
const { __sentry_template_string__, __sentry_template_values__ = [] } = message;
logAttributes['sentry.message.template'] = __sentry_template_string__;
__sentry_template_values__.forEach((param, index) => {
logAttributes[`sentry.message.param.${index}`] = param;
logAttributes[`sentry.message.parameter.${index}`] = param;
});
}

Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/lib/logs/exports.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,11 +206,11 @@ describe('_INTERNAL_captureLog', () => {
value: { stringValue: 'Hello %s, welcome to %s' },
}),
expect.objectContaining({
key: 'sentry.message.param.0',
key: 'sentry.message.parameter.0',
value: { stringValue: 'John' },
}),
expect.objectContaining({
key: 'sentry.message.param.1',
key: 'sentry.message.parameter.1',
value: { stringValue: 'Sentry' },
}),
]),
Expand Down
2 changes: 1 addition & 1 deletion packages/node/src/log.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ function captureLog(level: LogSeverityLevel, ...args: CaptureLogArgs): void {
const attributes = { ...maybeAttributes };
attributes['sentry.message.template'] = messageOrMessageTemplate;
paramsOrAttributes.forEach((param, index) => {
attributes[`sentry.message.param.${index}`] = param;
attributes[`sentry.message.parameter.${index}`] = param;
});
const message = format(messageOrMessageTemplate, ...paramsOrAttributes);
_INTERNAL_captureLog({ level, message, attributes });
Expand Down
8 changes: 4 additions & 4 deletions packages/node/test/log.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ describe('Node Logger', () => {
attributes: {
userId: 123,
'sentry.message.template': 'Hello %s, your balance is %d',
'sentry.message.param.0': 'John',
'sentry.message.param.1': 100,
'sentry.message.parameter.0': 'John',
'sentry.message.parameter.1': 100,
},
});
});
Expand All @@ -111,8 +111,8 @@ describe('Node Logger', () => {
message: 'User Alice logged in from mobile',
attributes: {
'sentry.message.template': 'User %s logged in from %s',
'sentry.message.param.0': 'Alice',
'sentry.message.param.1': 'mobile',
'sentry.message.parameter.0': 'Alice',
'sentry.message.parameter.1': 'mobile',
},
});
});
Expand Down
Loading