[fleet] Add Integration Preference selector #114432

clintandrewhall · 2021-10-11T05:08:50Z

Summary

This PR adds the Integration Preference selector to the Available Packages page.

Oct-12-2021.20-37-57.mp4

It also updates the Storybook mocks to make the tests make sense.

elasticmachine · 2021-10-11T05:08:56Z

Pinging @elastic/fleet (Team:Fleet)

thomasneirynck · 2021-10-11T17:49:59Z

Discussed offline with @clintandrewhall and @joshdover . Before writing the actual filtering logic on the on-change event, should wait on #114429 to merge first, as that one makes changes to how cards/categories are handled client-side. Otherwise, we'd encounter merge conflicts on either end.

+1 on UX

alexfrancoeur · 2021-10-12T00:41:09Z

A question around logic came up for this work. I'll describe how I've been thinking about this logic, but will want @mostlyjason and @dborodyansky to confirm before we move forward with it.

Elastic Agent (recommended) is selected

Input	Output
A beats integration is available with no agent equivalent	Show beats integration
A beats integration is available with a beta or experimental agent equivalent	Show beats integration
A beats integration is available with a GA agent equivalent	Show agent integration
An agent integration is available with no equivalent beats integration	Show agent integration

Beats is selected

Input	Output
A beats integration is available with no agent equivalent	Show beats integration
A beats integration is available with a beta or experimental agent equivalent	Show beats integration
A beats integration is available with a GA agent equivalent	Show beats integration
An agent integration is available with no equivalent beats integration	Show agent integration

clintandrewhall · 2021-10-12T02:49:34Z

@alexfrancoeur Thanks for that table. I'm going to copy and restate it to be perfectly clear:

The logic for this change will be to hide cards. The implementation has all possibilities available, and we'll be filtering out some possibilities based on this radio button.

With that in mind, here's your table:

Elastic Agent (recommended) is selected

Input	Output
A beats integration is available with no agent equivalent	Keep beats integration
A beats integration is available with a beta or experimental agent equivalent	Keep beats integration
A beats integration is available with a GA agent equivalent	Remove beats integration
An agent integration is available with no equivalent beats integration	Remove beats integration

Beats is selected

Input	Output
A beats integration is available with no agent equivalent	Keep beats integration
A beats integration is available with a beta or experimental agent equivalent	Keep beats integration ... do we remove the agent integration?
A beats integration is available with a GA agent equivalent	Keep beats integration ... do we remove the agent integration?
An agent integration is available with no equivalent beats integration	Keep agent integration

Follow up: is there ever a time when everything is displayed? Should we consider a "display all" option?

alexfrancoeur · 2021-10-12T03:08:55Z

The logic for this change will be to hide cards. The implementation has all possibilities available, and we'll be filtering out some possibilities based on this radio button.

Yes, the logic would be to hide the cards. Based on the radio button, we'll be removing beats or agent cards.

Follow up: is there ever a time when everything is displayed? Should we consider a "display all" option?

We did explore this option early on but decided against it to avoid duplicative cards. The original purpose of this filter was to provide the user who knows they want beats, with a quick option to only show them.

I've updated the table with your language to map the logic I believe we want. @mostlyjason what do you think about the above answers and below logic?

Elastic Agent (recommended) is selected

Input	Output
A beats integration is available with no agent equivalent	Keep beats integration
A beats integration is available with a beta or experimental agent equivalent	Keep beats integration
A beats integration is available with a GA agent equivalent	Remove beats integration
An agent integration is available with no equivalent beats integration	Remove beats integration

Beats is selected

Input	Output
A beats integration is available with no agent equivalent	Keep beats integration
A beats integration is available with a beta or experimental agent equivalent	Keep beats integration and remove the agent integration
A beats integration is available with a GA agent equivalent	Keep beats integration and remove the agent integration
An agent integration is available with no equivalent beats integration	Keep agent integration

alexfrancoeur · 2021-10-12T12:24:36Z

It was a bit late last night when I updated that table, but I think this there is a clarifying point I missed when the Elastic Agent option is selected. Updating the table accordingly. The only real difference between the two is for the A beats integration is available with a GA agent equivalent state. I am pretty confident this is the behavior we agreed upon, but we'll want to wait for @mostlyjason to chime in this morning. In both of these scenarios, what's not easily discoverable is experimental agent integrations that have a beats equivalent - and that is by design.

Elastic Agent (recommended) is selected

Input	Output
A beats integration is available with no agent equivalent	Keep beats integration
A beats integration is available with a beta or experimental agent equivalent	Keep beats integration and remove the agent integration
A beats integration is available with a GA agent equivalent	Remove beats integration
An agent integration is available with no equivalent beats integration	Keep agent integration

Beats is selected

Input	Output
A beats integration is available with no agent equivalent	Keep beats integration
A beats integration is available with a beta or experimental agent equivalent	Keep beats integration and remove the agent integration
A beats integration is available with a GA agent equivalent	Keep beats integration and remove the agent integration
An agent integration is available with no equivalent beats integration	Keep agent integration

mostlyjason · 2021-10-12T14:02:43Z

Thanks @alexfrancoeur that table looks good to me!

alexfrancoeur · 2021-10-12T18:37:13Z

After some amazing collaboration and super fast decision making in slack, we have landed on the following logic.

There will now be three new filter options to replace the first two.

Recommended (default)
Elastic Agent only
Beats only

Each one of these options could benefit from a tooltip. I'm adding some example text to each option below, but could benefit from @gchaps and the teams thoughts and feedback on messaging.

Recommended (default) is selected

Tooltip

Filter on Elastic recommended integrations. Production ready integrations will be recommended over beta and experimental.

Logic

Input	Output
A beats integration is available with no agent equivalent	Keep beats integration
A beats integration is available with a beta or experimental agent equivalent	Keep beats integration and remove the agent integration
A beats integration is available with a GA agent equivalent	Remove beats integration
An agent integration is available with no equivalent beats integration	Keep agent integration

Elastic Agent only is selected

Tooltip

Filter on all Elastic Agent integrations.

Logic

Input	Output
A beats integration is available with no agent equivalent	Remove beats integration
A beats integration is available with a beta or experimental agent equivalent	Keep agent integration and remove the beats integration
A beats integration is available with a GA agent equivalent	Keep agent integration and remove the beats integration
An agent integration is available with no equivalent beats integration	Keep agent integration

Beats only is selected

Tooltip

Filter on all Beats integrations.

Logic

Input	Output
A beats integration is available with no agent equivalent	Keep beats integration
A beats integration is available with a beta or experimental agent equivalent	Keep beats integration and remove the agent integration
A beats integration is available with a GA agent equivalent	Keep beats integration and remove the agent integration
An agent integration is available with no equivalent beats integration	Remove agent integration

dborodyansky · 2021-10-12T18:53:23Z

Updated design prototype, though I would recommend a slight tweak. Tooltips for Elastic Agent and Beats as stated don't seem to offer any additional information, and we do offer a docs link to explain and compare the shippers already. Also "Filter on..." text seems unnecessary.

Proposed design change:

clintandrewhall · 2021-10-12T19:05:26Z

I'll make these changes right away.

kibanamachine · 2021-10-13T03:47:56Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`fleet`	578	579	+1

Async chunks

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

id	before	after	diff
`fleet`	626.1KB	627.9KB	+1.8KB

History

💚 Build #160268 succeeded 7c17733638f3eabbeb4bdc0ec25432d1dfdd7e4b
💔 Build #160260 failed e0b65b26a2f65ff9abc15b3fbd89f9f13d029db3
💔 Build #160252 failed b8ad93c
💚 Build #159814 succeeded e21a049
💚 Build #159324 succeeded e4e8c4c

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

joshdover · 2021-10-13T11:47:39Z

Tested locally and the filtering functionality matches what we agreed upon above 👍

This doesn't currently persist the preference anywhere, which we can address as a follow up. @alexfrancoeur @mostlyjason do we consider persisting this setting to localStorage as a "must have" for this release?

snide

Tested functionality on the design side. LGTM. OK skipping persistence given our timing.

joshdover

Functionality and code LGTM

mostlyjason · 2021-10-13T13:17:55Z

Yeah I think persistence could be a nice to have since users can accomplish their goal to filter with a few extra clicks.

I just tested the logic and I noticed that "j. Experimental, has Beats" shows up under the version control and web categories if I select "Elastic Agent only" mode but not under "Recommended" mode. I thought that was odd but not necessarily wrong. We should double check the categories once we've hooked it up to real data.

kibanamachine · 2021-10-13T13:20:34Z

💔 Backport failed

Status	Branch	Result
❌	7.x	Commit could not be cherrypicked due to conflicts

To backport manually run:
node scripts/backport --pr 114432

alexfrancoeur · 2021-10-13T14:10:40Z

Looks like there is an issue with the backport. @clintandrewhall is out. @joshdover or @thomasneirynck do you think this is something one of you could help with?

snide · 2021-10-13T14:36:54Z

@alexfrancoeur @thomasneirynck @joshdover I got the backport.

