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

Create portable dashboard for otel JVM metrics #182107

Merged
merged 12 commits into from
Jun 26, 2024

Conversation

SylvainJuge
Copy link
Member

@SylvainJuge SylvainJuge commented Apr 30, 2024

Create a dedicated "portable dashboard" for OTel Java.

The same dashboard is being used for the following values of agent.name:

  • opentelemetry/java for the 1.x versions of the otel agent
  • opentelemetry/java/opentelemetry-java-instrumentation for the upstream agent
  • opentelemetry/java/elastic for the Elastic java agent distribution

As a consequence, the older 1.x opentelemetry agents that are not using the stable jvm metrics conventions won't be supported (their metrics were reported in the process.runtime.jvm.* namespace).

Fixes #174445

Checklist

  • fix the top table filtering: it seems the time filtering does not work on this one as more services are listed than expected. (1)
  • fix the GC heap zones table (2)
  • remove UI elements for Java metrics that are no longer displayed, the "curated UI" parts that have been replaced with portable dashboards. This can be done in a follow-up as those are not visible and thus it's mostly cleaning code.
  • the documentation on portable dashboards is not up-to-date as it refers a deprecated ID variable.

For (1) and (2), they are properly filtered and displayed when modifying the dashboard and viewing it in lens, somehow the behavior is different when the dashboards are imported in the APM UI.

Screenshots

Dashboard display/edit

dev-for-kibana kb us-west2 gcp elastic-cloud com_9243_app_dashboards

Dashboard integrated in APM UI

localhost_5601_unz_app_apm_services_opbeans-otel-download_metrics_comparisonEnabled=true environment=ENVIRONMENT_ALL kuery= latencyAggregationType=avg offset=1d rangeFrom=now-4h rangeTo=now serviceGroup= transactionType=request

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@SylvainJuge
Copy link
Member Author

I confirm that #186167 fixes the issues that were described in this PR and the dashboard now works as expected.

Thus I'll make this PR "ready for review" so we can merge it.
I'll leave the follow-up tasks to the Kibana team.

@SylvainJuge SylvainJuge marked this pull request as ready for review June 17, 2024 12:16
@SylvainJuge SylvainJuge requested review from a team as code owners June 17, 2024 12:16
kpatticha added a commit that referenced this pull request Jun 17, 2024
Copy link
Contributor

@kpatticha kpatticha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for improving the otel JVM metrics.

@botelastic botelastic bot added ci:project-deploy-observability Create an Observability project Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team labels Jun 18, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

nikitaindik pushed a commit to nikitaindik/kibana that referenced this pull request Jun 18, 2024
@kpatticha kpatticha added release_note:skip Skip the PR/issue when compiling release notes v8.15.0 labels Jun 19, 2024
Copy link
Contributor

@tonyghiani tonyghiani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

synthtrace change LGTM 👌

@AlexanderWert AlexanderWert enabled auto-merge (squash) June 26, 2024 12:09
@kibana-ci
Copy link
Collaborator

kibana-ci commented Jun 26, 2024

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
apm 1885 1886 +1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
apm 3.5MB 3.5MB +38.5KB

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@AlexanderWert AlexanderWert merged commit acde027 into elastic:main Jun 26, 2024
22 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting ci:project-deploy-observability Create an Observability project release_note:skip Skip the PR/issue when compiling release notes Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update APM dashboards with stable JVM OTel metrics
8 participants