Skip to content
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

[apm] Add docs on a known issue with APM Server + APM Java agent #3591

Merged
merged 5 commits into from
Feb 8, 2024
Merged

[apm] Add docs on a known issue with APM Server + APM Java agent #3591

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0c9cf86
add known issue
colleenmcginnis Feb 2, 2024
2490309
add footnote to apm compatibility matrix
colleenmcginnis Feb 2, 2024
9418a06
address feedback from @simitt
colleenmcginnis Feb 8, 2024
71ecc1d
address feedback from @bmorelli25
colleenmcginnis Feb 8, 2024
6aed7b0
Update docs/en/observability/apm/known-issues.asciidoc
colleenmcginnis Feb 8, 2024
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
2 changes: 1 addition & 1 deletion docs/en/observability/apm/agent-server-compatibility.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:[Java agent < 1.43.0 not fully compatible with APM Server >= 8.11.0. Read more in <<apm-empty-metricset-values,Known issues>>.]
|`1.x`|≥ `6.5`

// .NET
Expand Down
28 changes: 27 additions & 1 deletion docs/en/observability/apm/known-issues.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,35 @@ 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-empty-metricset-values]]
*Upgrading APM Server to 8.11+ might break event intake from older APM Java Agents* +
colleenmcginnis marked this conversation as resolved.
Show resolved Hide resolved
_APM Server versions: >=8.11.0_ +
_Elastic APM Java Agent versions: < 1.43.0_
colleenmcginnis marked this conversation as resolved.
Show resolved Hide resolved

// 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

////
Expand Down
Loading