allUsers function & more metrics

packages/backend-core/src/users.ts

@@ -5,6 +5,8 @@ import {
   generateAppUserID,
   queryGlobalView,
   UNICODE_MAX,
+  DocumentType,
+  SEPARATOR,
 } from "./db"
 import { BulkDocsResponse, User } from "@budibase/types"
 import { getGlobalDB } from "./context"
@@ -19,6 +21,16 @@ export const bulkGetGlobalUsersById = async (userIds: string[]) => {
   ).rows.map(row => row.doc) as User[]
 }
 
+export const getAllUserIds = async () => {
+  const db = getGlobalDB()
+  const startKey = `${DocumentType.USER}${SEPARATOR}`
+  const response = await db.allDocs({
+    startkey: startKey,
+    endkey: `${startKey}${UNICODE_MAX}`,
+  })
+  return response.rows.map(row => row.id)
+}
+
 export const bulkUpdateGlobalUsers = async (users: User[]) => {
   const db = getGlobalDB()
   return (await db.bulkDocs(users)) as BulkDocsResponse

packages/server/src/api/controllers/public/metrics.ts

@@ -1,19 +1,43 @@
 import { App, BBContext } from "@budibase/types"
-import { db as dbCore, context } from "@budibase/backend-core"
+import { users as userCore, db as dbCore } from "@budibase/backend-core"
+import { quotas, licensing } from "@budibase/pro"
+
 import os from "os"
 
 export async function fetch(ctx: BBContext) {
+  // *** OPERATING SYSTEM ***
+  const freeMem = os.freemem()
+  const totalMem = os.totalmem()
+  const usedMem = totalMem - freeMem
+  const uptime = os.uptime()
+
+  // *** APPS ***
   const allDatabases = await dbCore.getAllDbs()
   const devAppIDs = await dbCore.getDevAppIDs({ idsOnly: true })
   const prodAppIDs = await dbCore.getProdAppIDs({ idsOnly: true })
   const allAppIds = await dbCore.getAllApps({ idsOnly: true })
 
-  var outputString = ""
+  // *** USERS ***
+  const usersObject = await userCore.getAllUserIds()
 
-  const freeMem = os.freemem()
-  const totalMem = os.totalmem()
-  const usedMem = totalMem - freeMem
-  const uptime = os.uptime()
+  // *** QUOTAS ***
+  const usage = await quotas.getQuotaUsage()
+  const license = await licensing.cache.getCachedLicense()
+  const appsQuotaUsage = usage.usageQuota.apps
+  const rowsQuotaUsage = usage.usageQuota.rows
+  const pluginsQuotaUsage = usage.usageQuota.plugins
+  const userGroupsQuotaUsage = usage.usageQuota.userGroups
+  const queryQuotaUsage = usage.monthly.current.queries
+  const automationsQuotaUsage = usage.monthly.current.automations
+  const appsQuotaLimit = license.quotas.usage.static.apps.value
+  const rowsQuotaLimit = license.quotas.usage.static.rows.value
+  const userGroupsQuotaLimit = license.quotas.usage.static.userGroups.value
+  const pluginsQuotaLimit = license.quotas.usage.static.plugins.value
+  const queryQuotaLimit = license.quotas.usage.monthly.queries.value
+  const automationsQuotaLimit = license.quotas.usage.monthly.automations.value
+
+  // *** BUILD THE OUTPUT STRING ***
+  var outputString = ""
 
   // **** budibase_os_uptime ****
   outputString += convertToOpenMetrics(
@@ -70,6 +94,14 @@ export async function fetch(ctx: BBContext) {
     os.loadavg()[2]
   )
 
+  // **** budibase_tenant_user_count ****
+  outputString += convertToOpenMetrics(
+    "budibase_tenant_user_count",
+    "The number of users created",
+    "gauge",
+    usersObject.length
+  )
+
   // **** budibase_tenant_app_count ****
   outputString += convertToOpenMetrics(
     "budibase_tenant_app_count",
@@ -102,6 +134,102 @@ export async function fetch(ctx: BBContext) {
     allDatabases.length
   )
 
+  // **** budibase_quota_usage_apps ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_usage_apps",
+    "The number of apps created",
+    "gauge",
+    appsQuotaUsage
+  )
+
+  // **** budibase_quota_limit_apps ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_limit_apps",
+    "The limit on the number of apps that can be created",
+    "gauge",
+    appsQuotaLimit == -1 ? 3000000 : appsQuotaLimit
+  )
+
+  // **** budibase_quota_usage_rows ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_usage_rows",
+    "The number of database rows used from the quota",
+    "gauge",
+    rowsQuotaUsage
+  )
+
+  // **** budibase_quota_limit_rows ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_limit_rows",
+    "The limit on the number of rows that can be created",
+    "gauge",
+    rowsQuotaLimit == -1 ? 3000000 : rowsQuotaLimit
+  )
+
+  // **** budibase_quota_usage_plugins ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_usage_plugins",
+    "The number of plugins in use",
+    "gauge",
+    pluginsQuotaUsage
+  )
+
+  // **** budibase_quota_limit_plugins ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_limit_plugins",
+    "The limit on the number of plugins that can be created",
+    "gauge",
+    pluginsQuotaLimit == -1 ? 3000000 : pluginsQuotaLimit
+  )
+
+  // **** budibase_quota_usage_user_groups ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_usage_user_groups",
+    "The number of user groups created",
+    "gauge",
+    userGroupsQuotaUsage
+  )
+
+  // **** budibase_quota_limit_user_groups ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_limit_user_groups",
+    "The limit on the number of user groups that can be created",
+    "gauge",
+    userGroupsQuotaLimit == -1 ? 3000000 : userGroupsQuotaLimit
+  )
+
+  // **** budibase_quota_usage_queries ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_usage_queries",
+    "The number of queries used in the current month",
+    "gauge",
+    queryQuotaUsage
+  )
+
+  // **** budibase_quota_limit_queries ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_limit_queries",
+    "The limit on the number of queries for the current month",
+    "gauge",
+    queryQuotaLimit == -1 ? 3000000 : queryQuotaLimit
+  )
+
+  // **** budibase_quota_usage_automations ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_usage_automations",
+    "The number of automations used in the current month",
+    "gauge",
+    automationsQuotaUsage
+  )
+
+  // **** budibase_quota_limit_automations ****
+  outputString += convertToOpenMetrics(
+    "budibase_quota_limit_automations",
+    "The limit on the number of automations that can be created",
+    "gauge",
+    automationsQuotaLimit == -1 ? 3000000 : automationsQuotaLimit
+  )
+
   ctx.body = outputString
 }
 
@@ -111,10 +239,9 @@ export function convertToOpenMetrics(
   metricType: string,
   metricValue: number
 ) {
-  return `
-    # HELP ${metricName} ${metricHelp}.
-    # TYPE ${metricName} ${metricType}
-    ${metricName} ${metricValue}`
+  return `# HELP ${metricName} ${metricHelp}.
+# TYPE ${metricName} ${metricType}
+${metricName} ${metricValue}\n`
 }
 
 export default {

packages/server/src/api/routes/public/metrics.ts

@@ -9,7 +9,7 @@ const read = []
  *   get:
  *     operationId: getById
  *     summary: Retrieve Budibase tenant metrics
- *     description: Output metrics in openMetrics format compatible with Prometheus
+ *     description: Output metrics in OpenMetrics format compatible with Prometheus
  *     tags:
  *       - metrics
  *     responses:
@@ -17,11 +17,6 @@ const read = []
  *         description: Returns tenant metrics.
  *         content:
  *           text/plain:
- *             schema:
- *               $ref: '#/components/schemas/tableOutput'
- *             examples:
- *               table:
- *                 $ref: '#/components/examples/table'
  */
 read.push(new Endpoint("get", "/metrics", controller.fetch))