From 0c9cf867744ee052c0801880481a24742dcbb9a5 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Fri, 2 Feb 2024 11:13:30 -0600 Subject: [PATCH 1/5] add known issue --- .../observability/apm/known-issues.asciidoc | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/en/observability/apm/known-issues.asciidoc b/docs/en/observability/apm/known-issues.asciidoc index f4bb1fd34a..67610c7a71 100644 --- a/docs/en/observability/apm/known-issues.asciidoc +++ b/docs/en/observability/apm/known-issues.asciidoc @@ -34,9 +34,27 @@ Failed installing package [apm] due to error: [ResponseError: mapper_parsing_exc mapper_parsing_exception: Field [jvm.memory.non_heap.pool.committed] attempted to shadow a time_series_metric] ---- -// Link to fix? +// Link to fix A fix was released in 8.11.2: https://github.com/elastic/kibana/pull/171712[elastic/kibana#171712]. +*APM Server accepts empty metricset values that should have been rejected* + +_APM Server versions: < 8.11.0_ + +_Elastic APM Java Agent versions: < 1.43.0_ + +// Describe the conditions in which this issue occurs +If you are using APM Server (< v8.11.0) and/or the Elastic APM Java Agent (< v1.43.0), +// Describe the behavior of the issue +the agent may ben sending empty histogram metricsets. +// Describe why it happens +This issue was a result of validation not being properly applied. + +// Include exact error messages linked to this issue +// so users searching for the error message end up here. + +// Link to fix +This was fixed in APM server in 8.11.0 and in the Elastic APM Java Agent in 1.43.0. +Find details in https://github.com/elastic/apm-data/pull/157[elastic/apm-data#157]. + // TEMPLATE //// From 24903092b9e8416ee111aa7145707665c5f74fe2 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Fri, 2 Feb 2024 11:25:48 -0600 Subject: [PATCH 2/5] add footnote to apm compatibility matrix --- docs/en/observability/apm/agent-server-compatibility.asciidoc | 2 +- docs/en/observability/apm/known-issues.asciidoc | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/en/observability/apm/agent-server-compatibility.asciidoc b/docs/en/observability/apm/agent-server-compatibility.asciidoc index 3aadd899e2..51f173a8e3 100644 --- a/docs/en/observability/apm/agent-server-compatibility.asciidoc +++ b/docs/en/observability/apm/agent-server-compatibility.asciidoc @@ -24,7 +24,7 @@ The chart below outlines the compatibility between different versions of Elastic |`1.x` |≥ `8.12` // Java -.1+|**Java agent** +.1+|**Java agent**{empty}footnote:[There is a known issue for some versions of the Java agent. Read more in <>.] |`1.x`|≥ `6.5` // .NET diff --git a/docs/en/observability/apm/known-issues.asciidoc b/docs/en/observability/apm/known-issues.asciidoc index 67610c7a71..60f29c8e89 100644 --- a/docs/en/observability/apm/known-issues.asciidoc +++ b/docs/en/observability/apm/known-issues.asciidoc @@ -37,6 +37,7 @@ Failed installing package [apm] due to error: [ResponseError: mapper_parsing_exc // Link to fix A fix was released in 8.11.2: https://github.com/elastic/kibana/pull/171712[elastic/kibana#171712]. +[[apm-empty-metricset-values]] *APM Server accepts empty metricset values that should have been rejected* + _APM Server versions: < 8.11.0_ + _Elastic APM Java Agent versions: < 1.43.0_ @@ -44,7 +45,7 @@ _Elastic APM Java Agent versions: < 1.43.0_ // Describe the conditions in which this issue occurs If you are using APM Server (< v8.11.0) and/or the Elastic APM Java Agent (< v1.43.0), // Describe the behavior of the issue -the agent may ben sending empty histogram metricsets. +the agent may be sending empty histogram metricsets. // Describe why it happens This issue was a result of validation not being properly applied. From 9418a06d95bfbd3d554bc45a8298ae145ce0a58f Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Thu, 8 Feb 2024 09:42:41 -0600 Subject: [PATCH 3/5] address feedback from @simitt --- .../apm/agent-server-compatibility.asciidoc | 2 +- docs/en/observability/apm/known-issues.asciidoc | 17 ++++++++++++----- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/en/observability/apm/agent-server-compatibility.asciidoc b/docs/en/observability/apm/agent-server-compatibility.asciidoc index 51f173a8e3..33f935bd06 100644 --- a/docs/en/observability/apm/agent-server-compatibility.asciidoc +++ b/docs/en/observability/apm/agent-server-compatibility.asciidoc @@ -24,7 +24,7 @@ The chart below outlines the compatibility between different versions of Elastic |`1.x` |≥ `8.12` // Java -.1+|**Java agent**{empty}footnote:[There is a known issue for some versions of the Java agent. Read more in <>.] +.1+|*Java agent*{empty}footnote:[Java agent < 1.43.0 not fully compatible with APM Server >= 8.11.0. Read more in <>.] |`1.x`|≥ `6.5` // .NET diff --git a/docs/en/observability/apm/known-issues.asciidoc b/docs/en/observability/apm/known-issues.asciidoc index 60f29c8e89..4bfa94917c 100644 --- a/docs/en/observability/apm/known-issues.asciidoc +++ b/docs/en/observability/apm/known-issues.asciidoc @@ -38,22 +38,29 @@ Failed installing package [apm] due to error: [ResponseError: mapper_parsing_exc A fix was released in 8.11.2: https://github.com/elastic/kibana/pull/171712[elastic/kibana#171712]. [[apm-empty-metricset-values]] -*APM Server accepts empty metricset values that should have been rejected* + -_APM Server versions: < 8.11.0_ + +*Upgrading APM Server to 8.11+ might break event intake from older APM Java Agents* + +_APM Server versions: >=8.11.0_ + _Elastic APM Java Agent versions: < 1.43.0_ // Describe the conditions in which this issue occurs -If you are using APM Server (< v8.11.0) and/or the Elastic APM Java Agent (< v1.43.0), +If you are using APM Server (> v8.11.0) and/or the Elastic APM Java Agent (< v1.43.0), // Describe the behavior of the issue the agent may be sending empty histogram metricsets. + // Describe why it happens -This issue was a result of validation not being properly applied. +In previous APM Server versions some data validation was not properly applied, +leading the APM Server to accept empty histogram metricsets where it shouldn't. +This bug was fixed in the APM Server in 8.11.0. + +The APM Java Agent (< v1.43.0) was sending this kind of invalid data under certain circumstances. +If you upgrade the APM Server to v8.11.0+ _without_ upgrading the APM Java Agent version, +metricsets can be rejected by the APM Server and can result in additional error logs in the Java Agent. // Include exact error messages linked to this issue // so users searching for the error message end up here. // Link to fix -This was fixed in APM server in 8.11.0 and in the Elastic APM Java Agent in 1.43.0. +The fix is to upgrade the Elastic APM Java Agent to a version >= 1.43.0. Find details in https://github.com/elastic/apm-data/pull/157[elastic/apm-data#157]. // TEMPLATE From 71ecc1dd3f1ff5033bcf23b6934a41a695451918 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Thu, 8 Feb 2024 09:51:59 -0600 Subject: [PATCH 4/5] address feedback from @bmorelli25 --- .../observability/apm/known-issues.asciidoc | 82 ++++++++++--------- 1 file changed, 45 insertions(+), 37 deletions(-) diff --git a/docs/en/observability/apm/known-issues.asciidoc b/docs/en/observability/apm/known-issues.asciidoc index 4bfa94917c..ad63fe302c 100644 --- a/docs/en/observability/apm/known-issues.asciidoc +++ b/docs/en/observability/apm/known-issues.asciidoc @@ -2,13 +2,56 @@ = Known issues APM has the following known issues: +//// +TEMPLATE +Note: Add known issues for newer Elastic Stack +versions to the top of this page + +*Brief description* + +_Versions: XX.XX.XX, YY.YY.YY, ZZ.ZZ.ZZ_ + +Detailed description including: + +The conditions in which this issue occurs +The behavior of the issue +Why it happens +If applicable, exact error messages linked to this issue so users searching for the error message end up here +Link to fix +//// + +[[apm-empty-metricset-values]] +*Upgrading APM Server to 8.11+ might break event intake from older APM Java agents* + +_APM Server versions: >=8.11.0_ + +_Elastic APM Java agent versions: < 1.43.0_ + +// Describe the conditions in which this issue occurs +If you are using APM Server (> v8.11.0) and/or the Elastic APM Java agent (< v1.43.0), +// Describe the behavior of the issue +the agent may be sending empty histogram metricsets. + +// Describe why it happens +In previous APM Server versions some data validation was not properly applied, +leading the APM Server to accept empty histogram metricsets where it shouldn't. +This bug was fixed in the APM Server in 8.11.0. + +The APM Java agent (< v1.43.0) was sending this kind of invalid data under certain circumstances. +If you upgrade the APM Server to v8.11.0+ _without_ upgrading the APM Java agent version, +metricsets can be rejected by the APM Server and can result in additional error logs in the Java agent. + +// Include exact error messages linked to this issue +// so users searching for the error message end up here. + +// Link to fix +The fix is to upgrade the Elastic APM Java agent to a version >= 1.43.0. +Find details in https://github.com/elastic/apm-data/pull/157[elastic/apm-data#157]. + *Ingesting new JVM metrics in 8.9 and 8.10 breaks upgrade to 8.11 and stops ingestion* + _APM Server versions: 8.11.0, 8.11.1_ + -_Elastic APM Java Agent versions: 1.39.0+_ +_Elastic APM Java agent versions: 1.39.0+_ // Describe the conditions in which this issue occurs -If you're using the Elastic APM Java Agent v1.39.0+ to send new JVM metrics to APM Server v8.9.x and v8.10.x, +If you're using the Elastic APM Java agent v1.39.0+ to send new JVM metrics to APM Server v8.9.x and v8.10.x, // Describe the behavior of the issue upgrading to 8.11.0 or 8.11.1 will silently fail and stop ingesting APM metrics. // Describe why it happens @@ -36,38 +79,3 @@ Failed installing package [apm] due to error: [ResponseError: mapper_parsing_exc // Link to fix A fix was released in 8.11.2: https://github.com/elastic/kibana/pull/171712[elastic/kibana#171712]. - -[[apm-empty-metricset-values]] -*Upgrading APM Server to 8.11+ might break event intake from older APM Java Agents* + -_APM Server versions: >=8.11.0_ + -_Elastic APM Java Agent versions: < 1.43.0_ - -// Describe the conditions in which this issue occurs -If you are using APM Server (> v8.11.0) and/or the Elastic APM Java Agent (< v1.43.0), -// Describe the behavior of the issue -the agent may be sending empty histogram metricsets. - -// Describe why it happens -In previous APM Server versions some data validation was not properly applied, -leading the APM Server to accept empty histogram metricsets where it shouldn't. -This bug was fixed in the APM Server in 8.11.0. - -The APM Java Agent (< v1.43.0) was sending this kind of invalid data under certain circumstances. -If you upgrade the APM Server to v8.11.0+ _without_ upgrading the APM Java Agent version, -metricsets can be rejected by the APM Server and can result in additional error logs in the Java Agent. - -// Include exact error messages linked to this issue -// so users searching for the error message end up here. - -// Link to fix -The fix is to upgrade the Elastic APM Java Agent to a version >= 1.43.0. -Find details in https://github.com/elastic/apm-data/pull/157[elastic/apm-data#157]. - -// TEMPLATE - -//// -*Brief description* + -_Versions: XX.XX.XX, YY.YY.YY, ZZ.ZZ.ZZ_ - -Detailed description. -//// From 6aed7b0f4eae42f758b175d33e55dbae36bc6cbf Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Thu, 8 Feb 2024 10:38:22 -0600 Subject: [PATCH 5/5] Update docs/en/observability/apm/known-issues.asciidoc Co-authored-by: Silvia Mitter --- docs/en/observability/apm/known-issues.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/observability/apm/known-issues.asciidoc b/docs/en/observability/apm/known-issues.asciidoc index ad63fe302c..f8b955cb50 100644 --- a/docs/en/observability/apm/known-issues.asciidoc +++ b/docs/en/observability/apm/known-issues.asciidoc @@ -25,7 +25,7 @@ _APM Server versions: >=8.11.0_ + _Elastic APM Java agent versions: < 1.43.0_ // Describe the conditions in which this issue occurs -If you are using APM Server (> v8.11.0) and/or the Elastic APM Java agent (< v1.43.0), +If you are using APM Server (> v8.11.0) and the Elastic APM Java agent (< v1.43.0), // Describe the behavior of the issue the agent may be sending empty histogram metricsets.