[Observability]Adding specific Return APIs for each plugin

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

@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { FetchData, HasData } from './typings/data_handler';
+import { FetchData, HasData, ObservabilityFetchDataResponse } from './typings/data_handler';
 import { ObservabilityApp } from '../typings/common';
 
 interface DataHandler {
@@ -14,7 +14,12 @@ interface DataHandler {
 
 const dataHandlers: Partial<Record<ObservabilityApp, DataHandler>> = {};
 
-export type RegisterDataHandler = (params: { appName: ObservabilityApp } & DataHandler) => void;
+export type RegisterDataHandler<T extends ObservabilityApp = ObservabilityApp> = (params: {
+  appName: T;
+  fetchData: FetchData<ObservabilityFetchDataResponse[T]>;
+  hasData: HasData;
+}) => void;
+
 export const registerDataHandler: RegisterDataHandler = ({ appName, fetchData, hasData }) => {
   dataHandlers[appName] = { fetchData, hasData };
 };

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

@@ -4,9 +4,16 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-interface Stat {
-  label: string;
-  value: string;
+interface Percentage {
+  pct: number;
+  color?: string;
+}
+interface Bytes {
+  bytes: number;
+  color?: string;
+}
+interface Numeral {
+  value: number;
   color?: string;
 }
 
@@ -25,9 +32,47 @@ interface Series {
 interface FetchDataResponse {
   title: string;
   appLink: string;
-  stats: Stat[];
   series: Series[];
 }
+
+interface LogsFetchDataResponse extends FetchDataResponse {
+  stats: Record<string, Numeral>;
+}
+
+interface MetricsFetchDataResponse extends FetchDataResponse {
+  stats: {
+    hots: Numeral;
+    cpu: Percentage;
+    memory: Percentage;
+    disk: Percentage;
+    inboundTraffic: Bytes;
+    outboundTraffic: Bytes;
+  };
+}
+
+interface UptimeFetchDataResponse extends FetchDataResponse {
+  stats: {
+    monitors: Numeral;
+    up: Numeral;
+    down: Numeral;
+  };
+}
+
+interface ApmFetchDataResponse extends FetchDataResponse {
+  stats: {
+    services: Numeral;
+    transactions: Numeral;
+    errorRate?: Percentage;
+  };
+}
+
+export interface ObservabilityFetchDataResponse {
+  apm: ApmFetchDataResponse;
+  infra_metrics: MetricsFetchDataResponse;
+  infra_logs: LogsFetchDataResponse;
+  uptime: UptimeFetchDataResponse;
+}
+
 interface FetchDataParams {
   // The start timestamp in milliseconds of the queried time interval
   startTime: string;
@@ -37,6 +82,7 @@ interface FetchDataParams {
   bucketSize: string;
 }
 
-export type FetchData = (fetchDataParams: FetchDataParams) => Promise<FetchDataResponse>;
-
-export type HasData = () => Promise<boolean>;
+export type FetchData<T extends FetchDataResponse = FetchDataResponse> = (
+  fetchDataParams: FetchDataParams
+) => Promise<T>;
+type HasData = () => Promise<boolean>;