[Usage Collection] Improves Collector fetch API

[TinaHeiligers]

Why has my team been pinged?

This is a breaking change in the Kibana telemetry usage collectors' fetch method and required refactoring collectors in all the plugins that currently use callCluster.

Notes to reviewers:

All you need to do is check that the changes to your plugin usage collector (and unit tests) are ok.

PR details

Handles step 3 in #74840 (comment).

Summary:
Replaces callCluster and esClient as the arguments to collectors' fetch method with { callCluster, esClient }.

Description:
As part of migrating over to the new Elasticsearch client, we provided the new client as an additional parameter to the fetch method in collectors and pass the client down as an additional collection config parameter.

To use the new client forces plugin owners to provide the old client as well, which is not ideal.

This work refactors the way in which we provide the clients from individual arguments to an object, allowing plugins to select the client they wish to use.

Before:

const myCollector = usageCollection.makeUsageCollector<Usage>({
  type: 'MY_USAGE_TYPE',
  schema: {
    my_objects: {
      total: 'long',
    },
  },
  fetch: async (callCluster: APICluster, esClient: IClusterClient) => {
    return {
      my_objects: {
        total: SOME_NUMBER
      }
    };
  },
});

After:

interface CollectorFetchClients = {
  callCluster: LegacyAPICaller,
  esClient?: ElasticsearchClient
}

const myCollector = usageCollection.makeUsageCollector<Usage>({
  type: 'MY_USAGE_TYPE',
  schema: {
    my_objects: {
      total: 'long',
    },
  },
  fetch: async (collectorFetchClients: CollectorFetchClients) => {
    return {
      my_objects: {
        total: SOME_NUMBER
      }
    };
  },
});

This is a breaking change and required updates to all collectors using callCluster.

Checklist

• Documentation was added for features that require explanation or tutorials
• 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

[poffdeluxe]

Canvas changes lgtm

[Bamieh]

lgtm

[justinkambic]

Checked Uptime changes, telemetry logging appears to be working as I'd expect. LGTM

[TinaHeiligers]

@elasticmachine merge upstream

[lukasolson]

AppArch changes LGTM

[rylnd]

Security solution changes look good to me, thanks!

[azasypkin]

question: same question about importing from 'src/plugins/usage_collection/server/mocks' here as well.

[TinaHeiligers]

@azasypkin Also fixed

[stratoula]

KibanaApp code review only, LGTM!

[kibanamachine]

💛 Build succeeded, but was flaky

• continuous-integration/kibana-ci/pull-request
• Commit: 34effa8
• Flaky suites:
  • xpack-securitySolutionCypress

---

Test Failures

Creates a timeline.Timelines Creates a timeline

Link to Jenkins

Stack Trace

Failed Tests Reporter:
  - Test has failed 9 times on tracked branches: https://github.com/elastic/kibana/issues/79389

CypressError: `cy.wait()` could not find a registered alias for: `@timeline`.
You have not aliased anything yet.
    at aliasNotFoundFor (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:150289:22)
    at $Cy.getAlias (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:150252:7)
    at waitForXhr (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:159965:25)
    at http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:160054:14
    at tryCatcher (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:10325:23)
    at MappingPromiseArray._promiseFulfilled (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:7445:38)
    at MappingPromiseArray.PromiseArray._iterate (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:8647:31)
    at MappingPromiseArray.init (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:8611:10)
    at MappingPromiseArray._asyncInit (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:7414:10)
    at _drainQueueStep (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:5036:12)
    at _drainQueue (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:5025:9)
    at Async.../../node_modules/bluebird/js/release/async.js.Async._drainQueues (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:5041:5)
    at Async.drainQueues (http://elastic:changeme@localhost:6111/__cypress/runner/cypress_runner.js:4911:14)
From Your Spec Code:
    at Context.eval (http://localhost:6111/__cypress/tests?p=cypress/integration/timeline_creation.spec.ts:13497:35)

---

Metrics [docs]

✅ unchanged

History

• 💛 Build #81164 was flaky 0ed4b88
• 💚 Build #80968 succeeded feac734
• 💚 Build #80907 succeeded b4f4725
• 💚 Build #80653 succeeded fc70c94
• 💔 Build #80369 failed 2cad22d

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

[elasticmachine]

Pinging @elastic/kibana-core (Team:Core)