Skip to content

Commit 2504698

Browse files
KOTungsethKOTungseth
committed
[DOCS] Cleans up release notes
1 parent a15ec54 commit 2504698

File tree

5 files changed

+51
-41
lines changed

5 files changed

+51
-41
lines changed

‎docs/release-notes/breaking-changes.md‎

Lines changed: 42 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
---
2-
navigation_title: "Elastic APM Python Agent"
2+
navigation_title: "Breaking changes"
33
---
44

5-
# 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.
7-
8-
% To learn how to upgrade, check out <upgrade docs>.
5+
# {{apm-py-agent}} breaking changes [elastic-apm-python-agent-breaking-changes]
6+
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).
97

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

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).
27-
* 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).
21+
::::{dropdown} Python support has been deprecated
22+
Python 2.7 and 3.5 support has been deprecated.
23+
24+
For more information, check [#1021](https://github.com/elastic/apm-agent-python/pull/1021).
25+
26+
**Action**<br>
27+
The {{apm-py-agent}} now requires Python 3.6+.
28+
::::
29+
30+
::::{dropdown} No longer collecting body for `elasticsearch-py` update and `delete_by_query`
31+
For more information, check [#1013](https://github.com/elastic/apm-agent-python/pull/1013).
32+
::::
33+
34+
::::{dropdown} Aligns `sanitize_field_names` config with the cross-agent spec
35+
Aligned `sanitize_field_names` config with the [cross-agent spec](https://github.com/elastic/apm/blob/3fa78e2a1eeea81c73c2e16e96dbf6b2e79f3c64/specs/agents/sanitization.md).
36+
37+
For more information, check [#982](https://github.com/elastic/apm-agent-python/pull/982).
38+
39+
**Action**<br>
40+
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.
41+
::::
42+
43+
::::{dropdown} Removes credit card sanitization for field values
44+
This improves performance, and the security value of this check was dubious anyway.
45+
46+
For more information, check [#982](https://github.com/elastic/apm-agent-python/pull/982).
47+
::::
48+
49+
::::{dropdown} Removes HTTP querystring sanitization
50+
This improves performance, and is meant to standardize behavior across the agents, as defined in [#334](https://github.com/elastic/apm/pull/334).
51+
52+
For more information, check [#982](https://github.com/elastic/apm-agent-python/pull/982).
53+
::::
54+
55+
::::{dropdown} Removes `elasticapm.tag()`
56+
Removed `elasticapm.tag()`, which was deprecated in 5.0.0.
57+
58+
For more information, check [#1034](https://github.com/elastic/apm-agent-python/pull/1034).
59+
::::

‎docs/release-notes/deprecations.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
navigation_title: "Elastic APM Python Agent"
2+
navigation_title: "Deprecations"
33
---
44

5-
# Elastic APM Python Agent deprecations [elastic-apm-python-agent-deprecations]
6-
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.
5+
# {{apm-py-agent}} deprecations [elastic-apm-python-agent-deprecations]
6+
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.
77

8-
% To learn how to upgrade, check out <upgrade docs>.
8+
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).
99

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

33-
The log shipping LoggingHandler will be removed in version 7.0.0 of the agent.
33+
* The log shipping LoggingHandler will be removed in version 7.0.0 of the agent.
3434

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

38-
The log shipping feature in the Flask instrumentation will be removed in version 7.0.0 of the agent.
38+
* The log shipping feature in the Flask instrumentation will be removed in version 7.0.0 of the agent.

‎docs/release-notes/known-issues.md‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎docs/release-notes/index.md‎ renamed to ‎docs/release-notes/release-notes.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ mapped_pages:
44
- https://www.elastic.co/guide/en/apm/agent/python/current/release-notes-6.x.html
55
---
66

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

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

‎docs/release-notes/toc.yml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
toc:
2-
- file: index.md
3-
- file: known-issues.md
2+
- file: release-notes.md
43
- file: breaking-changes.md
54
- file: deprecations.md

0 commit comments

Comments
 (0)