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

[APM] Add "Analyze data" button to the Exploratory view for iOS/Swift and RUM agents and disable irrelevant components within the service views #100759

Closed
5 tasks done
formgeist opened this issue May 27, 2021 · 6 comments · Fixed by #103485
Assignees
Labels
apm:test-plan-done Pull request that was successfully tested during the test plan Team:APM All issues that need APM UI Team support v7.14.0

Comments

@formgeist
Copy link
Contributor

formgeist commented May 27, 2021

Summary

Related design issue: https://github.com/elastic/observability-design/issues/50

Related issue for adding agent icon support #100469

We want to enhance the performance analysis for the mobile agents, such as the iOS agent, and leverage the new Exploratory view that is available in Observability. We need to add individual chart links to the Exploratory view for each of the relevant charts (latency, errors, throughput, etc.) in the Service overview and Transactions / Errors views. We're working on finalizing the design of the placement of these buttons and a full guide for where they should be added.

mobile-ui-analyze-data-links

Solution

  • Adding an "Analyze data" button option to the Service header for the iOS/Swift agent and RUM services
View screens

mobile-ui-analyze-data-links

rum-analyze-data-links

  • Link should select the default report type (kpi) and add the service.name, service.environment, and the relevant time range to the URL params.
View example documentation

Example implementation from UX app
https://github.com/elastic/kibana/blob/master/x-pack/plugins/apm/public/components/app/RumDashboard/ActionMenu/index.tsx

Example URL link

const uxExploratoryViewLink = createExploratoryViewUrl(
  {
    'apm-series': {
      dataType: 'mobile',
      time: { from: rangeFrom, to: rangeTo },
      reportType: 'kpi',
      reportDefintion: {
        'service.name': ['elasit-co'],
        'service.environement': ['production']
      },
      operationType: 'average',
    } as SeriesUrl,
  },
  http?.basePath.get()
);
  • Add tooltip to the button: upon hovering on the button, we'll display a tooltip that explains the feature is in experimental following the same implementation from the UX and Uptime apps.
View screens

mobile-ui-analyze-data-links-tooltip

  • iOS/Swift – Service overview: Hide Instances scatterplot and table from the view – @sqren explained how to hide individual components from the overview page here;
  • iOS/Swift: Though the iOS agent already collects CPU and Memory metrics, the Metrics tab doesn't show them yet. If making this view working for the iOS agent is too big, let's hide this tab for now.
View screens and documentation

screencapture-localhost-5601-zwn-app-apm-services-productCatalogService-overview-2021-06-10-14_03_00

Illustrated example from another Service overview page

@formgeist formgeist added blocked Team:APM All issues that need APM UI Team support needs design v7.14.0 labels May 27, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/apm-ui (Team:apm)

@sorenlouv
Copy link
Member

If we want to hide charts on the service overview page for ios similar to what we do for RUM we need to do it here:

@formgeist formgeist changed the title [APM] Add Analyze links to the Exploratory view for iOS agent for more enhanced chart breakdowns [APM] Add "Analyze data" button to the Exploratory view for iOS agent and disable irrelevant components within the service views Jun 10, 2021
@formgeist formgeist changed the title [APM] Add "Analyze data" button to the Exploratory view for iOS agent and disable irrelevant components within the service views [APM] Add "Analyze data" button to the Exploratory view for iOS/Swift and RUM agents and disable irrelevant components within the service views Jun 16, 2021
@formgeist
Copy link
Contributor Author

Added some documentation on how to create dynamic URLs that can open a specific service name, environment and report type in the Exploratory view for the selected service - and also added that we need to add the same Analyze data links for RUM services going to the RUM reports available.

@AlexanderWert
Copy link
Member

@sqren , @formgeist
The changes on the exploratory-view for the mobile data reports have been merged (#99565), so we are good to move on with this issue.
I updated / corrected some of the examples / documentation in the description above.

Let me know if there are any questions / blockers.

@formgeist
Copy link
Contributor Author

@AlexanderWert Not sure what the scope of this integration is, but I've opened #102700 to at least rename the names of the metrics to make them consistent and some minor adjustments.

@smith smith added apm:test-plan-done Pull request that was successfully tested during the test plan and removed apm:test-plan-7.14.0 labels Jul 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apm:test-plan-done Pull request that was successfully tested during the test plan Team:APM All issues that need APM UI Team support v7.14.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants