[Fleet] Show Count of Agent Policies on Integration Details #86916

paul-tavares · 2020-12-23T20:32:09Z

Summary

Show the total unique count of Agent Policies currently using the given Integration on the page header
Adds new API /api/fleet/epm/packages/{pkgName}/stats which returns summary of agent policies

Closes #86369

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios

…add-used-by-counts

elasticmachine · 2020-12-23T20:32:12Z

Pinging @elastic/ingest-management (Team:Ingest Management)

paul-tavares · 2020-12-23T20:35:54Z

x-pack/plugins/fleet/public/applications/fleet/sections/epm/screens/detail/index.test.tsx

@@ -190,12 +224,27 @@ describe('when on integration detail', () => {
  });
 });

-interface MockedApi {
+interface MockedApi<


Some of this here is refactoring which will facilitate breaking this out to a separate set of test utilities so that this approach can be used with other test areas of Fleet.
The mocked api interface could now also return the set of functions that are used to fulfill the API calls, which allow each test case to adjust them (if necessary) before rendering the UI. An example of this can be seen above on line 69-70

jfsiii

I appreciate the tests. Can we wait to merge this until we've had a chance to discuss the goal of the new endpoint and any alternative names / locations?

Alternatively, we could merge this knowing it's subject to change on further review

paul-tavares · 2020-12-28T13:33:35Z

@jfsiii sure, we can wait on this until a broader discussion can be had. Thanks for looking at it.

nchaulet

Code looks good, and works as expected. It so nice to start to see some frontend tests in Fleet :)
We should probably add this endpoint to our Open API spec

nchaulet · 2021-01-06T16:32:33Z

x-pack/plugins/fleet/common/constants/routes.ts