thomasneirynck · 2021-10-13T14:46:25Z

discussed offline with @snide . There are a few failing backports from yesterday, that are backing this up.

#114429 (comment) -> #114431

will investigate

…ide-users-to-saving-ux * 'master' of github.com:elastic/kibana: (133 commits) [DOCS] Indicate reports are a subscription feature (elastic#114653) Update namespace for indices (elastic#114612) [DOCS] Adds Logstash pipeline settings (elastic#114648) Bump EPR snapshot version used for tests (elastic#114529) [Security Solution] [Endpoint] Fleet summary card adjustments (elastic#114291) skip flaky suite (elastic#68400) [Visualizations] fix usage of optional dependencies (elastic#114286) [Security Solution] [Detections] Improves custom query rule upgrade test (elastic#114454) [fleet] Add Integration Preference selector (elastic#114432) [Reporting] Add new `data-render-error` attribute (elastic#114472) Replace EuiCodeEditor with CodeEditor in app-services code (elastic#114316) [data views] add getDefaultDataView method (elastic#113891) [Security Solution] [Endpoint] Event filters uses the new card design (elastic#114126) [fleet] Tweak Header UI (elastic#114704) [APM] Filter on tx metrics for instance stats (elastic#114758) [APM] Fix typo in linting docs (elastic#114764) [Discover] Removing SavedObject usage for savedSearch (elastic#112983) [Fleet] Add Integration Policy Page Improvements (elastic#114556) [Lens] Keep the custom label when transitioning to/from Formula (elastic#114270) [Security Solution][Endpoint] Host Isolation API changes (elastic#113621) ...

thomasneirynck · 2021-10-13T17:26:29Z

Working through the chain: backport of this one blocked by #114870. When that one merges, we should be able to backport this one cleanly.

Co-authored-by: Clint Andrew Hall <clint.hall@elastic.co>

hop-dev · 2021-10-26T11:21:46Z

Hi @clintandrewhall we have had this issue raised asking where we intend the Elastic agent and beats link to navigate to, I can't see this discussed anywhere or in the designs?

CC @dborodyansky @dedemorton maybe?

dedemorton · 2021-10-26T13:56:29Z

@hop-dev A single link is going to be a bit awkward because beats and agent are currently documented in different “books. There are a couple of links that could work:

https://www.elastic.co/guide/en/fleet/7.16/beats-agent-comparison.html (Describes difference between agent and beats.)

https://www.elastic.co/guide/en/fleet/7.16/integrations.html

(I’m on PTO this week so please defer to @gchaps

alexfrancoeur · 2021-10-26T16:39:29Z

I believe the original intent was to link to https://www.elastic.co/guide/en/fleet/7.16/beats-agent-comparison.html

clintandrewhall added 3 commits October 9, 2021 14:03

[nit] Strongly-type Shipper and Category

e2d3671

[pre-req] Split EPM Home into components

aa559c9

[fleet] Add Integration Preference selector

e4e8c4c

clintandrewhall requested a review from a team as a code owner October 11, 2021 05:08

botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Oct 11, 2021

clintandrewhall requested review from dborodyansky and thomasneirynck October 11, 2021 05:09

clintandrewhall changed the title ~~[nit] Strongly-type Shipper and Category~~ [fleet] Add Integration Preference selector Oct 11, 2021

clintandrewhall mentioned this pull request Oct 11, 2021

[nit][pre-req] Split EPM Home into components #114431

Merged

Merge branch 'master' into fleet/integration-preference

43f59fa

clintandrewhall added 2 commits October 11, 2021 22:13

Fix bad merge

e21a049

Adjust data for better testing

b8ad93c

clintandrewhall force-pushed the fleet/integration-preference branch from 87d5b6d to bbe866d Compare October 13, 2021 01:45

More fixes

dbaa8ab

clintandrewhall force-pushed the fleet/integration-preference branch from bbe866d to dbaa8ab Compare October 13, 2021 01:47

clintandrewhall enabled auto-merge (squash) October 13, 2021 03:52

clintandrewhall mentioned this pull request Oct 13, 2021

[Fleet] Unified Integrations view #93084

Closed

63 tasks

snide approved these changes Oct 13, 2021

View reviewed changes

joshdover approved these changes Oct 13, 2021

View reviewed changes

clintandrewhall merged commit 8068eec into elastic:master Oct 13, 2021

snide mentioned this pull request Oct 13, 2021

[7.x] [fleet] Add Integration Preference selector (#114432) #114823

Closed

snide pushed a commit to snide/kibana that referenced this pull request Oct 13, 2021

[fleet] Add Integration Preference selector (elastic#114432)

7a2a215

thomasneirynck mentioned this pull request Oct 13, 2021

Allow users with read access to view Integrations app #113925

Merged

8 tasks

thomasneirynck pushed a commit to thomasneirynck/kibana that referenced this pull request Oct 13, 2021

[fleet] Add Integration Preference selector (elastic#114432)

957aaaa

thomasneirynck mentioned this pull request Oct 13, 2021

[7.x] [fleet] Add Integration Preference selector (#114432) #114910

Merged

thomasneirynck added a commit that referenced this pull request Oct 13, 2021

[fleet] Add Integration Preference selector (#114432) (#114910)

0686bac

Co-authored-by: Clint Andrew Hall <clint.hall@elastic.co>

gchaps mentioned this pull request Oct 14, 2021

[Integrations] Minor copy edits to Integrations page #115059

Closed

jen-huang mentioned this pull request Oct 26, 2021

[Fleet] "Elastic Agent and Beats" link On Integration>Browse tab goes nowhere #116253

Closed

clintandrewhall deleted the fleet/integration-preference branch December 29, 2021 17:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[fleet] Add Integration Preference selector #114432

[fleet] Add Integration Preference selector #114432

clintandrewhall commented Oct 11, 2021 •

edited

Loading

elasticmachine commented Oct 11, 2021

thomasneirynck commented Oct 11, 2021

alexfrancoeur commented Oct 12, 2021 •

edited

Loading

clintandrewhall commented Oct 12, 2021 •

edited

Loading

alexfrancoeur commented Oct 12, 2021

alexfrancoeur commented Oct 12, 2021 •

edited

Loading

mostlyjason commented Oct 12, 2021

alexfrancoeur commented Oct 12, 2021 •

edited

Loading

dborodyansky commented Oct 12, 2021

clintandrewhall commented Oct 12, 2021

kibanamachine commented Oct 13, 2021

joshdover commented Oct 13, 2021

snide left a comment

joshdover left a comment

mostlyjason commented Oct 13, 2021

kibanamachine commented Oct 13, 2021

alexfrancoeur commented Oct 13, 2021

snide commented Oct 13, 2021

thomasneirynck commented Oct 13, 2021

thomasneirynck commented Oct 13, 2021

hop-dev commented Oct 26, 2021

dedemorton commented Oct 26, 2021

alexfrancoeur commented Oct 26, 2021

[fleet] Add Integration Preference selector #114432

[fleet] Add Integration Preference selector #114432

Conversation

clintandrewhall commented Oct 11, 2021 • edited Loading

Summary

elasticmachine commented Oct 11, 2021

thomasneirynck commented Oct 11, 2021

alexfrancoeur commented Oct 12, 2021 • edited Loading

Elastic Agent (recommended) is selected

Beats is selected

clintandrewhall commented Oct 12, 2021 • edited Loading

Elastic Agent (recommended) is selected

Beats is selected

alexfrancoeur commented Oct 12, 2021

Elastic Agent (recommended) is selected

Beats is selected

alexfrancoeur commented Oct 12, 2021 • edited Loading

Elastic Agent (recommended) is selected

Beats is selected

mostlyjason commented Oct 12, 2021

alexfrancoeur commented Oct 12, 2021 • edited Loading

Recommended (default) is selected

Tooltip

Logic

Elastic Agent only is selected

Tooltip

Logic

Beats only is selected

Tooltip

Logic

dborodyansky commented Oct 12, 2021

clintandrewhall commented Oct 12, 2021

kibanamachine commented Oct 13, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

History

joshdover commented Oct 13, 2021

snide left a comment

Choose a reason for hiding this comment

joshdover left a comment

Choose a reason for hiding this comment

mostlyjason commented Oct 13, 2021

kibanamachine commented Oct 13, 2021

💔 Backport failed

alexfrancoeur commented Oct 13, 2021

snide commented Oct 13, 2021

thomasneirynck commented Oct 13, 2021

thomasneirynck commented Oct 13, 2021

hop-dev commented Oct 26, 2021

dedemorton commented Oct 26, 2021

alexfrancoeur commented Oct 26, 2021

clintandrewhall commented Oct 11, 2021 •

edited

Loading

alexfrancoeur commented Oct 12, 2021 •

edited

Loading

clintandrewhall commented Oct 12, 2021 •

edited

Loading

alexfrancoeur commented Oct 12, 2021 •

edited

Loading

alexfrancoeur commented Oct 12, 2021 •

edited

Loading