Use new es client in Uptime usage collector #86718

TinaHeiligers · 2020-12-21T23:44:47Z

Summary

Refactors the fetch method in the uptime usage collector (KibanaTelemetryAdapter) to use the new elasticsearch client rather than the deprecated legacy client.
Part of #86358

Checklist

Delete any items that are not applicable to this PR.

Unit or functional tests were updated or added to match the most common scenarios

For maintainers

This was checked for breaking API changes and was labeled appropriately

TinaHeiligers · 2020-12-22T00:06:36Z

@elasticmachine merge upstream

elasticmachine · 2020-12-22T18:43:55Z

Pinging @elastic/uptime (Team:uptime)

TinaHeiligers · 2020-12-27T22:59:47Z

@elasticmachine merge upstream

TinaHeiligers · 2020-12-31T17:50:25Z

@elasticmachine merge upstream

shahzad31 · 2021-01-04T12:52:41Z

x-pack/plugins/uptime/server/lib/adapters/telemetry/kibana_telemetry_adapter.ts

        const savedObjectsClient = getSavedObjectsClient()!;
        if (savedObjectsClient) {
-          await this.countNoOfUniqueMonitorAndLocations(callCluster, savedObjectsClient);
+          await this.countNoOfUniqueMonitorAndLocations(esClient, savedObjectsClient);


Suggested change

await this.countNoOfUniqueMonitorAndLocations(esClient, savedObjectsClient);

const uptimeEsClient = createUptimeESClient({ esClient, savedObjectsClient });

await this.countNoOfUniqueMonitorAndLocations(uptimeEsClient, savedObjectsClient);

i think doing it like this will simplify things

@shahzad31 The types for the SavedObjectsClient aren't the same in the collector and in createUptimeEsClient. In the collector, savedObjectsClient is of type ISavedObjectsRepository | undefined, whereas createUptimeEsClient expects savedObjectsClient to be of type SavedObjectsClientContract. We're missing errors in the type that's being passed in.

@shahzad31 we can get around this by changing the savedObjectsClient type expected in createUptimeESClient to be SavedObjectsClientContract | ISavedObjectsRepository. Could you please take a look at the changes and approve or request changes if needed?

@TinaHeiligers yeah i think that can work.

shahzad31 · 2021-01-04T17:10:17Z

x-pack/plugins/uptime/server/lib/adapters/telemetry/kibana_telemetry_adapter.ts

+    const { body: result } = isUptimeESClient(callCluster)
+      ? await callCluster.search(params)
+      : await callCluster.search<ESSearchResponse<unknown, typeof params>>(params);


with your last commit i think, we can simplify this.

@shahzad31 Great thinking, thank you for pointing that out!
I've replaced the conditional here

shahzad31 · 2021-01-04T17:10:44Z

x-pack/plugins/uptime/server/lib/adapters/telemetry/kibana_telemetry_adapter.ts

@@ -132,7 +130,7 @@ export class KibanaTelemetryAdapter {
  }

  public static async countNoOfUniqueMonitorAndLocations(
-    callCluster: ILegacyScopedClusterClient['callAsCurrentUser'] | UptimeESClient,
+    callCluster: ElasticsearchClient | UptimeESClient,


this will now only be UptimeESClient

@shahzad31 Thanks for catching that! Done

TinaHeiligers · 2021-01-04T20:21:12Z

@shahzad31 Hopefully the third time reviewing this will be it.

kibanamachine · 2021-01-04T22:28:29Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: f63fe37

Metrics [docs]

Distributable file count

id	before	after	diff
`default`	47266	48026	+760

History

💚 Build #96694 succeeded 7dc1ed4
💚 Build #96493 succeeded 051a6cc
💚 Build #96274 succeeded 4bf3708
💚 Build #96106 succeeded 920cb24
💚 Build #96002 succeeded e2014a3

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

shahzad31

LGTM !!

Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kibana Machine <[email protected]>

Describes ts-ignore reason better

6231adb

TinaHeiligers added Feature:Telemetry v8.0.0 Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability release_note:skip Skip the PR/issue when compiling release notes v7.12.0 labels Dec 21, 2020

kibanamachine and others added 3 commits December 21, 2020 19:06

Merge branch 'master' into uptime-usage-collector-refactor

3788b87

Merge branch 'master' into uptime-usage-collector-refactor

eb87c64

Refactors to fix types

e2014a3

TinaHeiligers marked this pull request as ready for review December 22, 2020 18:43

TinaHeiligers requested a review from a team as a code owner December 22, 2020 18:43

TinaHeiligers changed the title ~~use new es client in Uptime usage collector~~ Use new es client in Uptime usage collector Dec 23, 2020

Improves types

920cb24

TinaHeiligers mentioned this pull request Dec 23, 2020

Migrate Telemetry plugins' Elasticsearch client #86907

Closed

3 tasks

Merge branch 'master' into uptime-usage-collector-refactor

4bf3708

Merge branch 'master' into uptime-usage-collector-refactor

051a6cc

shahzad31 requested changes Jan 4, 2021

View reviewed changes

TinaHeiligers added 2 commits January 4, 2021 09:07

Merge branch 'master' into uptime-usage-collector-refactor

05b86c2

Use createUptimeEsClient to simplify collector initialization

7dc1ed4

TinaHeiligers requested a review from shahzad31 January 4, 2021 17:02

shahzad31 reviewed Jan 4, 2021

View reviewed changes

Types cleanup and simplification

f63fe37

TinaHeiligers requested a review from shahzad31 January 4, 2021 20:42

shahzad31 approved these changes Jan 5, 2021

View reviewed changes

TinaHeiligers merged commit ff94674 into elastic:master Jan 5, 2021

TinaHeiligers deleted the uptime-usage-collector-refactor branch January 5, 2021 15:32

TinaHeiligers mentioned this pull request Jan 5, 2021

[7.x] Use new es client in Uptime usage collector (#86718) #87321

Merged

TinaHeiligers added a commit that referenced this pull request Jan 5, 2021

[7.x] Use new es client in Uptime usage collector (#86718) (#87321)

74f3472

Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: Kibana Machine <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use new es client in Uptime usage collector #86718

Use new es client in Uptime usage collector #86718

TinaHeiligers commented Dec 21, 2020 •

edited

Loading

TinaHeiligers commented Dec 22, 2020

elasticmachine commented Dec 22, 2020

TinaHeiligers commented Dec 27, 2020

TinaHeiligers commented Dec 31, 2020

shahzad31 Jan 4, 2021

TinaHeiligers Jan 4, 2021

TinaHeiligers Jan 4, 2021 •

edited

Loading

shahzad31 Jan 4, 2021

shahzad31 Jan 4, 2021

TinaHeiligers Jan 4, 2021 •

edited

Loading

shahzad31 Jan 4, 2021

TinaHeiligers Jan 4, 2021 •

edited

Loading

TinaHeiligers commented Jan 4, 2021

kibanamachine commented Jan 4, 2021

shahzad31 left a comment

	await this.countNoOfUniqueMonitorAndLocations(esClient, savedObjectsClient);
	const uptimeEsClient = createUptimeESClient({ esClient, savedObjectsClient });
	await this.countNoOfUniqueMonitorAndLocations(uptimeEsClient, savedObjectsClient);

Use new es client in Uptime usage collector #86718

Use new es client in Uptime usage collector #86718

Conversation

TinaHeiligers commented Dec 21, 2020 • edited Loading

Summary

Checklist

For maintainers

TinaHeiligers commented Dec 22, 2020

elasticmachine commented Dec 22, 2020

TinaHeiligers commented Dec 27, 2020

TinaHeiligers commented Dec 31, 2020

shahzad31 Jan 4, 2021

Choose a reason for hiding this comment

TinaHeiligers Jan 4, 2021

Choose a reason for hiding this comment

TinaHeiligers Jan 4, 2021 • edited Loading

Choose a reason for hiding this comment

shahzad31 Jan 4, 2021

Choose a reason for hiding this comment

shahzad31 Jan 4, 2021

Choose a reason for hiding this comment

TinaHeiligers Jan 4, 2021 • edited Loading

Choose a reason for hiding this comment

shahzad31 Jan 4, 2021

Choose a reason for hiding this comment

TinaHeiligers Jan 4, 2021 • edited Loading

Choose a reason for hiding this comment

TinaHeiligers commented Jan 4, 2021

kibanamachine commented Jan 4, 2021

💚 Build Succeeded

Metrics [docs]

Distributable file count

History

shahzad31 left a comment

Choose a reason for hiding this comment

TinaHeiligers commented Dec 21, 2020 •

edited

Loading

TinaHeiligers Jan 4, 2021 •

edited

Loading

TinaHeiligers Jan 4, 2021 •

edited

Loading

TinaHeiligers Jan 4, 2021 •

edited

Loading