Skip to content

Commit d495c27

Browse files
committed
update CHANGELOG, update upgrading docs, and bump version to 5.0.0
1 parent ae1c777 commit d495c27

File tree

3 files changed

+20
-3
lines changed

3 files changed

+20
-3
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Changelog
22

3-
## Unreleased
4-
[Check the diff](https://github.com/elastic/apm-agent-python/compare/v4.2.2...master)
3+
## v5.0.0
4+
[Check the diff](https://github.com/elastic/apm-agent-python/compare/v4.2.2...v5.0.0)
55
### Breaking changes
66

77
* implemented type/subtype/action hierachy for spans. Ensure that you run at least APM Server 6.6 (#377)

docs/upgrading.asciidoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,23 @@ Upgrades that involve a major version bump often come with some backwards incomp
77
We highly recommend to always pin the version of `elastic-apm` in your `requirements.txt` or `Pipfile`.
88
This avoids automatic upgrades to potentially incompatible versions.
99

10+
[[upgrading-5.x]]
11+
=== Upgrading to version 5 of the agent
12+
13+
==== APM Server 7.3 required for some features
14+
15+
APM Server and Kibana 7.3 introduced support for collecting breakdown metrics, and central configuration of APM agents.
16+
To use these features, please update the Python agent to 5.0+ and APM Server / Kibana to 7.3+
17+
18+
==== Tags renamed to Labels
19+
20+
To better align with other parts of the Elastic Stack and the {ecs-ref}/index.html[Elastic Common Schema],
21+
we renamed "tags" to "labels", and introduced limited support for typed labels.
22+
While tag values were only allowed to be strings, label values can be strings, booleans, or numerical.
23+
24+
To benefit from this change, ensure that you run at least *APM Server 6.7*, and use `elasticapm.label()` instead of `elasticapm.tag()`.
25+
The `tag()` API will continue to work as before, but emit a `DeprecationWarning`. It will be removed in 6.0 of the agent.
26+
1027
[[upgrading-4.x]]
1128
=== Upgrading to version 4 of the agent
1229

elasticapm/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@
2828
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
2929
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
3030

31-
__version__ = (4, 2, 2)
31+
__version__ = (5, 0, 0)
3232
VERSION = ".".join(map(str, __version__))

0 commit comments

Comments
 (0)