@platformatic/runtime 2.0.0-alpha.6 → 2.0.0-alpha.7

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha6Json = {
+export type HttpsSchemasPlatformaticDevPlatformaticRuntime200Alpha7Json = {
   [k: string]: unknown;
 } & {
   $schema?: string;

package/fixtures/management-api/platformatic.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/1.52.0.json",
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/2.0.0-alpha.5.json",
   "entrypoint": "service-1",
   "watch": false,
   "autoload": {
@@ -13,5 +13,10 @@
     "logs": {
       "maxSize": 6
     }
+  },
+  "metrics": {
+    "labels": {
+      "custom_label": "custom-value"
+    }
   }
 }

package/index.js

@@ -6,11 +6,12 @@ const errors = require('./lib/errors')
 const { platformaticRuntime, wrapConfigInRuntimeConfig } = require('./lib/config')
 const RuntimeGenerator = require('./lib/generator/runtime-generator')
 const { Runtime } = require('./lib/runtime')
-const { start, startCommand } = require('./lib/start')
+const { buildRuntime, start, startCommand } = require('./lib/start')
 const symbols = require('./lib/worker/symbols')
 const { loadConfig, getRuntimeLogsDir } = require('./lib/utils')
 
 module.exports.buildServer = buildServer
+module.exports.buildRuntime = buildRuntime
 module.exports.compile = compile
 module.exports.errors = errors
 module.exports.Generator = RuntimeGenerator

package/lib/errors.js

@@ -14,6 +14,7 @@ module.exports = {
   FailedToRetrieveOpenAPISchemaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_OPENAPI_SCHEMA`, 'Failed to retrieve OpenAPI schema for service with id "%s": %s'),
   FailedToRetrieveGraphQLSchemaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_GRAPHQL_SCHEMA`, 'Failed to retrieve GraphQL schema for service with id "%s": %s'),
   FailedToRetrieveMetaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_META`, 'Failed to retrieve metadata for service with id "%s": %s'),
+  FailedToRetrieveMetricsError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_METRICS`, 'Failed to retrieve metrics for service with id "%s": %s'),
   ApplicationAlreadyStartedError: createError(`${ERROR_PREFIX}_APPLICATION_ALREADY_STARTED`, 'Application is already started'),
   ApplicationNotStartedError: createError(`${ERROR_PREFIX}_APPLICATION_NOT_STARTED`, 'Application has not been started'),
   ConfigPathMustBeStringError: createError(`${ERROR_PREFIX}_CONFIG_PATH_MUST_BE_STRING`, 'Config path must be a string'),

package/lib/runtime.js

@@ -151,7 +151,7 @@ class Runtime extends EventEmitter {
     return this.#url
   }
 
