[Observability] Create context container to enable Observability plug…

…in registry function (#68642)

* creating observability context registry

* adding registryContext

* addressing PR comments

* addressing PR comments

* adding context to registry provider

* adding obs own registry

* refactoring

* refactoring

* fixing types

* removing apm code

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

x-pack/plugins/apm/public/plugin.ts

@@ -7,6 +7,7 @@
 import { i18n } from '@kbn/i18n';
 import { lazy } from 'react';
 import { ConfigSchema } from '.';
+import { ObservabilityPluginSetup } from '../../observability/public';
 import {
   AppMountParameters,
   CoreSetup,
@@ -33,10 +34,10 @@ import {
 import { AlertType } from '../common/alert_types';
 import { featureCatalogueEntry } from './featureCatalogueEntry';
 import { createCallApmApi } from './services/rest/createCallApmApi';
-import { createStaticIndexPattern } from './services/rest/index_pattern';
 import { setHelpExtension } from './setHelpExtension';
 import { toggleAppLinkInNav } from './toggleAppLinkInNav';
 import { setReadonlyBadge } from './updateBadge';
+import { createStaticIndexPattern } from './services/rest/index_pattern';
 
 export type ApmPluginSetup = void;
 export type ApmPluginStart = void;
@@ -48,6 +49,7 @@ export interface ApmPluginSetupDeps {
   home: HomePublicPluginSetup;
   licensing: LicensingPluginSetup;
   triggers_actions_ui: TriggersAndActionsUIPublicPluginSetup;
+  observability?: ObservabilityPluginSetup;
 }
 
 export interface ApmPluginStartDeps {
@@ -64,6 +66,7 @@ export class ApmPlugin implements Plugin<ApmPluginSetup, ApmPluginStart> {
     this.initializerContext = initializerContext;
   }
   public setup(core: CoreSetup, plugins: ApmPluginSetupDeps) {
+    createCallApmApi(core.http);
     const config = this.initializerContext.config.get();
     const pluginSetupDeps = plugins;
 
@@ -100,8 +103,6 @@ export class ApmPlugin implements Plugin<ApmPluginSetup, ApmPluginStart> {
     });
   }
   public start(core: CoreStart, plugins: ApmPluginStartDeps) {
-    createCallApmApi(core.http);
-
     toggleAppLinkInNav(core, this.initializerContext.config.get());
 
     plugins.triggers_actions_ui.alertTypeRegistry.register({

x-pack/plugins/observability/public/data_handler.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { FetchData, HasData } from './typings/data_handler';
+import { ObservabilityApp } from '../typings/common';
+
+interface DataHandler {
+  fetchData: FetchData;
+  hasData: HasData;
+}
+
+const dataHandlers: Partial<Record<ObservabilityApp, DataHandler>> = {};
+
+export type RegisterDataHandler = (params: { appName: ObservabilityApp } & DataHandler) => void;
+export const registerDataHandler: RegisterDataHandler = ({ appName, fetchData, hasData }) => {
+  dataHandlers[appName] = { fetchData, hasData };
+};
+
+export function getDataHandler(appName: ObservabilityApp): DataHandler | undefined {
+  return dataHandlers[appName];
+}

x-pack/plugins/observability/public/hooks/use_track_metric.tsx

@@ -8,6 +8,7 @@ import { useEffect, useMemo } from 'react';
 import { METRIC_TYPE, UiStatsMetricType } from '@kbn/analytics';
 import { UsageCollectionSetup } from 'src/plugins/usage_collection/public';
 import { useKibana } from '../../../../../src/plugins/kibana_react/public';
+import { ObservabilityApp } from '../../typings/common';
 
 /**
  * Note: The usage_collection plugin will take care of sending this data to the telemetry server.
@@ -17,8 +18,6 @@ import { useKibana } from '../../../../../src/plugins/kibana_react/public';
  * a value, which will be a counter
  */
 
-type ObservabilityApp = 'infra_metrics' | 'infra_logs' | 'apm' | 'uptime';
-
 interface TrackOptions {
   app?: ObservabilityApp;
   metricType?: UiStatsMetricType;

x-pack/plugins/observability/public/index.ts

@@ -5,14 +5,16 @@
  */
 
 import { PluginInitializerContext, PluginInitializer } from 'kibana/public';
-import { Plugin, ClientSetup, ClientStart } from './plugin';
+import { Plugin, ObservabilityPluginSetup, ObservabilityPluginStart } from './plugin';
 
-export const plugin: PluginInitializer<ClientSetup, ClientStart> = (
+export const plugin: PluginInitializer<ObservabilityPluginSetup, ObservabilityPluginStart> = (
   context: PluginInitializerContext
 ) => {
   return new Plugin(context);
 };
 
+export { ObservabilityPluginSetup, ObservabilityPluginStart };
+
 export * from './components/action_menu';
 
 export {

x-pack/plugins/observability/public/plugin.ts

@@ -10,11 +10,15 @@ import {
   Plugin as PluginClass,
   PluginInitializerContext,
 } from '../../../../src/core/public';
+import { RegisterDataHandler, registerDataHandler } from './data_handler';
 
-export type ClientSetup = void;
-export type ClientStart = void;
+export interface ObservabilityPluginSetup {
+  dashboard: { register: RegisterDataHandler };
+}
+
+export type ObservabilityPluginStart = void;
 
-export class Plugin implements PluginClass<ClientSetup, ClientStart> {
+export class Plugin implements PluginClass<ObservabilityPluginSetup, ObservabilityPluginStart> {
   constructor(context: PluginInitializerContext) {}
 
   public setup(core: CoreSetup) {
@@ -25,7 +29,7 @@ export class Plugin implements PluginClass<ClientSetup, ClientStart> {
       appRoute: '/app/observability',
       category: DEFAULT_APP_CATEGORIES.observability,
 
-      async mount(params: AppMountParameters<unknown>) {
+      mount: async (params: AppMountParameters<unknown>) => {
         // Load application bundle
         const { renderApp } = await import('./application');
         // Get start services
@@ -34,6 +38,10 @@ export class Plugin implements PluginClass<ClientSetup, ClientStart> {
         return renderApp(coreStart, params);
       },
     });
+
+    return {
+      dashboard: { register: registerDataHandler },
+    };
   }
   public start() {}
 }

x-pack/plugins/observability/public/typings/data_handler/index.d.ts

@@ -0,0 +1,42 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+interface Stat {
+  label: string;
+  value: string;
+  color?: string;
+}
+
+export interface Coordinates {
+  x: number;
+  y?: number;
+}
+
+interface Series {
+  label: string;
+  coordinates: Coordinates[];
+  color?: string;
+  key?: string;
+}
+
+interface FetchDataResponse {
+  title: string;
+  appLink: string;
+  stats: Stat[];
+  series: Series[];
+}
+interface FetchDataParams {
+  // The start timestamp in milliseconds of the queried time interval
+  startTime: string;
+  // The end timestamp in milliseconds of the queried time interval
+  endTime: string;
+  // The aggregation bucket size in milliseconds if applicable to the data source
+  bucketSize: string;
+}
+
+export type FetchData = (fetchDataParams: FetchDataParams) => Promise<FetchDataResponse>;
+
+export type HasData = () => Promise<boolean>;

x-pack/plugins/observability/typings/common.ts

@@ -4,6 +4,8 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+export type ObservabilityApp = 'infra_metrics' | 'infra_logs' | 'apm' | 'uptime';
+
 export type PromiseReturnType<Func> = Func extends (...args: any[]) => Promise<infer Value>
   ? Value
   : Func;