Skip to content

Commit

Permalink
update CHANGELOG, update upgrading docs, and bump version to 5.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
beniwohli committed Jul 31, 2019
1 parent ae1c777 commit d495c27
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Changelog

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

* implemented type/subtype/action hierachy for spans. Ensure that you run at least APM Server 6.6 (#377)
Expand Down
17 changes: 17 additions & 0 deletions docs/upgrading.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,23 @@ Upgrades that involve a major version bump often come with some backwards incomp
We highly recommend to always pin the version of `elastic-apm` in your `requirements.txt` or `Pipfile`.
This avoids automatic upgrades to potentially incompatible versions.

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

==== APM Server 7.3 required for some features

APM Server and Kibana 7.3 introduced support for collecting breakdown metrics, and central configuration of APM agents.
To use these features, please update the Python agent to 5.0+ and APM Server / Kibana to 7.3+

==== Tags renamed to Labels

To better align with other parts of the Elastic Stack and the {ecs-ref}/index.html[Elastic Common Schema],
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.

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

Expand Down
2 changes: 1 addition & 1 deletion elasticapm/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

__version__ = (4, 2, 2)
__version__ = (5, 0, 0)
VERSION = ".".join(map(str, __version__))

0 comments on commit d495c27

Please sign in to comment.