-  async stop () {
+  async stop (silent = false) {
     if (this.#status === 'starting') {
       await once(this, 'started')
     }
@@ -159,7 +159,7 @@ class Runtime extends EventEmitter {
     this.#updateStatus('stopping')
     this.#startedServices.clear()
 
-    await Promise.all(this.#servicesIds.map(service => this._stopService(service)))
+    await Promise.all(this.#servicesIds.map(service => this._stopService(service, silent)))
 
     this.#updateStatus('stopped')
   }
@@ -175,12 +175,12 @@ class Runtime extends EventEmitter {
     return this.#url
   }
 
-  async close (fromManagementApi) {
+  async close (fromManagementApi = false, silent = false) {
     this.#updateStatus('closing')
 
     clearInterval(this.#metricsTimeout)
 
-    await this.stop()
+    await this.stop(silent)
 
     if (this.#managementApi) {
       if (fromManagementApi) {
@@ -263,7 +263,7 @@ class Runtime extends EventEmitter {
   }
 
   // Do not rename to #stopService as this is used in tests
-  async _stopService (id) {
+  async _stopService (id, silent) {
     const service = await this.#getServiceById(id, false, false)
 
     if (!service) {
@@ -272,7 +272,9 @@ class Runtime extends EventEmitter {
 
     this.#startedServices.set(id, false)
 
-    this.logger?.info(`Stopping service "${id}"...`)
+    if (!silent) {
+      this.logger?.info(`Stopping service "${id}"...`)
+    }
 
     // Always send the stop message, it will shut down workers that only had ITC and interceptors setup
     try {
@@ -524,7 +526,6 @@ class Runtime extends EventEmitter {
         }
 
         const serviceMetrics = await sendViaITC(service, 'getMetrics', format)
-
         if (serviceMetrics) {
           if (metrics === null) {
             metrics = format === 'json' ? [] : ''
@@ -576,17 +577,26 @@ class Runtime extends EventEmitter {
       let p99Value = 0
 
       const metricName = 'http_request_all_summary_seconds'
-      const httpLatencyMetrics = metrics.find(metric => metric.name === metricName)
-
-      p50Value = httpLatencyMetrics.values.find(value => value.labels.quantile === 0.5).value || 0
-      p90Value = httpLatencyMetrics.values.find(value => value.labels.quantile === 0.9).value || 0
-      p95Value = httpLatencyMetrics.values.find(value => value.labels.quantile === 0.95).value || 0
-      p99Value = httpLatencyMetrics.values.find(value => value.labels.quantile === 0.99).value || 0
+      const httpLatencyMetrics = metrics.filter(
+        metric => metric.name === metricName
+      )
 
-      p50Value = Math.round(p50Value * 1000)
-      p90Value = Math.round(p90Value * 1000)
-      p95Value = Math.round(p95Value * 1000)
-      p99Value = Math.round(p99Value * 1000)
+      if (httpLatencyMetrics) {
+        const entrypointMetrics = httpLatencyMetrics.find(
+          metric => metric.values?.[0]?.labels?.serviceId === this.#entrypointId
+        )
+        if (entrypointMetrics) {
+          p50Value = entrypointMetrics.values.find(value => value.labels.quantile === 0.5)?.value || 0
+          p90Value = entrypointMetrics.values.find(value => value.labels.quantile === 0.9)?.value || 0
+          p95Value = entrypointMetrics.values.find(value => value.labels.quantile === 0.95)?.value || 0
+          p99Value = entrypointMetrics.values.find(value => value.labels.quantile === 0.99)?.value || 0
+
+          p50Value = Math.round(p50Value * 1000)
+          p90Value = Math.round(p90Value * 1000)
+          p95Value = Math.round(p95Value * 1000)
+          p99Value = Math.round(p99Value * 1000)
+        }
+      }
 
       const cpu = cpuMetric.values[0].value
       const rss = rssMetric.values[0].value

package/lib/worker/app.js

@@ -7,6 +7,7 @@ const debounce = require('debounce')
 
 const errors = require('../errors')
 const defaultStackable = require('./default-stackable')
+const { collectMetrics } = require('./metrics')
 const { getServiceUrl, loadConfig, loadEmptyConfig } = require('../utils')
 
 class PlatformaticApp extends EventEmitter {
@@ -15,6 +16,7 @@ class PlatformaticApp extends EventEmitter {
   #listening
   #watch
   #fileWatcher
+  #metricsRegistry
   #debouncedRestart
   #context
 
@@ -27,6 +29,7 @@ class PlatformaticApp extends EventEmitter {
     this.#listening = false
     this.stackable = null
     this.#fileWatcher = null
+    this.#metricsRegistry = null
 
     this.#context = {
       serviceId: this.appConfig.id,
@@ -93,6 +96,15 @@ class PlatformaticApp extends EventEmitter {
       })
       this.stackable = this.#wrapStackable(stackable)
 
+      const metricsConfig = this.#context.metricsConfig
+      if (metricsConfig !== false) {
+        this.#metricsRegistry = await collectMetrics(
+          this.stackable,
+          this.appConfig.id,
+          metricsConfig
+        )
+      }
+
       this.#updateDispatcher()
     } catch (err) {
       this.#logAndExit(err)
@@ -164,6 +176,14 @@ class PlatformaticApp extends EventEmitter {
     await this.stackable.start({ listen: true })
   }
 
+  async getMetrics ({ format }) {
+    if (!this.#metricsRegistry) return null
+
+    return format === 'json'
+      ? this.#metricsRegistry.getMetricsAsJSON()
+      : this.#metricsRegistry.metrics()
+  }
+
   #fetchServiceUrl (key, { parent, context: service }) {
     if (service.localServiceEnvVars.has(key)) {
       return service.localServiceEnvVars.get(key)

package/lib/worker/default-stackable.js

@@ -14,7 +14,10 @@ const defaultStackable = {
   getOpenapiSchema: () => null,
   getGraphqlSchema: () => null,
   getMeta: () => ({}),
-  getMetrics: () => null,
+  collectMetrics: () => ({
+    defaultMetrics: true,
+    httpMetrics: true,
+  }),
   inject: () => {
     throw new Error('Stackable inject not implemented')
   },

package/lib/worker/itc.js

@@ -120,8 +120,12 @@ function setupITC (app, service, dispatcher) {
         }
       },
 
-      getMetrics (format) {
-        return app.stackable.getMetrics({ format })
+      async getMetrics (format) {
+        try {
+          return await app.getMetrics({ format })
+        } catch (err) {
+          throw new errors.FailedToRetrieveMetricsError(service.id, err.message)
+        }
       },
 
       inject (injectParams) {

package/lib/worker/metrics.js

@@ -0,0 +1,106 @@
+'use strict'
+
+const os = require('node:os')
+const { eventLoopUtilization } = require('node:perf_hooks').performance
+const { Registry, Gauge, collectDefaultMetrics } = require('prom-client')
+const collectHttpMetrics = require('@platformatic/http-metrics')
+
+async function collectMetrics (stackable, serviceId, opts = {}) {
+  const registry = new Registry()
+  const metricsConfig = await stackable.collectMetrics({ registry })
+
+  const labels = opts.labels ?? {}
+  registry.setDefaultLabels({ ...labels, serviceId })
+
+  if (metricsConfig.defaultMetrics) {
+    collectDefaultMetrics({ register: registry })
+    collectEluMetric(registry)
+  }
+
+  if (metricsConfig.httpMetrics) {
+    collectHttpMetrics(registry, {
+      customLabels: ['telemetry_id'],
+      getCustomLabels: (req) => {
+        const telemetryId = req.headers['x-plt-telemetry-id'] ?? 'unknown'
+        return { telemetry_id: telemetryId }
+      }
+    })
+
+    // TODO: check if it's a nodejs environment
+    // Needed for the Meraki metrics
+    collectHttpMetrics(registry, {
+      customLabels: ['telemetry_id'],
+      getCustomLabels: (req) => {
+        const telemetryId = req.headers['x-plt-telemetry-id'] ?? 'unknown'
+        return { telemetry_id: telemetryId }
+      },
+      histogram: {
+        name: 'http_request_all_duration_seconds',
+        help: 'request duration in seconds summary for all requests',
+        collect: function () {
+          process.nextTick(() => this.reset())
+        },
+      },
+      summary: {
+        name: 'http_request_all_summary_seconds',
+        help: 'request duration in seconds histogram for all requests',
+        collect: function () {
+          process.nextTick(() => this.reset())
+        },
+      },
+    })
+  }
+
+  return registry
+}
+
+function collectEluMetric (register) {
+  let startELU = eventLoopUtilization()
+  const eluMetric = new Gauge({
+    name: 'nodejs_eventloop_utilization',
+    help: 'The event loop utilization as a fraction of the loop time. 1 is fully utilized, 0 is fully idle.',
+    collect: () => {
+      const endELU = eventLoopUtilization()
+      const result = eventLoopUtilization(endELU, startELU).utilization
+      eluMetric.set(result)
+      startELU = endELU
+    },
+    registers: [register],
+  })
+  register.registerMetric(eluMetric)
+
+  let previousIdleTime = 0
+  let previousTotalTime = 0
+  const cpuMetric = new Gauge({
+    name: 'process_cpu_percent_usage',
+    help: 'The process CPU percent usage.',
+    collect: () => {
+      const cpus = os.cpus()
+      let idleTime = 0
+      let totalTime = 0
+
+      cpus.forEach(cpu => {
+        for (const type in cpu.times) {
+          totalTime += cpu.times[type]
+          if (type === 'idle') {
+            idleTime += cpu.times[type]
+          }
+        }
+      })
+
+      const idleDiff = idleTime - previousIdleTime
+      const totalDiff = totalTime - previousTotalTime
+
+      const usagePercent = 100 - ((100 * idleDiff) / totalDiff)
+      const roundedUsage = Math.round(usagePercent * 100) / 100
+      cpuMetric.set(roundedUsage)
+
+      previousIdleTime = idleTime
+      previousTotalTime = totalTime
+    },
+    registers: [register],
+  })
+  register.registerMetric(cpuMetric)
+}
+
+module.exports = { collectMetrics }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.0.0-alpha.6",
+  "version": "2.0.0-alpha.7",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -34,16 +34,17 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.0.0-alpha.6",
-    "@platformatic/service": "2.0.0-alpha.6",
-    "@platformatic/sql-graphql": "2.0.0-alpha.6",
-    "@platformatic/sql-mapper": "2.0.0-alpha.6",
-    "@platformatic/db": "2.0.0-alpha.6"
+    "@platformatic/composer": "2.0.0-alpha.7",
+    "@platformatic/db": "2.0.0-alpha.7",
+    "@platformatic/service": "2.0.0-alpha.7",
+    "@platformatic/sql-graphql": "2.0.0-alpha.7",
+    "@platformatic/sql-mapper": "2.0.0-alpha.7"
   },
   "dependencies": {
     "@fastify/error": "^3.4.1",
     "@fastify/websocket": "^10.0.0",
     "@hapi/topo": "^6.0.2",
+    "@platformatic/http-metrics": "^0.1.0",
     "@watchable/unpromise": "^1.0.2",
     "boring-name-generator": "^1.0.3",
     "change-case-all": "^2.1.0",
@@ -62,18 +63,19 @@
     "pino": "^8.19.0",
     "pino-pretty": "^11.0.0",
     "pino-roll": "^1.0.0",
+    "prom-client": "^15.1.2",
     "semgrator": "^0.3.0",
     "tail-file-stream": "^0.2.0",
     "undici": "^6.9.0",
     "undici-thread-interceptor": "^0.5.1",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.0.0-alpha.6",
-    "@platformatic/generators": "2.0.0-alpha.6",
-    "@platformatic/config": "2.0.0-alpha.6",
-    "@platformatic/utils": "2.0.0-alpha.6",
-    "@platformatic/itc": "2.0.0-alpha.6",
-    "@platformatic/ts-compiler": "2.0.0-alpha.6",
-    "@platformatic/telemetry": "2.0.0-alpha.6"
+    "@platformatic/basic": "2.0.0-alpha.7",
+    "@platformatic/config": "2.0.0-alpha.7",
+    "@platformatic/generators": "2.0.0-alpha.7",
+    "@platformatic/itc": "2.0.0-alpha.7",
+    "@platformatic/telemetry": "2.0.0-alpha.7",
+    "@platformatic/ts-compiler": "2.0.0-alpha.7",
+    "@platformatic/utils": "2.0.0-alpha.7"
   },
   "scripts": {
     "test": "npm run lint && borp --concurrency=1 --timeout=180000 && tsd",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.0.0-alpha.6.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.0.0-alpha.7.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {