Fr 163 perf monitor core device health in device inventory view resou…

…rce usage (#432)

* create new subscription to get device load from currently only mockup of perfMon server

* add new subscription to get load of multiple devices at once

* handle null or empty values for model and version

* shorten null value handler

* implement connection to the perf monitoring service

.env.example

@@ -13,6 +13,7 @@ TOPOLOGY_ENABLED=true
 # either define all of them or do not define them at all
 TOPOLOGY_DISCOVERY_API_URL=http://10.19.0.5:8080/api/topology/data
 TOPOLOGY_DISCOVERY_GRAPHQL_API_URL=http://localhost:5000/api/graphql
+PERFORMANCE_MONITORING_GRAPHQL_API_URL=http://localhost:8082/api/graphql
 
 KAFKA_BROKER="10.19.0.25:9094"
 KAFKA_TOPIC=frinx

codegen-perf-monitoring.yml

@@ -0,0 +1,15 @@
+schema:
+  - 'http://localhost:8082'
+documents:
+  - './src/external-api/performance-monitoring-graphql.ts'
+generates:
+  src/__generated__/perf-monitoring.graphql.ts:
+    plugins:
+      - 'typescript'
+      - 'typescript-operations'
+    config:
+      enumsAsTypes: true
+      avoidOptionals:
+        field: true
+        object: false
+        inputValue: false

package.json

@@ -22,7 +22,9 @@
     "test:generate": "cross-env NODE_ENV=testing ts-node --transpile-only -r dotenv/config src/schema/index.ts",
     "jest": "cross-env NODE_ENV=testing jest --verbose",
     "test": "run-s test:generate jest",
-    "codegen": "graphql-codegen --config codegen-topology-discovery.yml"
+    "codegen": "run-s codegen:discovery codegen:monitoring",
+    "codegen:discovery": "graphql-codegen --config codegen-topology-discovery.yml",
+    "codegen:monitoring": "graphql-codegen --config codegen-perf-monitoring.yml"
   },
   "devDependencies": {
     "@frinx/eslint-config-typescript-base": "15.0.0-build.1",

src/config.ts

@@ -33,6 +33,7 @@ type TopologyConfigEnabled = {
   topologyEnabled: true;
   topologyDiscoveryURL: string;
   topologyDiscoveryGraphqlURL: string;
+  performanceMonitoringGraphqlURL: string;
 };
 
 type TopologyConfigDisabled = {
@@ -46,22 +47,25 @@ function getTopologyConfig(): TopologyConfig {
   const topologyEnabled = stringToBoolean(envString('TOPOLOGY_ENABLED'));
   const topologyDiscoveryURL = optionalEnvString('TOPOLOGY_DISCOVERY_API_URL');
   const topologyDiscoveryGraphqlURL = optionalEnvString('TOPOLOGY_DISCOVERY_GRAPHQL_API_URL');
+  const performanceMonitoringGraphqlURL = optionalEnvString('PERFORMANCE_MONITORING_GRAPHQL_API_URL');
+
   if (!topologyEnabled) {
     return {
       topologyEnabled: false,
     };
   }
 
-  if (!topologyDiscoveryURL || !topologyDiscoveryGraphqlURL) {
+  if (!topologyDiscoveryURL || !topologyDiscoveryGraphqlURL || !performanceMonitoringGraphqlURL) {
     throw new Error(
-      'Not all mandatory topology discovery url (TOPOLOGY_DISCOVERY_API_URL, TOPOLOGY_DISCOVERY_GRAPHQL_API_URL) were found.',
+      'Not all mandatory topology discovery url (TOPOLOGY_DISCOVERY_API_URL, TOPOLOGY_DISCOVERY_GRAPHQL_API_URL, PERFORMANCE_MONITORING_GRAPHQL_API_URL) were found.',
     );
   }
 
   return {
     topologyEnabled: true,
     topologyDiscoveryURL,
     topologyDiscoveryGraphqlURL,
+    performanceMonitoringGraphqlURL,
   };
 }
 

src/context.ts

@@ -7,6 +7,7 @@ import uniconfigAPI, { UniConfigAPI } from './external-api/uniconfig';
 import prismaClient from './prisma-client';
 import config from './config';
 import kafkaProducers, { KafkaService } from './external-api/kafka';
+import getPerformanceMonitoringAPI, { PerformanceMonitoringAPI } from './external-api/performance-monitoring-graphql';
 
 export type Context = {
   kafka: KafkaService | null;
@@ -15,6 +16,7 @@ export type Context = {
   uniconfigAPI: UniConfigAPI;
   topologyDiscoveryAPI: TopologyDiscoveryAPI;
   topologyDiscoveryGraphQLAPI?: TopologyDiscoveryGraphQLAPI;
+  performanceMonitoringAPI: PerformanceMonitoringAPI;
   inventoryKafka: typeof kafkaProducers | null;
 };
 
@@ -44,12 +46,14 @@ export default async function createContext(context: ExpressContextFunctionArgum
     uniconfigAPI,
     topologyDiscoveryAPI,
     topologyDiscoveryGraphQLAPI: getTopologyDiscoveryApi(),
+    performanceMonitoringAPI: getPerformanceMonitoringAPI(),
     ...(config.kafkaEnabled ? { kafka, inventoryKafka: kafkaProducers } : { kafka: null, inventoryKafka: null }),
   };
 }
 
 export function createSubscriptionContext() {
   return {
     prisma: prismaClient,
+    performanceMonitoringAPI: getPerformanceMonitoringAPI(),
   };
 }

src/external-api/performance-monitoring-graphql.ts

@@ -0,0 +1,133 @@
+import { gql, GraphQLClient } from 'graphql-request';
+import config from '../config';
+import {
+  CurrentCpuUsageQuery,
+  CurrentCpuUsageQueryVariables,
+  CurrentCpuUsagesQuery,
+  CurrentCpuUsagesQueryVariables,
+  CurrentMemoryUsageQuery,
+  CurrentMemoryUsageQueryVariables,
+  CurrentMemoryUsagesQuery,
+  CurrentMemoryUsagesQueryVariables,
+} from '../__generated__/perf-monitoring.graphql';
+
+export type DeviceLoadUsage = {
+  cpuUsage: number | null;
+  memoryUsage: number | null;
+};
+
+const DEVICE_MEMORY_USAGES = gql`
+  query CurrentMemoryUsages($names: [String!]!) {
+    currentMemoryUsages(devices: $names) {
+      device
+      usage
+    }
+  }
+`;
+
+const DEVICE_CPU_USAGES = gql`
+  query CurrentCpuUsages($names: [String!]!) {
+    currentCpuUsages(devices: $names) {
+      device
+      usage
+    }
+  }
+`;
+
+const DEVICE_MEMORY_USAGE = gql`
+  query CurrentMemoryUsage($name: String!) {
+    currentMemoryUsage(device: $name) {
+      device
+      usage
+    }
+  }
+`;
+
+const DEVICE_CPU_USAGE = gql`
+  query CurrentCpuUsage($name: String!) {
+    currentCpuUsage(device: $name) {
+      device
+      usage
+    }
+  }
+`;
+
+function getPerformanceMonitoringAPI() {
+  if (config.topologyEnabled === false) {
+    return undefined;
+  }
+
+  const client = new GraphQLClient(config.performanceMonitoringGraphqlURL);
+
+  async function getDeviceCpuUsage(deviceName: string): Promise<CurrentCpuUsageQuery> {
+    const result = await client.request<CurrentCpuUsageQuery, CurrentCpuUsageQueryVariables>(DEVICE_CPU_USAGE, {
+      name: deviceName,
+    });
+
+    return result;
+  }
+
+  async function getDeviceMemoryUsage(deviceName: string): Promise<CurrentMemoryUsageQuery> {
+    const result = await client.request<CurrentMemoryUsageQuery, CurrentMemoryUsageQueryVariables>(
+      DEVICE_MEMORY_USAGE,
+      { name: deviceName },
+    );
+
+    return result;
+  }
+
+  async function getDeviceCpuUsages(deviceNames: string[]): Promise<CurrentCpuUsagesQuery> {
+    const result = await client.request<CurrentCpuUsagesQuery, CurrentCpuUsagesQueryVariables>(DEVICE_CPU_USAGES, {
+      names: deviceNames,
+    });
+
+    return result;
+  }
+
+  async function getDeviceMemoryUsages(deviceNames: string[]): Promise<CurrentMemoryUsagesQuery> {
+    const result = await client.request<CurrentMemoryUsagesQuery, CurrentMemoryUsagesQueryVariables>(
+      DEVICE_MEMORY_USAGES,
+      { names: deviceNames },
+    );
+
+    return result;
+  }
+
+  async function getDeviceLoadUsage(deviceName: string): Promise<DeviceLoadUsage> {
+    const [cpuUsage, memoryUsage] = await Promise.all([
+      getDeviceCpuUsage(deviceName),
+      getDeviceMemoryUsage(deviceName),
+    ]);
+
+    return { cpuUsage: cpuUsage.currentCpuUsage.usage, memoryUsage: memoryUsage.currentMemoryUsage.usage };
+  }
+
+  async function getDeviceLoadUsages(deviceNames: string[]): Promise<(DeviceLoadUsage & { deviceName: string })[]> {
+    const [cpuUsages, memoryUsages] = await Promise.all([
+      getDeviceCpuUsages(deviceNames),
+      getDeviceMemoryUsages(deviceNames),
+    ]);
+
+    const map = new Map<string, DeviceLoadUsage & { deviceName: string }>();
+
+    cpuUsages.currentCpuUsages?.forEach((cpuUsage) => {
+      map.set(cpuUsage.device, { deviceName: cpuUsage.device, cpuUsage: cpuUsage.usage, memoryUsage: null });
+    });
+
+    memoryUsages.currentMemoryUsages?.forEach((memoryUsage) => {
+      const deviceLoadUsage = map.get(memoryUsage.device);
+      if (deviceLoadUsage) {
+        deviceLoadUsage.memoryUsage = memoryUsage.usage;
+      } else {
+        map.set(memoryUsage.device, { deviceName: memoryUsage.device, cpuUsage: null, memoryUsage: memoryUsage.usage });
+      }
+    });
+
+    return Array.from(map.values());
+  }
+
+  return { getDeviceLoadUsage, getDeviceLoadUsages };
+}
+
+export type PerformanceMonitoringAPI = ReturnType<typeof getPerformanceMonitoringAPI>;
+export default getPerformanceMonitoringAPI;