Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 42 additions & 11 deletions docs/release-notes/breaking-changes.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
navigation_title: "Elastic APM Python Agent"
navigation_title: "Breaking changes"
---

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

% To learn how to upgrade, check out <upgrade docs>.
# {{apm-py-agent}} breaking changes [elastic-apm-python-agent-breaking-changes]
Breaking changes can impact your Elastic applications, potentially disrupting normal operations. Before you upgrade, carefully review the {{apm-py-agent}} breaking changes and take the necessary steps to mitigate any issues. To learn how to upgrade, check out [Upgrading](/reference/upgrading.md).

% ## Next version [elastic-apm-python-agent-nextversion-breaking-changes]
% **Release date:** Month day, year
Expand All @@ -20,9 +18,42 @@ Before you upgrade, carefully review the Elastic APM RPython Agent breaking chan
## 6.0.0 [elastic-apm-python-agent-600-breaking-changes]
**Release date:** February 1, 2021

* 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).
* 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).
* 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).
* 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).
* 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).
* Remove `elasticapm.tag()` (deprecated since 5.0.0). For more information, check [#1034](https://github.com/elastic/apm-agent-python/pull/1034).
::::{dropdown} Python support has been deprecated
Python 2.7 and 3.5 support has been deprecated.

For more information, check [#1021](https://github.com/elastic/apm-agent-python/pull/1021).

**Action**<br>
The {{apm-py-agent}} now requires Python 3.6+.
::::

::::{dropdown} 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).
::::

::::{dropdown} Aligns `sanitize_field_names` config with the cross-agent spec
Aligned `sanitize_field_names` config with the [cross-agent spec](https://github.com/elastic/apm/blob/3fa78e2a1eeea81c73c2e16e96dbf6b2e79f3c64/specs/agents/sanitization.md).

For more information, check [#982](https://github.com/elastic/apm-agent-python/pull/982).

**Action**<br>
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.
::::

::::{dropdown} Removes 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).
::::

::::{dropdown} Removes 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).
::::

::::{dropdown} Removes `elasticapm.tag()`
Removed `elasticapm.tag()`, which was deprecated in 5.0.0.

For more information, check [#1034](https://github.com/elastic/apm-agent-python/pull/1034).
::::
12 changes: 6 additions & 6 deletions docs/release-notes/deprecations.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
navigation_title: "Elastic APM Python Agent"
navigation_title: "Deprecations"
---

# Elastic APM Python Agent deprecations [elastic-apm-python-agent-deprecations]
Review the deprecated functionality for your Elastic APM Python Agent version. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade.
# {{apm-py-agent}} deprecations [elastic-apm-python-agent-deprecations]
Over time, certain Elastic functionality becomes outdated and is replaced or removed. To help with the transition, Elastic deprecates functionality for a period before removal, giving you time to update your applications.

% To learn how to upgrade, check out <upgrade docs>.
Review the deprecated functionality for {{apm-py-agent}}. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. To learn how to upgrade, check out [Upgrading](/reference/upgrading.md).

% ## Next version
% **Release date:** Month day, year
Expand All @@ -30,9 +30,9 @@ Review the deprecated functionality for your Elastic APM Python Agent version. W
## 6.20.0 [elastic-apm-python-agent-6200-deprecations]
**Release date:** January 10, 2024

The log shipping LoggingHandler will be removed in version 7.0.0 of the agent.
* The log shipping LoggingHandler will be removed in version 7.0.0 of the agent.

## 6.19.0 [elastic-apm-python-agent-6190-deprecations]
**Release date:** October 11, 2023

The log shipping feature in the Flask instrumentation will be removed in version 7.0.0 of the agent.
* The log shipping feature in the Flask instrumentation will be removed in version 7.0.0 of the agent.
19 changes: 0 additions & 19 deletions docs/release-notes/known-issues.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ mapped_pages:
- https://www.elastic.co/guide/en/apm/agent/python/current/release-notes-6.x.html
---

# Elastic APM Python Agent release notes [elastic-apm-python-agent-release-notes]

Review the changes, fixes, and more in each version of Elastic APM Python Agent.
# {{apm-py-agent}} release notes [elastic-apm-python-agent-release-notes]
Review the changes, fixes, and more in each version of {{apm-py-agent}}.

To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31).

Expand Down
3 changes: 1 addition & 2 deletions docs/release-notes/toc.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
toc:
- file: index.md
- file: known-issues.md
- file: release-notes.md
- file: breaking-changes.md
- file: deprecations.md
Loading