Skip to content

Commit 186e696

Browse files
AbhiPrasadAbhiPrasad
authored
fix(core): Do not abbreviate message parameter attribute (#15987)
Generally for attribute keys we prefer to avoid abbreviation. For example in OTEL, [`net.X`](https://github.com/getsentry/sentry-conventions/blob/main/generated/attributes/net.md) was renamed to [`network.X`](https://github.com/getsentry/sentry-conventions/blob/main/generated/attributes/network.md)
1 parent 51f04a1 commit 186e696

File tree

5 files changed

+32
-32
lines changed

5 files changed

+32
-32
lines changed

‎dev-packages/browser-integration-tests/suites/public-api/logger/simple/test.ts‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -115,25 +115,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
115115
},
116116
},
117117
{
118-
key: 'sentry.message.param.0',
118+
key: 'sentry.message.parameter.0',
119119
value: {
120120
stringValue: 'trace',
121121
},
122122
},
123123
{
124-
key: 'sentry.message.param.1',
124+
key: 'sentry.message.parameter.1',
125125
value: {
126126
stringValue: 'stringArg',
127127
},
128128
},
129129
{
130-
key: 'sentry.message.param.2',
130+
key: 'sentry.message.parameter.2',
131131
value: {
132132
boolValue: false,
133133
},
134134
},
135135
{
136-
key: 'sentry.message.param.3',
136+
key: 'sentry.message.parameter.3',
137137
value: {
138138
doubleValue: 123,
139139
},
@@ -160,25 +160,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
160160
},
161161
},
162162
{
163-
key: 'sentry.message.param.0',
163+
key: 'sentry.message.parameter.0',
164164
value: {
165165
stringValue: 'debug',
166166
},
167167
},
168168
{
169-
key: 'sentry.message.param.1',
169+
key: 'sentry.message.parameter.1',
170170
value: {
171171
stringValue: 'stringArg',
172172
},
173173
},
174174
{
175-
key: 'sentry.message.param.2',
175+
key: 'sentry.message.parameter.2',
176176
value: {
177177
boolValue: false,
178178
},
179179
},
180180
{
181-
key: 'sentry.message.param.3',
181+
key: 'sentry.message.parameter.3',
182182
value: {
183183
doubleValue: 123,
184184
},
@@ -205,25 +205,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
205205
},
206206
},
207207
{
208-
key: 'sentry.message.param.0',
208+
key: 'sentry.message.parameter.0',
209209
value: {
210210
stringValue: 'info',
211211
},
212212
},
213213
{
214-
key: 'sentry.message.param.1',
214+
key: 'sentry.message.parameter.1',
215215
value: {
216216
stringValue: 'stringArg',
217217
},
218218
},
219219
{
220-
key: 'sentry.message.param.2',
220+
key: 'sentry.message.parameter.2',
221221
value: {
222222
boolValue: false,
223223
},
224224
},
225225
{
226-
key: 'sentry.message.param.3',
226+
key: 'sentry.message.parameter.3',
227227
value: {
228228
doubleValue: 123,
229229
},
@@ -250,25 +250,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
250250
},
251251
},
252252
{
253-
key: 'sentry.message.param.0',
253+
key: 'sentry.message.parameter.0',
254254
value: {
255255
stringValue: 'warn',
256256
},
257257
},
258258
{
259-
key: 'sentry.message.param.1',
259+
key: 'sentry.message.parameter.1',
260260
value: {
261261
stringValue: 'stringArg',
262262
},
263263
},
264264
{
265-
key: 'sentry.message.param.2',
265+
key: 'sentry.message.parameter.2',
266266
value: {
267267
boolValue: false,
268268
},
269269
},
270270
{
271-
key: 'sentry.message.param.3',
271+
key: 'sentry.message.parameter.3',
272272
value: {
273273
doubleValue: 123,
274274
},
@@ -295,25 +295,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
295295
},
296296
},
297297
{
298-
key: 'sentry.message.param.0',
298+
key: 'sentry.message.parameter.0',
299299
value: {
300300
stringValue: 'error',
301301
},
302302
},
303303
{
304-
key: 'sentry.message.param.1',
304+
key: 'sentry.message.parameter.1',
305305
value: {
306306
stringValue: 'stringArg',
307307
},
308308
},
309309
{
310-
key: 'sentry.message.param.2',
310+
key: 'sentry.message.parameter.2',
311311
value: {
312312
boolValue: false,
313313
},
314314
},
315315
{
316-
key: 'sentry.message.param.3',
316+
key: 'sentry.message.parameter.3',
317317
value: {
318318
doubleValue: 123,
319319
},
@@ -340,25 +340,25 @@ sentryTest('should capture all logging methods', async ({ getLocalTestUrl, page
340340
},
341341
},
342342
{
343-
key: 'sentry.message.param.0',
343+
key: 'sentry.message.parameter.0',
344344
value: {
345345
stringValue: 'fatal',
346346
},
347347
},
348348
{
349-
key: 'sentry.message.param.1',
349+
key: 'sentry.message.parameter.1',
350350
value: {
351351
stringValue: 'stringArg',
352352
},
353353
},
354354
{
355-
key: 'sentry.message.param.2',
355+
key: 'sentry.message.parameter.2',
356356
value: {
357357
boolValue: false,
358358
},
359359
},
360360
{
361-
key: 'sentry.message.param.3',
361+
key: 'sentry.message.parameter.3',
362362
value: {
363363
doubleValue: 123,
364364
},

‎packages/core/src/logs/exports.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ export function _INTERNAL_captureLog(
108108
const { __sentry_template_string__, __sentry_template_values__ = [] } = message;
109109
logAttributes['sentry.message.template'] = __sentry_template_string__;
110110
__sentry_template_values__.forEach((param, index) => {
111-
logAttributes[`sentry.message.param.${index}`] = param;
111+
logAttributes[`sentry.message.parameter.${index}`] = param;
112112
});
113113
}
114114

‎packages/core/test/lib/logs/exports.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,11 +206,11 @@ describe('_INTERNAL_captureLog', () => {
206206
value: { stringValue: 'Hello %s, welcome to %s' },
207207
}),
208208
expect.objectContaining({
209-
key: 'sentry.message.param.0',
209+
key: 'sentry.message.parameter.0',
210210
value: { stringValue: 'John' },
211211
}),
212212
expect.objectContaining({
213-
key: 'sentry.message.param.1',
213+
key: 'sentry.message.parameter.1',
214214
value: { stringValue: 'Sentry' },
215215
}),
216216
]),

‎packages/node/src/log.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ function captureLog(level: LogSeverityLevel, ...args: CaptureLogArgs): void {
2020
const attributes = { ...maybeAttributes };
2121
attributes['sentry.message.template'] = messageOrMessageTemplate;
2222
paramsOrAttributes.forEach((param, index) => {
23-
attributes[`sentry.message.param.${index}`] = param;
23+
attributes[`sentry.message.parameter.${index}`] = param;
2424
});
2525
const message = format(messageOrMessageTemplate, ...paramsOrAttributes);
2626
_INTERNAL_captureLog({ level, message, attributes });

‎packages/node/test/log.test.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ describe('Node Logger', () => {
9898
attributes: {
9999
userId: 123,
100100
'sentry.message.template': 'Hello %s, your balance is %d',
101-
'sentry.message.param.0': 'John',
102-
'sentry.message.param.1': 100,
101+
'sentry.message.parameter.0': 'John',
102+
'sentry.message.parameter.1': 100,
103103
},
104104
});
105105
});
@@ -111,8 +111,8 @@ describe('Node Logger', () => {
111111
message: 'User Alice logged in from mobile',
112112
attributes: {
113113
'sentry.message.template': 'User %s logged in from %s',
114-
'sentry.message.param.0': 'Alice',
115-
'sentry.message.param.1': 'mobile',
114+
'sentry.message.parameter.0': 'Alice',
115+
'sentry.message.parameter.1': 'mobile',
116116
},
117117
});
118118
});

0 commit comments

Comments
 (0)