You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/pino.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -308,16 +308,16 @@ The hooks that Pino currently provides do not enable this package to convert fie
308
308
309
309
### `ecsFormat([options])` [pino-ref-ecsFormat]
310
310
311
-
* `options` `{{type-object}}` The following options are supported:
312
-
313
-
* `convertErr` `{{type-boolean}}` Whether to convert a logged `err` field to ECS error fields. **Default:** `true`.
314
-
* `convertReqRes` `{{type-boolean}}` Whether to logged `req` and `res` HTTP request and response fields to ECS HTTP, User agent, and URL fields. **Default:** `false`.
* `serviceName` `{{type-string}}` A "service.name" value. If specified this overrides any value from an active APM agent.
317
-
* `serviceVersion` `{{type-string}}` A "service.version" value. If specified this overrides any value from an active APM agent.
318
-
* `serviceEnvironment` `{{type-string}}` A "service.environment" value. If specified this overrides any value from an active APM agent.
319
-
* `serviceNodeName` `{{type-string}}` A "service.node.name" value. If specified this overrides any value from an active APM agent.
320
-
* `eventDataset` `{{type-string}}` A "event.dataset" value. If specified this overrides the default of using `${serviceVersion}`.
311
+
* `options` `{type-object}` The following options are supported:
312
+
313
+
* `convertErr` `{type-boolean}` Whether to convert a logged `err` field to ECS error fields. **Default:** `true`.
314
+
* `convertReqRes` `{type-boolean}` Whether to logged `req` and `res` HTTP request and response fields to ECS HTTP, User agent, and URL fields. **Default:** `false`.
* `options` `{{type-object}}` The following options are supported:
339
+
* `options` `{type-object}` The following options are supported:
340
340
341
-
* `convertErr` `{{type-boolean}}` Whether to convert a logged `err` field to ECS error fields. **Default:** `true`.
342
-
* `convertReqRes` `{{type-boolean}}` Whether to logged `req` and `res` HTTP request and response fields to ECS HTTP, User agent, and URL fields. **Default:** `false`.
* `serviceName` `{{type-string}}` A "service.name" value. If specified this overrides any value from an active APM agent.
345
-
* `serviceVersion` `{{type-string}}` A "service.version" value. If specified this overrides any value from an active APM agent.
346
-
* `serviceEnvironment` `{{type-string}}` A "service.environment" value. If specified this overrides any value from an active APM agent.
347
-
* `serviceNodeName` `{{type-string}}` A "service.node.name" value. If specified this overrides any value from an active APM agent.
348
-
* `eventDataset` `{{type-string}}` A "event.dataset" value. If specified this overrides the default of using `${serviceVersion}`.
341
+
* `convertErr` `{type-boolean}` Whether to convert a logged `err` field to ECS error fields. **Default:** `true`.
342
+
* `convertReqRes` `{type-boolean}` Whether to logged `req` and `res` HTTP request and response fields to ECS HTTP, User agent, and URL fields. **Default:** `false`.
* `serviceName` `{type-string}` A "service.name" value. If specified this overrides any value from an active APM agent.
345
+
* `serviceVersion` `{type-string}` A "service.version" value. If specified this overrides any value from an active APM agent.
346
+
* `serviceEnvironment` `{type-string}` A "service.environment" value. If specified this overrides any value from an active APM agent.
347
+
* `serviceNodeName` `{type-string}` A "service.node.name" value. If specified this overrides any value from an active APM agent.
348
+
* `eventDataset` `{type-string}` A "event.dataset" value. If specified this overrides the default of using `${serviceVersion}`.
349
349
350
350
351
351
Create a formatter for winston that emits in ECS Logging format. This is a single format that handles both [`ecsFields([options])`](#winston-ref-ecsFields) and [`ecsStringify([options])`](#winston-ref-ecsStringify). The following two are equivalent:
* `options` `{{type-object}}` The following options are supported:
374
+
* `options` `{type-object}` The following options are supported:
375
375
376
-
* `convertErr` `{{type-boolean}}` Whether to convert a logged `err` field to ECS error fields. **Default:** `true`.
377
-
* `convertReqRes` `{{type-boolean}}` Whether to logged `req` and `res` HTTP request and response fields to ECS HTTP, User agent, and URL fields. **Default:** `false`.
* `serviceName` `{{type-string}}` A "service.name" value. If specified this overrides any value from an active APM agent.
380
-
* `serviceVersion` `{{type-string}}` A "service.version" value. If specified this overrides any value from an active APM agent.
381
-
* `serviceEnvironment` `{{type-string}}` A "service.environment" value. If specified this overrides any value from an active APM agent.
382
-
* `serviceNodeName` `{{type-string}}` A "service.node.name" value. If specified this overrides any value from an active APM agent.
383
-
* `eventDataset` `{{type-string}}` A "event.dataset" value. If specified this overrides the default of using `${serviceVersion}`.
376
+
* `convertErr` `{type-boolean}` Whether to convert a logged `err` field to ECS error fields. **Default:** `true`.
377
+
* `convertReqRes` `{type-boolean}` Whether to logged `req` and `res` HTTP request and response fields to ECS HTTP, User agent, and URL fields. **Default:** `false`.
0 commit comments