Skip to content

Commit c5280ac

Browse files
clean up cross-repo links
1 parent d6cbb78 commit c5280ac

File tree

7 files changed

+19
-18
lines changed

7 files changed

+19
-18
lines changed

docs/docset.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ cross_links:
33
- apm-agent-rum-js
44
- apm-aws-lambda
55
- beats
6+
- docs-content
67
- ecs
78
- ecs-logging
89
- ecs-logging-python

docs/reference/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ For base `logging` from the standard library, the agent will get the root logger
189189

190190
If `structlog` is installed, the agent will override any configured processors with `ecs_logging.StructlogFormatter()`.
191191

192-
Note that this is a very blunt instrument that could have unintended side effects. If problems arise, please apply these formatters manually and leave this setting as `"off"`. See the [`ecs_logging` docs](ecs-logging-python://docs/reference/installation.md) for more information about using these formatters.
192+
Note that this is a very blunt instrument that could have unintended side effects. If problems arise, please apply these formatters manually and leave this setting as `"off"`. See the [`ecs_logging` docs](ecs-logging-python://reference/installation.md) for more information about using these formatters.
193193

194194
Also note that this setting does not facilitate shipping logs to Elasticsearch. We recommend [Filebeat](https://www.elastic.co/beats/filebeat) for that purpose.
195195

docs/reference/django-support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ elasticApm.init({
149149
})
150150
```
151151

152-
See the [JavaScript RUM agent documentation](apm-agent-rum-js://docs/reference/index.md) for more information.
152+
See the [JavaScript RUM agent documentation](apm-agent-rum-js://reference/index.md) for more information.
153153

154154

155155
## Enabling and disabling the agent [django-enabling-and-disabling-the-agent]
@@ -171,7 +171,7 @@ ELASTIC_APM = {
171171
To easily send Python `logging` messages as "error" objects to Elasticsearch, we provide a `LoggingHandler` which you can use in your logging setup. The log messages will be enriched with a stack trace, data from the request, and more.
172172

173173
::::{note}
174-
the intended use case for this handler is to send high priority log messages (e.g. log messages with level `ERROR`) to Elasticsearch. For normal log shipping, we recommend using [filebeat](beats://docs/reference/filebeat/filebeat-overview.md).
174+
the intended use case for this handler is to send high priority log messages (e.g. log messages with level `ERROR`) to Elasticsearch. For normal log shipping, we recommend using [filebeat](beats://reference/filebeat/filebeat-overview.md).
175175
::::
176176

177177

docs/reference/flask-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ elasticApm.init({
206206
})
207207
```
208208

209-
See the [JavaScript RUM agent documentation](apm-agent-rum-js://docs/reference/index.md) for more information.
209+
See the [JavaScript RUM agent documentation](apm-agent-rum-js://reference/index.md) for more information.
210210

211211

212212
## Supported Flask and Python versions [supported-flask-and-python-versions]

docs/reference/lambda-support.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ window.addEventListener("DOMContentLoaded", async () => {
215215
'COPY --from=python-agent /opt/python/ /opt/python/');
216216
});
217217
</script>
218-
Both the [{{apm-lambda-ext}}](apm-aws-lambda://docs/reference/index.md) and the Python APM Agent are added to your Lambda function as [AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.md). Therefore, you need to add the corresponding Layer ARNs (identifiers) to your Lambda function.
218+
Both the [{{apm-lambda-ext}}](apm-aws-lambda://reference/index.md) and the Python APM Agent are added to your Lambda function as [AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/invocation-layers.md). Therefore, you need to add the corresponding Layer ARNs (identifiers) to your Lambda function.
219219

220220
:::::::{tab-set}
221221

@@ -308,7 +308,7 @@ The {{apm-lambda-ext}} and the APM Python agent are configured through environme
308308

309309
For the minimal configuration, you will need the *APM Server URL* to set the destination for APM data and an *{{apm-guide-ref}}/secret-token.html[APM Secret Token]*. If you prefer to use an [APM API key](docs-content://solutions/observability/apps/api-keys.md) instead of the APM secret token, use the `ELASTIC_APM_API_KEY` environment variable instead of `ELASTIC_APM_SECRET_TOKEN` in the following configuration.
310310

311-
For production environments, we recommend [using the AWS Secrets Manager to store your APM authentication key](apm-aws-lambda://docs/reference/aws-lambda-secrets-manager.md) instead of providing the secret value as plaintext in the environment variables.
311+
For production environments, we recommend [using the AWS Secrets Manager to store your APM authentication key](apm-aws-lambda://reference/aws-lambda-secrets-manager.md) instead of providing the secret value as plaintext in the environment variables.
312312

313313
:::::::{tab-set}
314314

@@ -330,7 +330,7 @@ ELASTIC_APM_SEND_STRATEGY = background <4>
330330
1. Use this exact fixed value.
331331
2. This is your APM Server URL.
332332
3. This is your APM secret token.
333-
4. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://docs/reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios.
333+
4. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios.
334334

335335
![Python environment variables configuration section in AWS Console](../images/python-lambda-env-vars.png "")
336336
::::::
@@ -363,7 +363,7 @@ Resources:
363363
...
364364
```
365365

366-
1. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://docs/reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios.
366+
1. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios.
367367

368368
::::::
369369

@@ -383,7 +383,7 @@ functions:
383383
...
384384
```
385385

386-
1. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://docs/reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios.
386+
1. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios.
387387

388388
::::::
389389

@@ -406,7 +406,7 @@ resource "aws_lambda_function" "your_lambda_function" {
406406
...
407407
```
408408

409-
1. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://docs/reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios.
409+
1. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios.
410410

411411
::::::
412412

@@ -423,13 +423,13 @@ ELASTIC_APM_SEND_STRATEGY = background <4>
423423
1. Use this exact fixed value.
424424
2. This is your APM Server URL.
425425
3. This is your APM secret token.
426-
4. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://docs/reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios.
426+
4. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios.
427427

428428
::::::
429429

430430
:::::::
431431

432-
You can optionally [fine-tune the Python agent](/reference/configuration.md) or the [configuration of the {{apm-lambda-ext}}](apm-aws-lambda://docs/reference/aws-lambda-config-options.md).
432+
You can optionally [fine-tune the Python agent](/reference/configuration.md) or the [configuration of the {{apm-lambda-ext}}](apm-aws-lambda://reference/aws-lambda-config-options.md).
433433

434434
That’s it. After following the steps above, you’re ready to go! Your Lambda function invocations should be traced from now on. Spans will be captured for [supported technologies](/reference/supported-technologies.md). You can also use [`capture_span`](/reference/api-reference.md#api-capture-span) to capture custom spans, and you can retrieve the `Client` object for capturing exceptions/messages using [`get_client`](/reference/api-reference.md#api-get-client).
435435

docs/reference/logs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ mapped_pages:
88
Elastic Python APM Agent provides the following log features:
99

1010
* [Log correlation](#log-correlation-ids) : Automatically inject correlation IDs that allow navigation between logs, traces and services.
11-
* [Log reformatting (experimental)](#log-reformatting) : Automatically reformat plaintext logs in [ECS logging](ecs-logging://docs/reference/intro.md) format.
11+
* [Log reformatting (experimental)](#log-reformatting) : Automatically reformat plaintext logs in [ECS logging](ecs-logging://reference/intro.md) format.
1212

1313
::::{note}
1414
Elastic Python APM Agent does not send the logs to Elasticsearch. It only injects correlation IDs and reformats the logs. You must use another ingestion strategy. We recommend [Filebeat](https://www.elastic.co/beats/filebeat) for that purpose.
@@ -17,7 +17,7 @@ Elastic Python APM Agent does not send the logs to Elasticsearch. It only inject
1717

1818
Those features are part of [Application log ingestion strategies](docs-content://solutions/observability/logs/stream-application-logs.md).
1919

20-
The [`ecs-logging-python`](ecs-logging-python://docs/reference/index.md) library can also be used to use the [ECS logging](ecs-logging://docs/reference/intro.md) format without an APM agent. When deployed with the Python APM agent, the agent will provide [log correlation](#log-correlation-ids) IDs.
20+
The [`ecs-logging-python`](ecs-logging-python://reference/index.md) library can also be used to use the [ECS logging](ecs-logging://reference/intro.md) format without an APM agent. When deployed with the Python APM agent, the agent will provide [log correlation](#log-correlation-ids) IDs.
2121

2222

2323
## Log correlation [log-correlation-ids]
@@ -41,7 +41,7 @@ We use [`logging.setLogRecordFactory()`](https://docs.python.org/3/library/loggi
4141
* `elasticapm_trace_id`
4242
* `elasticapm_span_id`
4343

44-
This factory also adds these fields to a dictionary attribute, `elasticapm_labels`, using the official ECS [tracing fields](ecs://docs/reference/ecs-tracing.md).
44+
This factory also adds these fields to a dictionary attribute, `elasticapm_labels`, using the official ECS [tracing fields](ecs://reference/ecs-tracing.md).
4545

4646
You can disable this automatic behavior by using the [`disable_log_record_factory`](/reference/configuration.md#config-generic-disable-log-record-factory) setting in your configuration.
4747

@@ -81,7 +81,7 @@ In order to correlate logs from your app with transactions captured by the Elast
8181

8282
If you’re using structured logging, either [with a custom solution](https://docs.python.org/3/howto/logging-cookbook.md#implementing-structured-logging) or with [structlog](http://www.structlog.org/en/stable/) (recommended), then this is fairly easy. Throw the [JSONRenderer](http://www.structlog.org/en/stable/api.md#structlog.processors.JSONRenderer) in, and use [Filebeat](https://www.elastic.co/blog/structured-logging-filebeat) to pull these logs into Elasticsearch.
8383

84-
Without structured logging the task gets a little trickier. Here we recommend first making sure your LogRecord objects have the elasticapm attributes (see [`logging`](#logging)), and then you’ll want to combine some specific formatting with a Grok pattern, either in Elasticsearch using [the grok processor](elasticsearch://docs/reference/ingestion-tools/enrich-processor/grok-processor.md), or in [logstash with a plugin](logstash://docs/reference/plugins-filters-grok.md).
84+
Without structured logging the task gets a little trickier. Here we recommend first making sure your LogRecord objects have the elasticapm attributes (see [`logging`](#logging)), and then you’ll want to combine some specific formatting with a Grok pattern, either in Elasticsearch using [the grok processor](elasticsearch://reference/ingestion-tools/enrich-processor/grok-processor.md), or in [logstash with a plugin](logstash://reference/plugins-filters-grok.md).
8585

8686
Say you have a [Formatter](https://docs.python.org/3/library/logging.md#logging.Formatter) that looks like this:
8787

@@ -114,7 +114,7 @@ formatstring = formatstring + " | elasticapm " \
114114
"span.id=%(elasticapm_span_id)s"
115115
```
116116

117-
Then, you could use a grok pattern like this (for the [Elasticsearch Grok Processor](elasticsearch://docs/reference/ingestion-tools/enrich-processor/grok-processor.md)):
117+
Then, you could use a grok pattern like this (for the [Elasticsearch Grok Processor](elasticsearch://reference/ingestion-tools/enrich-processor/grok-processor.md)):
118118

119119
```json
120120
{

docs/reference/upgrading-5.x.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ APM Server and Kibana 7.3 introduced support for collecting breakdown metrics, a
1212

1313
## Tags renamed to Labels [_tags_renamed_to_labels]
1414

15-
To better align with other parts of the Elastic Stack and the [Elastic Common Schema](ecs://docs/reference/index.md), we renamed "tags" to "labels", and introduced limited support for typed labels. While tag values were only allowed to be strings, label values can be strings, booleans, or numerical.
15+
To better align with other parts of the Elastic Stack and the [Elastic Common Schema](ecs://reference/index.md), we renamed "tags" to "labels", and introduced limited support for typed labels. While tag values were only allowed to be strings, label values can be strings, booleans, or numerical.
1616

1717
To benefit from this change, ensure that you run at least **APM Server 6.7**, and use `elasticapm.label()` instead of `elasticapm.tag()`. The `tag()` API will continue to work as before, but emit a `DeprecationWarning`. It will be removed in 6.0 of the agent.
1818

0 commit comments

Comments
 (0)