feat: add metrics endpoint (#409)

* feat: add metrics endpoint

* feat: add metrics endpoint

* feat: add metrics endpoint

* feat: add metrics endpoint and use it for license limits

* feat: add metrics endpoint and use it for license limits

Author: jeho

src/api/license.ts

@@ -2,7 +2,7 @@ import Debug from 'debug'
 import { Operation, OperationHandlerArray } from 'express-openapi'
 import { OpenApiRequestExt } from 'src/otomi-models'
 
-const debug = Debug('otomi:api:delete')
+const debug = Debug('otomi:api:license')
 
 export default function (): OperationHandlerArray {
   const del: Operation = [

src/api/metrics.ts

@@ -0,0 +1,19 @@
+import Debug from 'debug'
+import { Operation, OperationHandlerArray } from 'express-openapi'
+import { OpenApiRequestExt } from 'src/otomi-models'
+
+const debug = Debug('otomi:api:metrics')
+
+export default function (): OperationHandlerArray {
+  const get: Operation = [
+    ({ otomi }: OpenApiRequestExt, res) => {
+      debug('get')
+      const data = otomi.getMetrics()
+      res.json(data)
+    },
+  ]
+  const api = {
+    get,
+  }
+  return api
+}

src/openapi/api.yaml

@@ -74,6 +74,18 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/License'
+  /metrics:
+    get:
+      operationId: getMetrics
+      description: Get otomi metrics
+      x-aclSchema: Metrics
+      responses:
+        '200':
+          description: Successfully obtained otomi metrics
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Metrics'
   /secrets:
     get:
       operationId: getAllSecrets
@@ -1092,6 +1104,8 @@ components:
       $ref: license.yaml#/LicenseJwt
     License:
       $ref: license.yaml#/License
+    Metrics:
+      $ref: metrics.yaml#/Metrics
     DockerConfig:
       $ref: dockerconfig.yaml#/DockerConfig
     OpenApiValidationError:

src/openapi/metrics.yaml

@@ -0,0 +1,37 @@
+Metrics:
+  x-acl:
+    admin: [read-any]
+    team: [read-any]
+  type: object
+  properties:
+    otomi_backups:
+      type: integer
+      minimum: 0
+      default: 0
+    otomi_builds:
+      type: integer
+      minimum: 0
+      default: 0
+    otomi_secrets:
+      type: integer
+      minimum: 0
+      default: 0q
+    otomi_services:
+      type: integer
+      minimum: 0
+      default: 0
+    otomi_teams:
+      type: integer
+      minimum: 0
+      default: 0
+    otomi_workloads:
+      type: integer
+      minimum: 0
+      default: 0
+  required:
+    - otomi_backups
+    - otomi_builds
+    - otomi_secrets
+    - otomi_services
+    - otomi_teams
+    - otomi_workloads

src/otomi-models.ts

@@ -21,7 +21,7 @@ export type Workload = components['schemas']['Workload']
 export type WorkloadValues = components['schemas']['WorkloadValues']
 export type Build = components['schemas']['Build']
 export type TeamAuthz = components['schemas']['TeamAuthz']
-
+export type Metrics = components['schemas']['Metrics']
 // Derived setting models
 export type Alerts = Settings['alerts']
 export type Cluster = Settings['cluster']

src/otomi-stack.ts

@@ -12,14 +12,15 @@ import * as osPath from 'path'
 import { getAppList, getAppSchema, getSpec } from 'src/app'
 import Db from 'src/db'
 import { DeployLockError, PublicUrlExists, ValidationError } from 'src/error'
-import { cleanAllSessions, cleanSession, DbMessage, getIo, getSessionStack } from 'src/middleware'
+import { DbMessage, cleanAllSessions, cleanSession, getIo, getSessionStack } from 'src/middleware'
 import {
   App,
   Backup,
   Build,
   Core,
   K8sService,
   License,
+  Metrics,
   Policies,
   Secret,
   Service,
@@ -34,7 +35,6 @@ import {
 import getRepo, { Repo } from 'src/repo'
 import { arrayToObject, getServiceUrl, objectToArray, removeBlankAttributes } from 'src/utils'
 import {
-  cleanEnv,
   CUSTOM_ROOT_CA,
   EDITOR_INACTIVITY_TIMEOUT,
   GIT_BRANCH,
@@ -45,6 +45,7 @@ import {
   GIT_USER,
   TOOLS_HOST,
   VERSIONS,
+  cleanEnv,
 } from 'src/validators'
 import { parse as parseYaml, stringify as stringifyYaml } from 'yaml'
 import connect from './otomiCloud/connect'
@@ -133,6 +134,18 @@ export default class OtomiStack {
     return apps.concat(ingressApps)
   }
 
+  getMetrics(): Metrics {
+    const metrics: Metrics = {
+      otomi_backups: this.getAllBackups().length,
+      otomi_builds: this.getAllBuilds().length,
+      otomi_secrets: this.getAllSecrets().length,
+      otomi_services: this.getAllServices().length,
+      // We do not count team_admin as a regular team
+      otomi_teams: this.getTeams().length - 1,
+      otomi_workloads: this.getAllWorkloads().length,
+    }
+    return metrics
+  }
   getRepoPath() {
     if (env.isTest || this.editor === undefined) return env.GIT_LOCAL_PATH
     const folder = `${rootPath}/${this.editor}`