@@ -29,6 +29,7 @@ export const EPM_API_ROUTES = {
  DELETE_PATTERN: EPM_PACKAGES_ONE,
  FILEPATH_PATTERN: `${EPM_PACKAGES_FILE}/{filePath*}`,
  CATEGORIES_PATTERN: `${EPM_API_ROOT}/categories`,
+  SUMMARY_PATTERN: `${EPM_PACKAGES_MANY}/{pkgName}/summary`,


nitpick maybe change the name to something a little less generic /stats /usages

👍 Let's go with /stats since @jen-huang also suggested that for the name

…add-used-by-counts # Conflicts: # x-pack/plugins/fleet/server/routes/epm/handlers.ts

pzl

Functionally, seems all good.

Noted a few places that could be cleaned up

x-pack/plugins/fleet/public/applications/fleet/sections/epm/screens/detail/index.test.tsx

pzl · 2021-01-07T00:26:16Z

x-pack/plugins/fleet/common/constants/routes.ts

@@ -29,6 +29,7 @@ export const EPM_API_ROUTES = {
  DELETE_PATTERN: EPM_PACKAGES_ONE,
  FILEPATH_PATTERN: `${EPM_PACKAGES_FILE}/{filePath*}`,
  CATEGORIES_PATTERN: `${EPM_API_ROOT}/categories`,
+  STATS_PATTERN: `${EPM_PACKAGES_MANY}/{pkgName}/stats`,


This seems to be called summary elsewhere. Perhaps we should make the var names consistent, to mentally correlate them a bit better.

If the route already exists and is /stats, I can see giving the route's var name the same as the route itself. But then it's switched to called summary on the layer right outside that. Consider naming the pattern var name summary as well. Reduces the mental context switch to just here, next to the route, which is a little more concrete to reason about.

I have renamed everything else *Stats* in order keep consistent with this decision here 😄 . Thanks for highlighting that - "me culpa" 😞

x-pack/plugins/fleet/server/routes/epm/index.ts

pzl · 2021-01-07T00:36:11Z

x-pack/plugins/fleet/server/services/epm/packages/get.test.ts

+          updated_at: '2020-12-22T21:28:05.383Z',
+          version: 'WzE1NTAsMV0=',
+          score: 0,
+        },


Is this much mocking and setup really necessary for testing paging?

yes and no. Some packge policies (integration policies) can have the same Agent Policy id (with the exception of Endpoint, every other integration can be added to agent policies multiple times). The multiples assigned to the same agent policy is to ensure the counts remain accurate (it should just be counted once)

x-pack/plugins/fleet/server/services/epm/packages/get.test.ts

pzl · 2021-01-07T00:42:56Z

x-pack/plugins/fleet/server/services/epm/packages/get.test.ts

+        let savedObjectsResponse: typeof savedObjects;
+
+        switch (page) {
+          case 1:


so in this mock.. if it's page 1, you return index 1, the second element.

If it's page 2, you return indices 1,2,3?

It's not clear why you're doing this. It also doesn't seem like any of these scenarios are necessary in the tests below.

unless this is strictly for making sure the getPackageUsageSummary call doesn't error, but then I think this could all be simpler

Good catch. This here (below) should be savedObjects[0].
the idea is:

page 1 - return first item in array

page 2 - return every other array item after the first one

Doing this ensures that paging through the data works and that it de-dups the packages that are assigned to the same agent policy

…add-used-by-counts

paul-tavares · 2021-01-07T20:04:13Z

Ok. I think I got all of @pzl comment in. Ready for another round of 👀

paul-tavares · 2021-01-11T12:52:51Z

@elasticmachine merge upstream

pzl · 2021-01-11T14:08:31Z

x-pack/plugins/fleet/server/services/epm/packages/get.ts

+    // in order to not cause a circular dependency (package policy service imports from this module)
+    const packagePolicies = await savedObjectsClient.find<PackagePolicySOAttributes>({
+      type: PACKAGE_POLICY_SAVED_OBJECT_TYPE,
+      perPage: 1000,


jfsiii

I see some lingering references to *Summary (mostly in fleet/sections/epm/screens/detail/index.test.tsx). I'd like to remove them before merging, but we can merge and follow up.

paul-tavares · 2021-01-11T16:02:20Z

Thanks @jfsiii . I am fixing those now 🙂

…nts' into task/fleet-86369-add-used-by-counts

…add-used-by-counts

…add-used-by-counts # Conflicts: # x-pack/plugins/fleet/server/services/epm/packages/get.ts

kibanamachine · 2021-01-11T21:38:18Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 4c3d739

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`fleet`	458	459	+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`	967.9KB	969.0KB	+1.2KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`fleet`	376.8KB	376.9KB	+142.0B

History

💚 Build #97951 succeeded 9bcd2d8
💚 Build #97889 succeeded 3eefff1
💚 Build #97695 succeeded 87daa10
💚 Build #97367 succeeded 6da3349
💚 Build #96212 succeeded a3240ab

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

…88068) * component to show count of agent policies for integration * API route and service to return stats of package usage

paul-tavares added 9 commits December 22, 2020 09:09

component to show count of agent policies for integration

8f209ef

front end setup for retrieving package summary from an api

1796a5d

API route registration and setup for summary stats

1e7ce9f

service to return summary of package usage

58b0d39

Change display of count on UI

874998c

Tests for getPackageUsageSummary() service

9f2bb2a

Adjust test case

ffb866d

Merge remote-tracking branch 'upstream/master' into task/fleet-86369-…

c0f04d6

…add-used-by-counts

UI tests for when package in installed and uninstalled + refacror

a3240ab

paul-tavares added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v7.12.0 Team:Defend Workflows “EDR Workflows” sub-team of Security Solution labels Dec 23, 2020

paul-tavares self-assigned this Dec 23, 2020

paul-tavares requested a review from a team December 23, 2020 20:32

paul-tavares commented Dec 23, 2020

View reviewed changes

jfsiii suggested changes Dec 24, 2020

View reviewed changes

nchaulet approved these changes Jan 6, 2021

View reviewed changes

paul-tavares added 2 commits January 6, 2021 12:26

Merge remote-tracking branch 'upstream/master' into task/fleet-86369-…

d4e9dd9

…add-used-by-counts # Conflicts: # x-pack/plugins/fleet/server/routes/epm/handlers.ts

rename API endpoint to /stats

6da3349

paul-tavares requested a review from jfsiii January 6, 2021 17:40

paul-tavares mentioned this pull request Jan 6, 2021

[Ingest Manager] Missing parts in OpenAPI specs #79574

Closed

22 tasks

pzl approved these changes Jan 7, 2021

View reviewed changes

paul-tavares added 4 commits January 7, 2021 14:06

Correct test label

89f49eb

Rename several types and methods (from *summary* to *stats*)

b67afc1

Fix mock api response

c30a3c1

Merge remote-tracking branch 'upstream/master' into task/fleet-86369-…

87daa10

…add-used-by-counts

paul-tavares requested a review from pzl January 7, 2021 20:03

Merge branch 'master' into task/fleet-86369-add-used-by-counts

3eefff1

pzl reviewed Jan 11, 2021

View reviewed changes

pzl approved these changes Jan 11, 2021

View reviewed changes

jfsiii approved these changes Jan 11, 2021

View reviewed changes

paul-tavares added 4 commits January 11, 2021 11:05

Refactored var names/types from *Summary to *Stats

13604f0

Merge remote-tracking branch 'origin/task/fleet-86369-add-used-by-cou…

3b4d481

…nts' into task/fleet-86369-add-used-by-counts

Merge remote-tracking branch 'upstream/master' into task/fleet-86369-…

9bcd2d8

…add-used-by-counts

Merge remote-tracking branch 'upstream/master' into task/fleet-86369-…

4c3d739

…add-used-by-counts # Conflicts: # x-pack/plugins/fleet/server/services/epm/packages/get.ts

paul-tavares merged commit 02695ef into elastic:master Jan 12, 2021

paul-tavares deleted the task/fleet-86369-add-used-by-counts branch January 12, 2021 12:56

This was referenced Jan 12, 2021

[7.x] [Fleet] Show Count of Agent Policies on Integration Details (#86916) #88008

Closed

[7.x] [Fleet] Show Count of Agent Policies on Integration Details (#86916) #88068

Merged

paul-tavares added a commit that referenced this pull request Jan 13, 2021

[Fleet] Show Count of Agent Policies on Integration Details (#86916) (#…

bfbd584

…88068) * component to show count of agent policies for integration * API route and service to return stats of package usage

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Fleet] Show Count of Agent Policies on Integration Details #86916

[Fleet] Show Count of Agent Policies on Integration Details #86916

paul-tavares commented Dec 23, 2020 •

edited

Loading

elasticmachine commented Dec 23, 2020

paul-tavares Dec 23, 2020 •

edited

Loading

jfsiii left a comment

paul-tavares commented Dec 28, 2020

nchaulet left a comment

nchaulet Jan 6, 2021

paul-tavares Jan 6, 2021

pzl left a comment

pzl Jan 7, 2021

paul-tavares Jan 7, 2021

pzl Jan 7, 2021

paul-tavares Jan 7, 2021 •

edited

Loading

pzl Jan 7, 2021

paul-tavares Jan 7, 2021

paul-tavares commented Jan 7, 2021

paul-tavares commented Jan 11, 2021

pzl Jan 11, 2021

jfsiii left a comment

paul-tavares commented Jan 11, 2021

kibanamachine commented Jan 11, 2021

[Fleet] Show Count of Agent Policies on Integration Details #86916

[Fleet] Show Count of Agent Policies on Integration Details #86916

Conversation

paul-tavares commented Dec 23, 2020 • edited Loading

Summary

Checklist

elasticmachine commented Dec 23, 2020

paul-tavares Dec 23, 2020 • edited Loading

Choose a reason for hiding this comment

jfsiii left a comment

Choose a reason for hiding this comment

paul-tavares commented Dec 28, 2020

nchaulet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pzl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paul-tavares Jan 7, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paul-tavares commented Jan 7, 2021

paul-tavares commented Jan 11, 2021

Choose a reason for hiding this comment

jfsiii left a comment

Choose a reason for hiding this comment

paul-tavares commented Jan 11, 2021

kibanamachine commented Jan 11, 2021

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

paul-tavares commented Dec 23, 2020 •

edited

Loading

paul-tavares Dec 23, 2020 •

edited

Loading

paul-tavares Jan 7, 2021 •

edited

Loading