[Remote clusters] guard against usageCollection plugin if unavailable

[alisonelizabeth]

I noticed while reviewing #63255 that we don't guard against the usageCollection plugin in remote clusters, even though it is defined as an optional plugin. This PR addresses that concern.

To test, you can temporarily remove the usageCollection plugin here. Verify the app still works as expected.

[elasticmachine]

Pinging @elastic/es-ui (Team:Elasticsearch UI)

[cjcenizal]

Code LGTM, tested locally and everything works as expected, both when usageCollection is enabled and disabled. Just had one small suggestion.

[cjcenizal]

How about we leverage the UiStatsMetricType here to ensure only acceptable values are passed in?

import { UiStatsMetricType } from '@kbn/analytics';

export function trackUiMetric(type: UiStatsMetricType, name: string) {
  if (!usageCollection) {
    return;
  }
  const { reportUiStats } = usageCollection;
  reportUiStats(UIM_APP_NAME, type, name);
}

This would require the callsites to provide the lower-case enum values, e.g.

trackUiMetric('count', eventName);

In general I think I'm mostly suggesting this because I'm used to either seeing an enum key pulled directly off an enum (METRIC_TYPE.COUNT) or a reference to an enum value ('count'), but I'm not used to seeing a string reference to the enum's key ('COUNT').

EDIT: Another benefit is that it will automatically accommodate any new metric types that are added in the analytics package.

[alisonelizabeth]

👍 Great suggestion. I will update the PR.

[alisonelizabeth]

After looking into this some more, I don't believe your suggestion works, as UiStatsMetricType is actually a type that references the enum.

export type UiStatsMetricType = METRIC_TYPE.CLICK | METRIC_TYPE.LOADED | METRIC_TYPE.COUNT;

So, trackUiMetric('count', eventName); results in Argument of type '"count"' is not assignable to parameter of type 'UiStatsMetricType'.

I ended up importing METRIC_TYPE from @kbn/analytics. I think this might also be a little safer, as not all files have been converted to TS yet in remote clusters.

[alisonelizabeth]

@elasticmachine merge upstream

[kibanamachine]

💚 Build Succeeded

• continuous-integration/kibana-ci/pull-request
• Commit: 962ce28

History

• 💚 Build #40284 succeeded d2959c2
• 💚 Build #40227 succeeded 23c90b9

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