Skip to content

Remove tags (deprecated) + Update docs for 6.x #1034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 1, 2021
Merged

Remove tags (deprecated) + Update docs for 6.x #1034

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e817343
Update docs for 6.x
basepi Feb 1, 2021
ec31ff1
Remove tags (deprecated) + review suggestions
basepi Feb 1, 2021
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
16 changes: 7 additions & 9 deletions CHANGELOG.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,13 @@ endif::[]
//===== Bug fixes
//

[float]
=== Unreleased
[[release-notes-6.x]]
=== Python Agent version 6.x


[[release-notes-6.0.0]]
==== v6.0.0

// Unreleased changes go here
// When the next release happens, nest these changes under the "Python Agent version 5.x" heading
[float]
===== Breaking changes

Expand All @@ -43,16 +45,12 @@ endif::[]
* Align `sanitize_field_names` config with the
https://github.com/elastic/apm/blob/3fa78e2a1eeea81c73c2e16e96dbf6b2e79f3c64/specs/agents/sanitization.md[cross-agent spec].
If you are using a non-default `sanitize_field_names`, surrounding each of your entries with stars (i.e.
`\*secret\*`) will retain the old behavior. {pull}982[#982]
`*secret*`) will retain the old behavior. {pull}982[#982]
* Remove credit card sanitization for field values. This improves performance, and the security value of this check was
dubious anyway. {pull}982[#982]
* Remove HTTP querystring sanitization. This improves performance, and is meant to standardize behavior across the
agents, as defined in https://github.com/elastic/apm/pull/334. {pull}982[#982]

[float]
===== Features


[float]
===== Bug fixes

Expand Down
16 changes: 15 additions & 1 deletion docs/upgrading.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,22 @@ The table below is a simplified description of this policy.
|3.x |2020-01-20 |4.0
|4.x |2020-05-14 |5.0
|5.x |2021-02-05 |6.0
|6.x |2022-08-01 |7.0
|====

[[upgrading-6.x]]
=== Upgrading to version 6 of the agent

==== Python 2 no longer supported

Please upgrade to python 3.6+ to continue to receive regular updates.

==== `SANITIZE_FIELD_NAMES` changes

If you are using a non-default `sanitize_field_names` config, please note
that your entries must be surrounded with stars (i.e. `*secret*`) in order to
maintain previous behavior.

[[upgrading-5.x]]
=== Upgrading to version 5 of the agent

Expand All @@ -42,7 +56,7 @@ 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.

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.
The `tag()` API will continue to work as before, but emit a `DeprecationWarning`. It will be removed in 6.0 of the agent.

[[upgrading-4.x]]
=== Upgrading to version 4 of the agent
Expand Down