Skip to content

Commit 5c8c776

Browse files
fix external links that should contain .html
1 parent a449883 commit 5c8c776

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

docs/reference/api-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ except ValueError:
6262
client.capture_exception()
6363
```
6464

65-
* `exc_info`: A `(type, value, traceback)` tuple as returned by [`sys.exc_info()`](https://docs.python.org/3/library/sys.md#sys.exc_info). If not provided, it will be captured automatically.
65+
* `exc_info`: A `(type, value, traceback)` tuple as returned by [`sys.exc_info()`](https://docs.python.org/3/library/sys.html#sys.exc_info). If not provided, it will be captured automatically.
6666
* `date`: A `datetime.datetime` object representing the occurrence time of the error. If left empty, it defaults to `datetime.datetime.utcnow()`.
6767
* `context`: A dictionary with contextual information. This dictionary must follow the [Context](docs-content://solutions/observability/apps/elastic-apm-events-intake-api.md#apm-api-error) schema definition.
6868
* `custom`: A dictionary of custom data you want to attach to the event.
@@ -92,7 +92,7 @@ client.capture_message('Billing process succeeded.')
9292
```
9393

9494
* `stack`: If set to `True` (the default), a stacktrace from the call site will be captured.
95-
* `exc_info`: A `(type, value, traceback)` tuple as returned by [`sys.exc_info()`](https://docs.python.org/3/library/sys.md#sys.exc_info). If not provided, it will be captured automatically, if `capture_message()` was called in an `except` block.
95+
* `exc_info`: A `(type, value, traceback)` tuple as returned by [`sys.exc_info()`](https://docs.python.org/3/library/sys.html#sys.exc_info). If not provided, it will be captured automatically, if `capture_message()` was called in an `except` block.
9696
* `date`: A `datetime.datetime` object representing the occurrence time of the error. If left empty, it defaults to `datetime.datetime.utcnow()`.
9797
* `context`: A dictionary with contextual information. This dictionary must follow the [Context](docs-content://solutions/observability/apps/elastic-apm-events-intake-api.md#apm-api-error) schema definition.
9898
* `custom`: A dictionary of custom data you want to attach to the event.

docs/reference/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -699,7 +699,7 @@ This setting will be automatically rounded to 4 decimals of precision.
699699
| `ELASTIC_APM_INCLUDE_PATHS` | `INCLUDE_PATHS` | `[]` |
700700
| multiple values separated by commas, without spaces | | |
701701

702-
A set of paths, optionally using shell globs (see [`fnmatch`](https://docs.python.org/3/library/fnmatch.md) for a description of the syntax). These are matched against the absolute filename of every frame, and if a pattern matches, the frame is considered to be an "in-app frame".
702+
A set of paths, optionally using shell globs (see [`fnmatch`](https://docs.python.org/3/library/fnmatch.html) for a description of the syntax). These are matched against the absolute filename of every frame, and if a pattern matches, the frame is considered to be an "in-app frame".
703703

704704
`include_paths` **takes precedence** over `exclude_paths`.
705705

@@ -711,7 +711,7 @@ A set of paths, optionally using shell globs (see [`fnmatch`](https://docs.pytho
711711
| `ELASTIC_APM_EXCLUDE_PATHS` | `EXCLUDE_PATHS` | Varies on Python version and implementation |
712712
| multiple values separated by commas, without spaces | | |
713713

714-
A set of paths, optionally using shell globs (see [`fnmatch`](https://docs.python.org/3/library/fnmatch.md) for a description of the syntax). These are matched against the absolute filename of every frame, and if a pattern matches, the frame is considered to be a "library frame".
714+
A set of paths, optionally using shell globs (see [`fnmatch`](https://docs.python.org/3/library/fnmatch.html) for a description of the syntax). These are matched against the absolute filename of every frame, and if a pattern matches, the frame is considered to be a "library frame".
715715

716716
`include_paths` **takes precedence** over `exclude_paths`.
717717

@@ -1018,7 +1018,7 @@ This is useful if `HTTP_PROXY` / `HTTPS_PROXY` is set for other reasons than age
10181018

10191019
### `SSL_CERT_FILE` and `SSL_CERT_DIR` [config-ssl-cert-file]
10201020

1021-
To tell the agent to use a different SSL certificate, you can use these environment variables. See also [OpenSSL docs](https://www.openssl.org/docs/manmaster/man7/openssl-env.md#SSL_CERT_DIR-SSL_CERT_FILE).
1021+
To tell the agent to use a different SSL certificate, you can use these environment variables. See also [OpenSSL docs](https://www.openssl.org/docs/manmaster/man7/openssl-env.html#SSL_CERT_DIR-SSL_CERT_FILE).
10221022

10231023
Please note that these variables may apply to other SSL/TLS communication in your service, not just related to the APM agent.
10241024

docs/reference/django-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ except MyModel.DoesNotExist:
263263

264264
## Celery integration [django-celery-integration]
265265

266-
For a general guide on how to set up Django with Celery, head over to Celery’s [Django documentation](http://celery.readthedocs.org/en/latest/django/first-steps-with-django.md#django-first-steps).
266+
For a general guide on how to set up Django with Celery, head over to Celery’s [Django documentation](http://celery.readthedocs.org/en/latest/django/first-steps-with-django.html#django-first-steps).
267267

268268
Elastic APM will automatically log errors from your celery tasks, record performance data and keep the trace.id when the task is launched from an already started Elastic transaction.
269269

docs/reference/flask-support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For apm-server 6.2+, make sure you use version 2.0 or higher of `elastic-apm`.
2424

2525

2626
::::{note}
27-
If you use Flask with uwsgi, make sure to [enable threads](http://uwsgi-docs.readthedocs.org/en/latest/Options.md#enable-threads).
27+
If you use Flask with uwsgi, make sure to [enable threads](http://uwsgi-docs.readthedocs.org/en/latest/Options.html#enable-threads).
2828
::::
2929

3030

docs/reference/lambda-support.md

Lines changed: 1 addition & 1 deletion
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://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.html). Therefore, you need to add the corresponding Layer ARNs (identifiers) to your Lambda function.
219219

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

docs/reference/logs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The Agent provides integrations with both the default Python logging library, as
3535

3636
#### `logging` [logging]
3737

38-
We use [`logging.setLogRecordFactory()`](https://docs.python.org/3/library/logging.md#logging.setLogRecordFactory) to decorate the default LogRecordFactory to automatically add new attributes to each LogRecord object:
38+
We use [`logging.setLogRecordFactory()`](https://docs.python.org/3/library/logging.html#logging.setLogRecordFactory) to decorate the default LogRecordFactory to automatically add new attributes to each LogRecord object:
3939

4040
* `elasticapm_transaction_id`
4141
* `elasticapm_trace_id`
@@ -48,7 +48,7 @@ You can disable this automatic behavior by using the [`disable_log_record_factor
4848

4949
#### `structlog` [structlog]
5050

51-
We provide a [processor](http://www.structlog.org/en/stable/processors.md) for [`structlog`](http://www.structlog.org/en/stable/) which will add three new keys to the event_dict of any processed event:
51+
We provide a [processor](http://www.structlog.org/en/stable/processors.html) for [`structlog`](http://www.structlog.org/en/stable/) which will add three new keys to the event_dict of any processed event:
5252

5353
* `transaction.id`
5454
* `trace.id`
@@ -79,11 +79,11 @@ In order to correlate logs from your app with transactions captured by the Elast
7979
* `trace.id`
8080
* `span.id`
8181

82-
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.
82+
If you’re using structured logging, either [with a custom solution](https://docs.python.org/3/howto/logging-cookbook.html#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.html#structlog.processors.JSONRenderer) in, and use [Filebeat](https://www.elastic.co/blog/structured-logging-filebeat) to pull these logs into Elasticsearch.
8383

8484
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

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

8888
```python
8989
import logging

docs/reference/opentelemetry-api-bridge.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ with tracer.start_as_current_span("test"):
5050
* `elasticapm_client`: an already instantiated Elastic APM client
5151
* `config`: a configuration dictionary, which will be used to instantiate a new Elastic APM client, e.g. `{"SERVER_URL": "https://example.org"}`. See [configuration](/reference/configuration.md) for more information.
5252

53-
The `Tracer` object mirrors the upstream interface on the [OpenTelemetry `Tracer` object.](https://opentelemetry-python.readthedocs.io/en/latest/api/trace.md#opentelemetry.trace.Tracer)
53+
The `Tracer` object mirrors the upstream interface on the [OpenTelemetry `Tracer` object.](https://opentelemetry-python.readthedocs.io/en/latest/api/trace.html#opentelemetry.trace.Tracer)
5454

5555

5656
## Caveats [opentelemetry-caveats]

docs/release-notes/breaking-changes.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ navigation_title: "Elastic APM Python Agent"
33
---
44

55
# Elastic APM Python Agent breaking changes [elastic-apm-python-agent-breaking-changes]
6-
Before you upgrade, carefully review the Elastic APM RPython Agent breaking changes and take the necessary steps to mitigate any issues.
6+
Before you upgrade, carefully review the Elastic APM RPython Agent breaking changes and take the necessary steps to mitigate any issues.
77

88
To learn how to upgrade, check out <uprade docs>.
99

1010
% ## Next version [elastic-apm-python-agent-nextversion-breaking-changes]
1111
% **Release date:** Month day, year
1212

13-
% ::::{dropdown} Title of breaking change
13+
% ::::{dropdown} Title of breaking change
1414
% Description of the breaking change.
1515
% For more information, check [PR #](PR link).
1616
% **Impact**<br> Impact of the breaking change.
@@ -20,9 +20,9 @@ To learn how to upgrade, check out <uprade docs>.
2020
## 6.0.0 [elastic-apm-python-agent-600-breaking-changes]
2121
**Release date:** February 1, 2021
2222

23-
* Python 2.7 and 3.5 support has been deprecated. The Python agent now requires Python 3.6+. For more information, check [#1021](https://github.com/elastic/apm-agent-python/pull/1021).
24-
* No longer collecting body for `elasticsearch-py` update and `delete_by_query`. For more information, check [#1013](https://github.com/elastic/apm-agent-python/pull/1013).
25-
* Align `sanitize_field_names` config with the [cross-agent spec](https://github.com/elastic/apm/blob/3fa78e2a1eeea81c73c2e16e96dbf6b2e79f3c64/specs/agents/sanitization.md). If you are using a non-default `sanitize_field_names`, surrounding each of your entries with stars (e.g. `*secret*`) will retain the old behavior. For more information, check [#982](https://github.com/elastic/apm-agent-python/pull/982).
26-
* Remove credit card sanitization for field values. This improves performance, and the security value of this check was dubious anyway. For more information, check [#982](https://github.com/elastic/apm-agent-python/pull/982).
23+
* Python 2.7 and 3.5 support has been deprecated. The Python agent now requires Python 3.6+. For more information, check [#1021](https://github.com/elastic/apm-agent-python/pull/1021).
24+
* No longer collecting body for `elasticsearch-py` update and `delete_by_query`. For more information, check [#1013](https://github.com/elastic/apm-agent-python/pull/1013).
25+
* Align `sanitize_field_names` config with the [cross-agent spec](https://github.com/elastic/apm/blob/3fa78e2a1eeea81c73c2e16e96dbf6b2e79f3c64/specs/agents/sanitization.md). If you are using a non-default `sanitize_field_names`, surrounding each of your entries with stars (e.g. `*secret*`) will retain the old behavior. For more information, check [#982](https://github.com/elastic/apm-agent-python/pull/982).
26+
* Remove credit card sanitization for field values. This improves performance, and the security value of this check was dubious anyway. For more information, check [#982](https://github.com/elastic/apm-agent-python/pull/982).
2727
* Remove HTTP querystring sanitization. This improves performance, and is meant to standardize behavior across the agents, as defined in [#334](https://github.com/elastic/apm/pull/334). For more information, check [#982](https://github.com/elastic/apm-agent-python/pull/982).
28-
* Remove `elasticapm.tag()` (deprecated since 5.0.0). For more information, check [#1034](https://github.com/elastic/apm-agent-python/pull/1034).
28+
* Remove `elasticapm.tag()` (deprecated since 5.0.0). For more information, check [#1034](https://github.com/elastic/apm-agent-python/pull/1034).

0 commit comments

Comments
 (0)