Skip to content

Commit e916a79

Browse files
authored
Apply suggestions from code review
1 parent dfa3a30 commit e916a79

File tree

2 files changed

+28
-28
lines changed

2 files changed

+28
-28
lines changed

docs/reference/pino.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -308,16 +308,16 @@ The hooks that Pino currently provides do not enable this package to convert fie
308308

309309
### `ecsFormat([options])` [pino-ref-ecsFormat]
310310

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`.
315-
* `apmIntegration` `{{type-boolean}}` Whether to enable APM agent integration. **Default:** `true`.
316-
* `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`.
315+
* `apmIntegration` `{type-boolean}` Whether to enable APM agent integration. **Default:** `true`.
316+
* `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}`.
321321

322322

323323
Create options for `pino(...)` that configures ECS Logging format output.

docs/reference/winston.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -336,16 +336,16 @@ The [ecs-logging spec](https://github.com/elastic/ecs-logging/tree/main/spec) su
336336

337337
### `ecsFormat([options])` [winston-ref-ecsFormat]
338338

339-
* `options` `{{type-object}}` The following options are supported:
339+
* `options` `{type-object}` The following options are supported:
340340

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`.
343-
* `apmIntegration` `{{type-boolean}}` Whether to enable APM agent integration. **Default:** `true`.
344-
* `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`.
343+
* `apmIntegration` `{type-boolean}` Whether to enable APM agent integration. **Default:** `true`.
344+
* `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}`.
349349

350350

351351
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:
@@ -371,16 +371,16 @@ const logger = winston.createLogger({
371371

372372
### `ecsFields([options])` [winston-ref-ecsFields]
373373

374-
* `options` `{{type-object}}` The following options are supported:
374+
* `options` `{type-object}` The following options are supported:
375375

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`.
378-
* `apmIntegration` `{{type-boolean}}` Whether to enable APM agent integration. **Default:** `true`.
379-
* `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`.
378+
* `apmIntegration` `{type-boolean}` Whether to enable APM agent integration. **Default:** `true`.
379+
* `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}`.
384384

385385

386386
Create a formatter for winston that converts fields on the log record info object to ECS Logging format.

0 commit comments

Comments
 (0)