From c077005539fd67b7b386ba17b9162237c841bee5 Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Wed, 17 Mar 2021 12:22:11 -0700 Subject: [PATCH] docs: 7.12 bcs and rns (#4959) --- changelogs/7.12.asciidoc | 3 +- docs/breaking-changes.asciidoc | 32 +++++++++++++++++++ docs/guide/apm-breaking-changes.asciidoc | 39 +++++++++++++++++++++++- docs/release-notes.asciidoc | 1 + 4 files changed, 73 insertions(+), 2 deletions(-) diff --git a/changelogs/7.12.asciidoc b/changelogs/7.12.asciidoc index cd4a411d999..a788dcdad45 100644 --- a/changelogs/7.12.asciidoc +++ b/changelogs/7.12.asciidoc @@ -3,10 +3,11 @@ https://github.com/elastic/apm-server/compare/7.11\...7.12[View commits] +[float] [[release-notes-7.12.0]] == APM Server version 7.12.0 -https://github.com/elastic/apm-server/compare/v7.11.1\...v7.12.0[View commits] +https://github.com/elastic/apm-server/compare/v7.11.2\...v7.12.0[View commits] [float] ==== Breaking Changes diff --git a/docs/breaking-changes.asciidoc b/docs/breaking-changes.asciidoc index 2b1d17eb426..fa18b939d89 100644 --- a/docs/breaking-changes.asciidoc +++ b/docs/breaking-changes.asciidoc @@ -3,6 +3,38 @@ APM Server is built on top of {beats-ref}/index.html[libbeat]. As such, any breaking change in libbeat is also considered to be a breaking change in APM Server. +[float] +=== 7.12 + +There are three breaking changes to be aware of; +these changes only impact users ingesting data with +{apm-server-ref-v}/jaeger.html[Jaeger clients]. + +* Leading 0s are no longer removed from Jaeger client trace/span ids. ++ +-- +This change ensures distributed tracing continues to work across platforms by creating +consistent, full trace/span IDs from Jaeger clients, Elastic APM agents, +and OpenTelemetry SDKs. +-- + +* Jaeger spans will now have a type of "app" where they previously were "custom". ++ +-- +If the Jaeger span type is not inferred, it will now be "app". +This aligns with the OpenTelemetry Collector exporter +and improves the functionality of the _time spent by span type_ charts in the APM app. +-- + +* Jaeger spans may now have a more accurate outcome of "unknown". ++ +-- +Previously, a "success" outcome was assumed when a span didn't fail. +The new default assigns "unknown", and only sets an outcome of "success" or "failure" when +the outcome is explicitly known. +This change aligns with Elastic APM agents and the OpenTelemetry Collector exporter. +-- + [float] === 7.11 There are no breaking changes in APM Server. diff --git a/docs/guide/apm-breaking-changes.asciidoc b/docs/guide/apm-breaking-changes.asciidoc index 8deca8dcf5e..e036b4b2f59 100644 --- a/docs/guide/apm-breaking-changes.asciidoc +++ b/docs/guide/apm-breaking-changes.asciidoc @@ -3,6 +3,7 @@ This section discusses the changes that you need to be aware of when migrating your application from one version of APM to another. +* <> * <> * <> * <> @@ -25,9 +26,45 @@ Also see {observability-guide}/whats-new.html[What's new in Observability {minor //NOTE: The notable-breaking-changes tagged regions are re-used in the //Installation and Upgrade Guide -// Remove this tag in a future PR + // tag::notable-v8-breaking-changes[] // end::notable-v8-breaking-changes[] +// tag::713-bc[] +// end::713-bc[] + +[[breaking-7.12.0]] +=== 7.12.0 APM Breaking changes + +// tag::712-bc[] +There are three breaking changes to be aware of; +these changes only impact users ingesting data with +{apm-server-ref-v}/jaeger.html[Jaeger clients]. + +* Leading 0s are no longer removed from Jaeger client trace/span ids. ++ +-- +This change ensures distributed tracing continues to work across platforms by creating +consistent, full trace/span IDs from Jaeger clients, Elastic APM agents, +and OpenTelemetry SDKs. +-- + +* Jaeger spans will now have a type of "app" where they previously were "custom". ++ +-- +If the Jaeger span type is not inferred, it will now be "app". +This aligns with the OpenTelemetry Collector exporter +and improves the functionality of the _time spent by span type_ charts in the APM app. +-- + +* Jaeger spans may now have a more accurate outcome of "unknown". ++ +-- +Previously, a "success" outcome was assumed when a span didn't fail. +The new default assigns "unknown", and only sets an outcome of "success" or "failure" when +the outcome is explicitly known. +This change aligns with Elastic APM agents and the OpenTelemetry Collector exporter. +-- +// end::712-bc[] [[breaking-7.11.0]] === 7.11.0 APM Breaking changes diff --git a/docs/release-notes.asciidoc b/docs/release-notes.asciidoc index b233f450d8d..e6dbce51b62 100644 --- a/docs/release-notes.asciidoc +++ b/docs/release-notes.asciidoc @@ -10,6 +10,7 @@ -- This following sections summarizes the changes in each release. +* <> * <> * <> * <>