Skip to content

Commit e412a60

Browse files
[docs] Clean up cross-repo links (#159)
* clean up cross-repo links * add docs-content to cross_links
1 parent 21d1557 commit e412a60

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

docs/docset.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ project: 'ECS Logging Python'
22
cross_links:
33
- apm-agent-python
44
- beats
5+
- docs-content
56
- ecs
67
- ecs-logging
78
toc:

docs/reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ mapped_pages:
99
ECS loggers are formatter/encoder plugins for your favorite logging libraries. They make it easy to format your logs into ECS-compatible JSON.
1010

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

1515

docs/reference/installation.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -176,9 +176,9 @@ logger.debug("Example message!")
176176

177177
## Elastic APM log correlation [correlation]
178178

179-
`ecs-logging-python` supports automatically collecting [ECS tracing fields](ecs://docs/reference/ecs-tracing.md) from the [Elastic APM Python agent](https://github.com/elastic/apm-agent-python) in order to [correlate logs to spans, transactions and traces](apm-agent-python://docs/reference/logs.md) in Elastic APM.
179+
`ecs-logging-python` supports automatically collecting [ECS tracing fields](ecs://reference/ecs-tracing.md) from the [Elastic APM Python agent](https://github.com/elastic/apm-agent-python) in order to [correlate logs to spans, transactions and traces](apm-agent-python://reference/logs.md) in Elastic APM.
180180

181-
You can also quickly turn on ECS-formatted logs in your python app by setting [`LOG_ECS_REFORMATTING=override`](apm-agent-python://docs/reference/configuration.md#config-log_ecs_reformatting) in the Elastic APM Python agent.
181+
You can also quickly turn on ECS-formatted logs in your python app by setting [`LOG_ECS_REFORMATTING=override`](apm-agent-python://reference/configuration.md#config-log_ecs_reformatting) in the Elastic APM Python agent.
182182

183183

184184
## Install Filebeat [filebeat]
@@ -188,7 +188,7 @@ The best way to collect the logs once they are ECS-formatted is with [Filebeat](
188188
:::::::{tab-set}
189189

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

194194
For Filebeat 7.16+
@@ -214,7 +214,7 @@ processors: <5>
214214
2. Values from the decoded JSON object overwrite the fields that {{filebeat}} normally adds (type, source, offset, etc.) in case of conflicts.
215215
3. {{filebeat}} adds an "error.message" and "error.type: json" key in case of JSON unmarshalling errors.
216216
4. {{filebeat}} will recursively de-dot keys in the decoded JSON, and expand them into a hierarchical object structure.
217-
5. Processors enhance your data. See [processors](beats://docs/reference/filebeat/filtering-enhancing-data.md) to learn more.
217+
5. Processors enhance your data. See [processors](beats://reference/filebeat/filtering-enhancing-data.md) to learn more.
218218
219219
220220
For Filebeat < 7.16
@@ -238,8 +238,8 @@ processors:
238238
239239
::::::{tab-item} Kubernetes
240240
1. Make sure your application logs to stdout/stderr.
241-
2. Follow the [Run Filebeat on Kubernetes](beats://docs/reference/filebeat/running-on-kubernetes.md) guide.
242-
3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
241+
2. Follow the [Run Filebeat on Kubernetes](beats://reference/filebeat/running-on-kubernetes.md) guide.
242+
3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
243243
4. Add these annotations to your pods that log using ECS loggers. This will make sure the logs are parsed appropriately.
244244

245245
```yaml
@@ -256,8 +256,8 @@ annotations:
256256

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

263263
```yaml
@@ -273,5 +273,5 @@ labels:
273273
::::::
274274

275275
:::::::
276-
For more information, see the [Filebeat reference](beats://docs/reference/filebeat/configuring-howto-filebeat.md).
276+
For more information, see the [Filebeat reference](beats://reference/filebeat/configuring-howto-filebeat.md).
277277

0 commit comments

Comments
 (0)