Skip to content

Commit 5901caf

Browse files
authored
fix: paramaterized -> parameterized (#15193)
resolves #14948 small spelling mistake!
1 parent 535468b commit 5901caf

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

develop-docs/sdk/telemetry/logs.mdx

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ By default the SDK should attach the following attributes to a log:
288288
}
289289
```
290290

291-
If the log was paramaterized the SDK should attach the following
291+
If the log was parameterized the SDK should attach the following
292292

293293
1. `sentry.message.template`: The parameterized template string
294294
2. `sentry.message.parameter.X`: The parameters to the template string. X can either be the number that represent the parameter's position in the template string (`sentry.message.parameter.0`, `sentry.message.parameter.1`, etc) or the parameter's name (`sentry.message.parameter.item_id`, `sentry.message.parameter.user_id`, etc)
@@ -312,13 +312,16 @@ Logs can be generated in three ways:
312312
1. User calls Sentry’s Logging API directly: SDKs MUST NOT send a `sentry.origin`. As logs are charged based on size, we want to minimize the size of logs, and we **intentionally deviate** from the original [Trace Origin](/sdk/telemetry/traces/trace-origin/) documentation.
313313

314314
2. Captured from a logging library: Use `auto.log.<name>` format. where `<name>` is the relevant integration. For example, the .NET Serilog library emits:
315-
```json
316-
{ "sentry.origin": "auto.log.serilog" }
317-
```
315+
316+
```json
317+
{ "sentry.origin": "auto.log.serilog" }
318+
```
319+
318320
3. Auto-emitted logs from other instrumented systems: Use the `auto.<category>.<integration-name>` format as outlined in [Trace Origin](/sdk/telemetry/traces/trace-origin/) documentation.
319-
```json
320-
{ "sentry.origin": "auto.db.prisma" }
321-
```
321+
322+
```json
323+
{ "sentry.origin": "auto.db.prisma" }
324+
```
322325

323326
#### User Attributes
324327

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Message Template Attributes
22

3-
If the log was paramaterized, Sentry adds the message template and parameters as log attributes.
3+
If the log was parameterized, Sentry adds the message template and parameters as log attributes.
44

55
- `message.template`: The parameterized template string. This is sent from the SDK as `sentry.message.template`.
66
- `message.parameter.X`: The parameters to fill the template string. X can either be the number that represent the parameter's position in the template string (`sentry.message.parameter.0`, `sentry.message.parameter.1`, etc) or the parameter's name (`sentry.message.parameter.item_id`, `sentry.message.parameter.user_id`, etc). This is sent from the SDK as `sentry.message.parameter.X`.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
### Message Template Attributes
22

3-
If the log was paramaterized (like with `Sentry.logger().error("A %s log message", "formatted");`), Sentry adds the message template and parameters as log attributes.
3+
If the log was parameterized (like with `Sentry.logger().error("A %s log message", "formatted");`), Sentry adds the message template and parameters as log attributes.

0 commit comments

Comments
 (0)