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.

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

docs: changelogs and compatibility matrix to reflect a bugfix that can lead to missing metrics #12401

Closed
simitt opened this issue Jan 12, 2024 · 2 comments · Fixed by elastic/observability-docs#3591
Assignees

Comments

@simitt
Copy link
Contributor

simitt commented Jan 12, 2024

elastic/apm-data#157 fixed a bug in the apm-server where a validation was not properly applied. Before the fix, empty metricset values were accepted by the apm-server, although they should have been rejected. The fix was released in 8.11.0.
The apm-java-agent had been sending empty histogram metricsets for micrometer up until version 1.42, and fixed the bug on the agent side in 1.43.0.

The fixes impact users of the java agent in a version <1.43.0, where empty micrometer histogram metrics would be recorded. The docs need to be updated accordingly for visibility before upgrading the server.

  1. 8.11 release notes should contain a note that the validation was fixed, requiring users to upgrade to java agent version >= 1.43.0 if they are collecting micrometer or custom metrics with potentially empty .
  2. Update the https://www.elastic.co/guide/en/apm/guide/8.11/known-issues.html section with a note
  3. Update the https://www.elastic.co/guide/en/apm/guide/current/agent-server-compatibility.html compatibility matrix with a * annotation explaining the edge case where the agent is not compatible with the server
@simitt
Copy link
Contributor Author

simitt commented Jan 12, 2024

@colleenmcginnis @bmorelli25 would you be able to help us out with these docs and where they need to be updated atm?

@colleenmcginnis
Copy link
Contributor

@simitt there's a draft PR up here: elastic/observability-docs#3591. Can you take a look?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants