Skip to content

Commit 6a6cdc8

Browse files
clean up cross-repo links (#207)
1 parent 5e8e882 commit 6a6cdc8

File tree

4 files changed

+38
-38
lines changed

4 files changed

+38
-38
lines changed

docs/reference/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The Node.js ECS logging formatters log structured JSON and support serialization
2020
```
2121

2222
::::{tip}
23-
Want to learn more about ECS, ECS logging, and other available language plugins? See the [ECS logging guide](ecs-logging://docs/reference/intro.md).
23+
Want to learn more about ECS, ECS logging, and other available language plugins? See the [ECS logging guide](ecs-logging://reference/intro.md).
2424
::::
2525

2626

docs/reference/morgan.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ mapped_pages:
55

66
# ECS Logging with Morgan [morgan]
77

8-
This Node.js package provides a formatter for the [morgan](https://github.com/expressjs/morgan#readme) logging middleware — commonly used with Express — compatible with [Elastic Common Schema (ECS) logging](ecs-logging://docs/reference/intro.md). In combination with the [Filebeat](https://www.elastic.co/beats/filebeat) shipper, you can [monitor all your logs](https://www.elastic.co/log-monitoring) in one place in the Elastic Stack.
8+
This Node.js package provides a formatter for the [morgan](https://github.com/expressjs/morgan#readme) logging middleware — commonly used with Express — compatible with [Elastic Common Schema (ECS) logging](ecs-logging://reference/intro.md). In combination with the [Filebeat](https://www.elastic.co/beats/filebeat) shipper, you can [monitor all your logs](https://www.elastic.co/log-monitoring) in one place in the Elastic Stack.
99

1010

1111
## Setup [_setup_3]
@@ -39,12 +39,12 @@ app.listen(3000);
3939

4040
### Step 3: Configure Filebeat [morgan-setup-step-3]
4141

42-
The best way to collect the logs once they are ECS-formatted is with [Filebeat](beats://docs/reference/filebeat/filebeat-overview.md):
42+
The best way to collect the logs once they are ECS-formatted is with [Filebeat](beats://reference/filebeat/filebeat-overview.md):
4343

4444
:::::::{tab-set}
4545

4646
::::::{tab-item} Log file
47-
1. Follow the [Filebeat quick start](beats://docs/reference/filebeat/filebeat-installation-configuration.md)
47+
1. Follow the [Filebeat quick start](beats://reference/filebeat/filebeat-installation-configuration.md)
4848
2. Add the following configuration to your `filebeat.yaml` file.
4949

5050
For Filebeat 7.16+
@@ -70,7 +70,7 @@ processors: <5>
7070
2. Values from the decoded JSON object overwrite the fields that {{filebeat}} normally adds (type, source, offset, etc.) in case of conflicts.
7171
3. {{filebeat}} adds an "error.message" and "error.type: json" key in case of JSON unmarshalling errors.
7272
4. {{filebeat}} will recursively de-dot keys in the decoded JSON, and expand them into a hierarchical object structure.
73-
5. Processors enhance your data. See [processors](beats://docs/reference/filebeat/filtering-enhancing-data.md) to learn more.
73+
5. Processors enhance your data. See [processors](beats://reference/filebeat/filtering-enhancing-data.md) to learn more.
7474
7575
7676
For Filebeat < 7.16
@@ -94,8 +94,8 @@ processors:
9494
9595
::::::{tab-item} Kubernetes
9696
1. Make sure your application logs to stdout/stderr.
97-
2. Follow the [Run Filebeat on Kubernetes](beats://docs/reference/filebeat/running-on-kubernetes.md) guide.
98-
3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
97+
2. Follow the [Run Filebeat on Kubernetes](beats://reference/filebeat/running-on-kubernetes.md) guide.
98+
3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
9999
4. Add these annotations to your pods that log using ECS loggers. This will make sure the logs are parsed appropriately.
100100

101101
```yaml
@@ -112,8 +112,8 @@ annotations:
112112

113113
::::::{tab-item} Docker
114114
1. Make sure your application logs to stdout/stderr.
115-
2. Follow the [Run Filebeat on Docker](beats://docs/reference/filebeat/running-on-docker.md) guide.
116-
3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md).
115+
2. Follow the [Run Filebeat on Docker](beats://reference/filebeat/running-on-docker.md) guide.
116+
3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md).
117117
4. Add these labels to your containers that log using ECS loggers. This will make sure the logs are parsed appropriately.
118118

119119
```yaml
@@ -129,7 +129,7 @@ labels:
129129
::::::
130130

131131
:::::::
132-
For more information, see the [Filebeat reference](beats://docs/reference/filebeat/configuring-howto-filebeat.md).
132+
For more information, see the [Filebeat reference](beats://reference/filebeat/configuring-howto-filebeat.md).
133133

134134

135135
## Usage [morgan-usage]
@@ -232,9 +232,9 @@ The `log.level` field will be "error" for response codes >= 500, otherwise "info
232232

233233
## Log correlation with APM [morgan-apm]
234234

235-
This ECS log formatter integrates with [Elastic APM](https://www.elastic.co/apm). If your Node app is using the [Node.js Elastic APM Agent](apm-agent-nodejs://docs/reference/index.md), then a number of fields are added to log records to correlate between APM services or traces and logging data:
235+
This ECS log formatter integrates with [Elastic APM](https://www.elastic.co/apm). If your Node app is using the [Node.js Elastic APM Agent](apm-agent-nodejs://reference/index.md), then a number of fields are added to log records to correlate between APM services or traces and logging data:
236236

237-
* Log statements (e.g. `logger.info(...)`) called when there is a current tracing span will include [tracing fields](ecs://docs/reference/ecs-tracing.md) — `trace.id`, `transaction.id`.
237+
* Log statements (e.g. `logger.info(...)`) called when there is a current tracing span will include [tracing fields](ecs://reference/ecs-tracing.md) — `trace.id`, `transaction.id`.
238238
* A number of service identifier fields determined by or configured on the APM agent allow cross-linking between services and logs in Kibana — `service.name`, `service.version`, `service.environment`, `service.node.name`.
239239
* `event.dataset` enables [log rate anomaly detection](docs-content://solutions/observability/logs/inspect-log-anomalies.md) in the Elastic Observability app.
240240

docs/reference/pino.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ mapped_pages:
55

66
# ECS Logging with Pino [pino]
77

8-
This Node.js package provides a formatter for the [pino](https://getpino.io) logger, compatible with [Elastic Common Schema (ECS) logging](ecs-logging://docs/reference/intro.md). In combination with the [Filebeat](https://www.elastic.co/beats/filebeat) shipper, you can [monitor all your logs](https://www.elastic.co/log-monitoring) in one place in the Elastic Stack. `pino` 6.x, 7.x, and 8.x versions are supported.
8+
This Node.js package provides a formatter for the [pino](https://getpino.io) logger, compatible with [Elastic Common Schema (ECS) logging](ecs-logging://reference/intro.md). In combination with the [Filebeat](https://www.elastic.co/beats/filebeat) shipper, you can [monitor all your logs](https://www.elastic.co/log-monitoring) in one place in the Elastic Stack. `pino` 6.x, 7.x, and 8.x versions are supported.
99

1010

1111
## Setup [_setup]
@@ -38,12 +38,12 @@ See usage discussion and examples below.
3838

3939
### Step 3: Configure Filebeat [pino-setup-step-3]
4040

41-
The best way to collect the logs once they are ECS-formatted is with [Filebeat](beats://docs/reference/filebeat/filebeat-overview.md):
41+
The best way to collect the logs once they are ECS-formatted is with [Filebeat](beats://reference/filebeat/filebeat-overview.md):
4242

4343
:::::::{tab-set}
4444

4545
::::::{tab-item} Log file
46-
1. Follow the [Filebeat quick start](beats://docs/reference/filebeat/filebeat-installation-configuration.md)
46+
1. Follow the [Filebeat quick start](beats://reference/filebeat/filebeat-installation-configuration.md)
4747
2. Add the following configuration to your `filebeat.yaml` file.
4848

4949
For Filebeat 7.16+
@@ -69,7 +69,7 @@ processors: <5>
6969
2. Values from the decoded JSON object overwrite the fields that {{filebeat}} normally adds (type, source, offset, etc.) in case of conflicts.
7070
3. {{filebeat}} adds an "error.message" and "error.type: json" key in case of JSON unmarshalling errors.
7171
4. {{filebeat}} will recursively de-dot keys in the decoded JSON, and expand them into a hierarchical object structure.
72-
5. Processors enhance your data. See [processors](beats://docs/reference/filebeat/filtering-enhancing-data.md) to learn more.
72+
5. Processors enhance your data. See [processors](beats://reference/filebeat/filtering-enhancing-data.md) to learn more.
7373
7474
7575
For Filebeat < 7.16
@@ -93,8 +93,8 @@ processors:
9393
9494
::::::{tab-item} Kubernetes
9595
1. Make sure your application logs to stdout/stderr.
96-
2. Follow the [Run Filebeat on Kubernetes](beats://docs/reference/filebeat/running-on-kubernetes.md) guide.
97-
3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
96+
2. Follow the [Run Filebeat on Kubernetes](beats://reference/filebeat/running-on-kubernetes.md) guide.
97+
3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
9898
4. Add these annotations to your pods that log using ECS loggers. This will make sure the logs are parsed appropriately.
9999

100100
```yaml
@@ -111,8 +111,8 @@ annotations:
111111

112112
::::::{tab-item} Docker
113113
1. Make sure your application logs to stdout/stderr.
114-
2. Follow the [Run Filebeat on Docker](beats://docs/reference/filebeat/running-on-docker.md) guide.
115-
3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md).
114+
2. Follow the [Run Filebeat on Docker](beats://reference/filebeat/running-on-docker.md) guide.
115+
3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md).
116116
4. Add these labels to your containers that log using ECS loggers. This will make sure the logs are parsed appropriately.
117117

118118
```yaml
@@ -128,7 +128,7 @@ labels:
128128
::::::
129129

130130
:::::::
131-
For more information, see the [Filebeat reference](beats://docs/reference/filebeat/configuring-howto-filebeat.md).
131+
For more information, see the [Filebeat reference](beats://reference/filebeat/configuring-howto-filebeat.md).
132132

133133

134134
## Usage [pino-usage]
@@ -157,7 +157,7 @@ Running this will produce log output similar to the following:
157157

158158
## Error Logging [pino-error-logging]
159159

160-
By default, the formatter will convert an `err` field that is an Error instance to [ECS Error fields](ecs://docs/reference/ecs-error.md). For example:
160+
By default, the formatter will convert an `err` field that is an Error instance to [ECS Error fields](ecs://reference/ecs-error.md). For example:
161161

162162
```js
163163
const { ecsFormat } = require('@elastic/ecs-pino-format');
@@ -218,7 +218,7 @@ server.listen(3000, () => {
218218
2. log with `req` and/or `res` fields
219219

220220

221-
This will produce logs with request and response info using [ECS HTTP fields](ecs://docs/reference/ecs-http.md). For example:
221+
This will produce logs with request and response info using [ECS HTTP fields](ecs://reference/ecs-http.md). For example:
222222

223223
```cmd
224224
% node examples/http.js | jq . # using jq for pretty printing
@@ -267,9 +267,9 @@ The [examples/ directory](https://github.com/elastic/ecs-logging-nodejs/tree/mai
267267

268268
## Log Correlation with APM [pino-apm]
269269

270-
This ECS log formatter integrates with [Elastic APM](https://www.elastic.co/apm). If your Node app is using the [Node.js Elastic APM Agent](apm-agent-nodejs://docs/reference/index.md), then a number of fields are added to log records to correlate between APM services or traces and logging data:
270+
This ECS log formatter integrates with [Elastic APM](https://www.elastic.co/apm). If your Node app is using the [Node.js Elastic APM Agent](apm-agent-nodejs://reference/index.md), then a number of fields are added to log records to correlate between APM services or traces and logging data:
271271

272-
* Log statements (e.g. `logger.info(...)`) called when there is a current tracing span will include [tracing fields](ecs://docs/reference/ecs-tracing.md) — `trace.id`, `transaction.id`, `span.id`.
272+
* Log statements (e.g. `logger.info(...)`) called when there is a current tracing span will include [tracing fields](ecs://reference/ecs-tracing.md) — `trace.id`, `transaction.id`, `span.id`.
273273
* A number of service identifier fields determined by or configured on the APM agent allow cross-linking between services and logs in Kibana — `service.name`, `service.version`, `service.environment`, `service.node.name`.
274274
* `event.dataset` enables [log rate anomaly detection](docs-content://solutions/observability/logs/inspect-log-anomalies.md) in the Elastic Observability app.
275275

docs/reference/winston.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ mapped_pages:
55

66
# ECS Logging with Winston [winston]
77

8-
This Node.js package provides a formatter for the [winston](https://github.com/winstonjs/winston#readme) logger, compatible with [Elastic Common Schema (ECS) logging](ecs-logging://docs/reference/intro.md). In combination with the [Filebeat](https://www.elastic.co/beats/filebeat) shipper, you can [monitor all your logs](https://www.elastic.co/log-monitoring) in one place in the Elastic Stack. `winston` 3.x versions >=3.3.3 are supported.
8+
This Node.js package provides a formatter for the [winston](https://github.com/winstonjs/winston#readme) logger, compatible with [Elastic Common Schema (ECS) logging](ecs-logging://reference/intro.md). In combination with the [Filebeat](https://www.elastic.co/beats/filebeat) shipper, you can [monitor all your logs](https://www.elastic.co/log-monitoring) in one place in the Elastic Stack. `winston` 3.x versions >=3.3.3 are supported.
99

1010

1111
## Setup [_setup_2]
@@ -41,12 +41,12 @@ logger.error('oops there is a problem', { err: new Error('boom') });
4141

4242
### Step 3: Configure Filebeat [winston-setup-step-3]
4343

44-
The best way to collect the logs once they are ECS-formatted is with [Filebeat](beats://docs/reference/filebeat/filebeat-overview.md):
44+
The best way to collect the logs once they are ECS-formatted is with [Filebeat](beats://reference/filebeat/filebeat-overview.md):
4545

4646
:::::::{tab-set}
4747

4848
::::::{tab-item} Log file
49-
1. Follow the [Filebeat quick start](beats://docs/reference/filebeat/filebeat-installation-configuration.md)
49+
1. Follow the [Filebeat quick start](beats://reference/filebeat/filebeat-installation-configuration.md)
5050
2. Add the following configuration to your `filebeat.yaml` file.
5151

5252
For Filebeat 7.16+
@@ -72,7 +72,7 @@ processors: <5>
7272
2. Values from the decoded JSON object overwrite the fields that {{filebeat}} normally adds (type, source, offset, etc.) in case of conflicts.
7373
3. {{filebeat}} adds an "error.message" and "error.type: json" key in case of JSON unmarshalling errors.
7474
4. {{filebeat}} will recursively de-dot keys in the decoded JSON, and expand them into a hierarchical object structure.
75-
5. Processors enhance your data. See [processors](beats://docs/reference/filebeat/filtering-enhancing-data.md) to learn more.
75+
5. Processors enhance your data. See [processors](beats://reference/filebeat/filtering-enhancing-data.md) to learn more.
7676
7777
7878
For Filebeat < 7.16
@@ -96,8 +96,8 @@ processors:
9696
9797
::::::{tab-item} Kubernetes
9898
1. Make sure your application logs to stdout/stderr.
99-
2. Follow the [Run Filebeat on Kubernetes](beats://docs/reference/filebeat/running-on-kubernetes.md) guide.
100-
3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
99+
2. Follow the [Run Filebeat on Kubernetes](beats://reference/filebeat/running-on-kubernetes.md) guide.
100+
3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
101101
4. Add these annotations to your pods that log using ECS loggers. This will make sure the logs are parsed appropriately.
102102

103103
```yaml
@@ -114,8 +114,8 @@ annotations:
114114

115115
::::::{tab-item} Docker
116116
1. Make sure your application logs to stdout/stderr.
117-
2. Follow the [Run Filebeat on Docker](beats://docs/reference/filebeat/running-on-docker.md) guide.
118-
3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md).
117+
2. Follow the [Run Filebeat on Docker](beats://reference/filebeat/running-on-docker.md) guide.
118+
3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md).
119119
4. Add these labels to your containers that log using ECS loggers. This will make sure the logs are parsed appropriately.
120120

121121
```yaml
@@ -131,7 +131,7 @@ labels:
131131
::::::
132132

133133
:::::::
134-
For more information, see the [Filebeat reference](beats://docs/reference/filebeat/configuring-howto-filebeat.md).
134+
For more information, see the [Filebeat reference](beats://reference/filebeat/configuring-howto-filebeat.md).
135135

136136
::::{note}
137137
You might like to try out our tutorial using Node.js ECS logging with winston: [Ingest logs from a Node.js web application using Filebeat](docs-content://manage-data/ingest/ingesting-data-from-applications/ingest-logs-from-nodejs-web-application-using-filebeat.md).
@@ -173,7 +173,7 @@ The formatter handles serialization to JSON, so you don’t need to add the [jso
173173

174174
## Error logging [winston-error-logging]
175175

176-
By default, the formatter will convert an `err` meta field that is an Error instance to [ECS Error fields](ecs://docs/reference/ecs-error.md). For [example](https://github.com/elastic/ecs-logging-nodejs/blob/main/packages/ecs-winston-format/examples/error.js):
176+
By default, the formatter will convert an `err` meta field that is an Error instance to [ECS Error fields](ecs://reference/ecs-error.md). For [example](https://github.com/elastic/ecs-logging-nodejs/blob/main/packages/ecs-winston-format/examples/error.js):
177177

178178
```js
179179
const winston = require('winston');
@@ -249,7 +249,7 @@ function handler (req, res) {
249249
2. log `req` and/or `res` meta fields
250250

251251

252-
This will produce logs with request and response info using [ECS HTTP fields](ecs://docs/reference/ecs-http.md). For [example](https://github.com/elastic/ecs-logging-nodejs/blob/main/packages/ecs-winston-format/examples/http.js):
252+
This will produce logs with request and response info using [ECS HTTP fields](ecs://reference/ecs-http.md). For [example](https://github.com/elastic/ecs-logging-nodejs/blob/main/packages/ecs-winston-format/examples/http.js):
253253

254254
```cmd
255255
% node examples/http.js | jq . # using jq for pretty printing
@@ -294,9 +294,9 @@ This will produce logs with request and response info using [ECS HTTP fields](ec
294294

295295
## Log Correlation with APM [winston-apm]
296296

297-
This ECS log formatter integrates with [Elastic APM](https://www.elastic.co/apm). If your Node app is using the [Node.js Elastic APM Agent](apm-agent-nodejs://docs/reference/index.md), then a number of fields are added to log records to correlate between APM services or traces and logging data:
297+
This ECS log formatter integrates with [Elastic APM](https://www.elastic.co/apm). If your Node app is using the [Node.js Elastic APM Agent](apm-agent-nodejs://reference/index.md), then a number of fields are added to log records to correlate between APM services or traces and logging data:
298298

299-
* Log statements (e.g. `logger.info(...)`) called when there is a current tracing span will include [tracing fields](ecs://docs/reference/ecs-tracing.md) — `trace.id`, `transaction.id`, `span.id`.
299+
* Log statements (e.g. `logger.info(...)`) called when there is a current tracing span will include [tracing fields](ecs://reference/ecs-tracing.md) — `trace.id`, `transaction.id`, `span.id`.
300300
* A number of service identifier fields determined by or configured on the APM agent allow cross-linking between services and logs in Kibana — `service.name`, `service.version`, `service.environment`, `service.node.name`.
301301
* `event.dataset` enables [log rate anomaly detection](docs-content://solutions/observability/logs/inspect-log-anomalies.md) in the Elastic Observability app.
302302

0 commit comments

Comments
 (0)