[Usage collection] refactor cloud detector collector #110439

Bamieh · 2021-08-30T09:12:27Z

Summary

getting rid of the constructor args which are only there for testing purposes (request, fs), and mocking those in the tests
getting rid of the use of the request lib in favor of something like node-fetch which we use more widely in kibana (request looks like it's mostly used in tests atm, not many other places)
adding some retry logic to the detector in the event of a retryable failure. Decided not to add any retry logic to the detectors:
- Adding a generic retry logic will only increase the time for detection since we are expecting errors to be returned from providers if the deployment is not hosted there.
- Retrying on the documented codes (404, 403, or 401) is unncessary since replaying requests will result in the same error codes.
- Retrying on timeouts will only increase time for detection since pinging an invalid host will timeout in some cases.
updating GCP logic to still return values even if a request for one of the fields fails, instead of using an all-or-nothing approach

Testing

Using https://github.com/lukeelmers/terraform-kibana-dev to manually test the changes are working on each cloud provider:

Tested an AWS deployment
Tested an Azure deployment
Tested a GCP deployment

TinaHeiligers · 2021-08-30T21:34:51Z

src/plugins/kibana_usage_collection/server/collectors/cloud/detector/aws.test.ts

-      const response = await awsCheckedFileSystem._checkIfService(request);
+      const response = await awsService['_checkIfService']();
+      expect(readFile).toBeCalledTimes(0);
+      expect(fetchMock).toBeCalledTimes(1);


Is asserting against the number of times fetchMock is called not redundant considering that we assert against what the mock is called with?
In other words, are there specific situations that might cause fetch to be called multiple times?

we have no way of detecting if fetch was called multiple times by any reason without this expect. Checking what the fetech is being called with wouldnt detect how many times the fetch was called. Having this check helps a lot when we're refactoring code in the future as it might catch unexpected changes.

TinaHeiligers · 2021-08-30T21:39:01Z

src/plugins/kibana_usage_collection/server/collectors/cloud/detector/aws.test.ts

-          imageId: 'ami-6df1e514',
-        },
-      });
+      expect(response.toJSON()).toMatchInlineSnapshot(`


Is there a reason to change from asserting equality to asserting against a snapshot? Snapshots tend to get stale and I don't see anything obvious that prevents us using toEqual.
The same question applies to the other changes from

expect(response.toJSON()).toEqual({...}) -> expect(response.toJSON()).toMatchInlineSnapshot(...)

Both are equavilant in what they are checking. using inline snapshots saves us time manually changing the values inside the object rather than just updating the snapshots and verifying they adhere to the expected changes. I dont like using variables inside the toEqual from outside the thing that is being tested as it makes the test less verbose and might allow some bugs to pass.

TinaHeiligers · 2021-08-30T21:39:47Z

src/plugins/kibana_usage_collection/server/collectors/cloud/detector/aws.test.ts

-        zone: undefined,
-        metadata: undefined,
-      });
+      expect(response.toJSON()).toMatchInlineSnapshot(`


Same question as https://github.com/elastic/kibana/pull/110439/files?file-filters%5B%5D=.lock&file-filters%5B%5D=.ts#r698826624

TinaHeiligers · 2021-08-30T22:43:45Z

src/plugins/kibana_usage_collection/server/collectors/cloud/detector/cloud_detector.ts

@@ -37,9 +37,9 @@ export class CloudDetector {
  /**
   * Get any cloud details that we have detected.
   */
-  getCloudDetails() {
+  public getCloudDetails = () => {


I had to look up the subtle binding differences again and cross check the change against how we're class 😅 .

TinaHeiligers

Thanks for tackling this!
Overall, the changes LGTM, although we could improve on where we declare and use the required cgp header.

src/plugins/kibana_usage_collection/server/collectors/cloud/detector/gcp.ts

lukeelmers · 2021-09-02T20:17:56Z

adding some retry logic to the detector in the event of a retryable failure. Decided not to add any retry logic to the detectors:

Adding a generic retry logic will only increase the time for detection since we are expecting errors to be returned from providers if the deployment is not hosted there.

Retrying on the documented codes (404, 403, or 401) is unncessary since replaying requests will result in the same error codes.

Retrying on timeouts will only increase time for detection since pinging an invalid host will timeout in some cases.

These reasons make sense, but since the usage collector is running this in the background, I'm wondering if we really care about the length of time for detection? It seems we could still retry w/ backoff on 5xx errors if we wanted.

I don't have particularly strong feelings on this as I don't think retries are critical for this case, but just wanted to mention it.

…ove_request_package

kibanamachine · 2021-09-10T19:42:22Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💚 Build #152188 succeeded 1cd3c5b
💚 Build #149387 succeeded 368178e

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

kibanamachine · 2021-09-10T19:45:26Z

💚 Backport successful

Status	Branch	Result
✅	7.x

This backport PR will be merged automatically after passing CI.

Co-authored-by: Ahmad Bamieh <[email protected]>

…-link-to-kibana-app * 'master' of github.com:elastic/kibana: (120 commits) [TSVB] Support custom field format (elastic#101245) [VisEditors] Add code ownership to the functional tests (elastic#111680) [Lens] Make Lens saved object share-capable (elastic#111403) [Graph] Make Graph saved object share-capable (elastic#111404) [Stack Monitoring] Add breadcrumb support (elastic#111850) Update Jira Cloud to use OAuth2.0 (elastic#111493) Show warning message when attempting to create an APM alert in stack management (elastic#111781) Skip suite blocking ES snapshot promotion (elastic#111907) Respect `auth_provider_hint` if session is not authenticated. (elastic#111521) Added in 'Responses' field in alert telemetry & updated test (elastic#111892) [Usage collection] refactor cloud detector collector (elastic#110439) Make classnames a shared dep (elastic#111636) Fix link to e2e tests in APM testing.md (elastic#111869) [Security Solution] Add host.os.name.caseless mapping and runtime field (elastic#111455) [APM] Removes the beta label from APM tutorial (elastic#111499) (elastic#111828) [RAC] [Observability] Expand Observability alerts page functional tests (elastic#111297) Fix extra white space on the alert table whe page size is 50 or 100 (elastic#111568) [Metrics UI] Add Inventory Timeline open/close state to context and URL state (elastic#111034) [Graph] Switch to SavedObjectClient.resolve (elastic#109617) [APM] Adding lambda icon (elastic#111834) ... # Conflicts: # x-pack/plugins/reporting/public/management/__snapshots__/report_listing.test.tsx.snap

Bamieh added 3 commits August 30, 2021 10:34

first itteration

112be62

merge master and remove request package

9dab474

finish refactor + remove request package

d3deaa8

Bamieh added v8.0.0 release_note:skip Skip the PR/issue when compiling release notes auto-backport Deprecated - use backport:version if exact versions are needed v7.16.0 labels Aug 30, 2021

gcp promises: allSettled instead of all

368178e

Bamieh marked this pull request as ready for review August 30, 2021 11:13

Bamieh requested a review from a team as a code owner August 30, 2021 11:13

TinaHeiligers reviewed Aug 30, 2021

View reviewed changes

TinaHeiligers approved these changes Aug 30, 2021

View reviewed changes

src/plugins/kibana_usage_collection/server/collectors/cloud/detector/gcp.ts Outdated Show resolved Hide resolved

Bamieh added 3 commits September 9, 2021 15:03

gcp headers into a constant

9124470

Merge branch 'master' of github.com:elastic/kibana into telemetry/rem…

1cd3c5b

…ove_request_package

merge master

632199c

Bamieh enabled auto-merge (squash) September 10, 2021 17:22

Bamieh merged commit 13560c0 into elastic:master Sep 10, 2021

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Sep 10, 2021

[Usage collection] refactor cloud detector collector (elastic#110439)

9a8cc06

kibanamachine mentioned this pull request Sep 10, 2021

[7.x] [Usage collection] refactor cloud detector collector (#110439) #111898

Merged

Bamieh deleted the telemetry/remove_request_package branch September 10, 2021 20:27

kibanamachine added a commit that referenced this pull request Sep 10, 2021

[Usage collection] refactor cloud detector collector (#110439) (#111898)

f12b010

Co-authored-by: Ahmad Bamieh <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Usage collection] refactor cloud detector collector #110439

[Usage collection] refactor cloud detector collector #110439

Bamieh commented Aug 30, 2021 •

edited

Loading

TinaHeiligers Aug 30, 2021

Bamieh Aug 31, 2021

TinaHeiligers Aug 30, 2021 •

edited

Loading

Bamieh Aug 31, 2021

TinaHeiligers Aug 30, 2021

TinaHeiligers Aug 30, 2021

TinaHeiligers left a comment

lukeelmers commented Sep 2, 2021

kibanamachine commented Sep 10, 2021

kibanamachine commented Sep 10, 2021

[Usage collection] refactor cloud detector collector #110439

[Usage collection] refactor cloud detector collector #110439

Conversation

Bamieh commented Aug 30, 2021 • edited Loading

Summary

Testing

TinaHeiligers Aug 30, 2021

Choose a reason for hiding this comment

Bamieh Aug 31, 2021

Choose a reason for hiding this comment

TinaHeiligers Aug 30, 2021 • edited Loading

Choose a reason for hiding this comment

Bamieh Aug 31, 2021

Choose a reason for hiding this comment

TinaHeiligers Aug 30, 2021

Choose a reason for hiding this comment

TinaHeiligers Aug 30, 2021

Choose a reason for hiding this comment

TinaHeiligers left a comment

Choose a reason for hiding this comment

lukeelmers commented Sep 2, 2021

kibanamachine commented Sep 10, 2021

💚 Build Succeeded

Metrics [docs]

History

kibanamachine commented Sep 10, 2021

💚 Backport successful

Bamieh commented Aug 30, 2021 •

edited

Loading

TinaHeiligers Aug 30, 2021 •

edited

Loading