@platformatic/runtime 2.5.3 → 2.5.5-alpha.1

package/config.d.ts

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

package/lib/config.js

@@ -140,9 +140,14 @@ async function _transformConfig (configManager, args) {
   }
 
   if (!hasValidEntrypoint) {
-    throw typeof config.entrypoint !== 'undefined'
-      ? new errors.InvalidEntrypointError(config.entrypoint)
-      : new errors.MissingEntrypointError()
+    if (config.entrypoint) {
+      throw new errors.InvalidEntrypointError(config.entrypoint)
+    } else if (services.length >= 1) {
+      throw new errors.MissingEntrypointError()
+    }
+    // If there are no services, and no entrypoint it's an empty app.
+    // It won't start, but we should be able to parse and operate on it,
+    // like adding other services.
   }
 
   configManager.current.services = services

package/lib/runtime.js

@@ -127,6 +127,9 @@ class Runtime extends EventEmitter {
   }
 
   async start () {
+    if (typeof this.#configManager.current.entrypoint === 'undefined') {
+      throw new errors.MissingEntrypointError()
+    }
     this.#updateStatus('starting')
 
     // Important: do not use Promise.all here since it won't properly manage dependencies

package/lib/worker/app.js

@@ -10,7 +10,6 @@ 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 {
@@ -19,7 +18,6 @@ class PlatformaticApp extends EventEmitter {
   #listening
   #watch
   #fileWatcher
-  #metricsRegistry
   #debouncedRestart
   #context
 
@@ -32,7 +30,6 @@ class PlatformaticApp extends EventEmitter {
     this.#listening = false
     this.stackable = null
     this.#fileWatcher = null
-    this.#metricsRegistry = null
 
     this.#context = {
       serviceId: this.appConfig.id,
@@ -114,10 +111,9 @@ 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.once('start', () => {
+        this.stackable.collectMetrics()
+      })
 
       this.#updateDispatcher()
     } catch (err) {
@@ -196,9 +192,7 @@ class PlatformaticApp extends EventEmitter {
   }
 
   async getMetrics ({ format }) {
-    if (!this.#metricsRegistry) return null
-
-    return format === 'json' ? this.#metricsRegistry.getMetricsAsJSON() : this.#metricsRegistry.metrics()
+    return this.stackable.getMetrics({ format })
   }
 
   #fetchServiceUrl (key, { parent, context: service }) {

package/lib/worker/default-stackable.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.5.3",
+  "version": "2.5.5-alpha.1",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -34,17 +34,17 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.5.3",
-    "@platformatic/db": "2.5.3",
-    "@platformatic/service": "2.5.3",
-    "@platformatic/sql-graphql": "2.5.3",
-    "@platformatic/sql-mapper": "2.5.3"
+    "@platformatic/composer": "2.5.5-alpha.1",
+    "@platformatic/service": "2.5.5-alpha.1",
+    "@platformatic/sql-graphql": "2.5.5-alpha.1",
+    "@platformatic/db": "2.5.5-alpha.1",
+    "@platformatic/sql-mapper": "2.5.5-alpha.1"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
     "@fastify/websocket": "^11.0.0",
     "@hapi/topo": "^6.0.2",
-    "@platformatic/http-metrics": "^0.2.0",
+    "@platformatic/http-metrics": "^0.2.1",
     "@watchable/unpromise": "^1.0.2",
     "boring-name-generator": "^1.0.3",
     "change-case-all": "^2.1.0",
@@ -69,13 +69,13 @@
     "undici": "^6.9.0",
     "undici-thread-interceptor": "^0.7.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.5.3",
-    "@platformatic/config": "2.5.3",
-    "@platformatic/generators": "2.5.3",
-    "@platformatic/itc": "2.5.3",
-    "@platformatic/telemetry": "2.5.3",
-    "@platformatic/ts-compiler": "2.5.3",
-    "@platformatic/utils": "2.5.3"
+    "@platformatic/basic": "2.5.5-alpha.1",
+    "@platformatic/generators": "2.5.5-alpha.1",
+    "@platformatic/itc": "2.5.5-alpha.1",
+    "@platformatic/telemetry": "2.5.5-alpha.1",
+    "@platformatic/utils": "2.5.5-alpha.1",
+    "@platformatic/ts-compiler": "2.5.5-alpha.1",
+    "@platformatic/config": "2.5.5-alpha.1"
   },
   "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.5.3.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.5.5-alpha.1.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {

package/lib/worker/metrics.js

@@ -1,176 +0,0 @@
-'use strict'
-
-const os = require('node:os')
-const { eventLoopUtilization } = require('node:perf_hooks').performance
-const { Registry, Gauge, Counter, collectDefaultMetrics } = require('prom-client')
-const collectHttpMetrics = require('@platformatic/http-metrics')
-
-async function collectMetrics (stackable, serviceId, opts = {}) {
-  const registry = new Registry()
-
-  const httpRequestCallbacks = []
-  const httpResponseCallbacks = []
-
-  const metricsConfig = await stackable.collectMetrics({
-    registry,
-    startHttpTimer: options => httpRequestCallbacks.forEach(cb => cb(options)),
-    endHttpTimer: options => httpResponseCallbacks.forEach(cb => cb(options))
-  })
-
-  const labels = opts.labels ?? {}
-  registry.setDefaultLabels({ ...labels, serviceId })
-
-  if (metricsConfig.defaultMetrics) {
-    collectDefaultMetrics({ register: registry })
-    collectEluMetric(registry)
-    await collectThreadCpuMetrics(registry)
-  }
-
-  if (metricsConfig.httpMetrics) {
-    {
-      const { startTimer, endTimer } = collectHttpMetrics(registry, {
-        customLabels: ['telemetry_id'],
-        getCustomLabels: req => {
-          const telemetryId = req.headers?.['x-plt-telemetry-id'] ?? 'unknown'
-          return { telemetry_id: telemetryId }
-        }
-      })
-      httpRequestCallbacks.push(startTimer)
-      httpResponseCallbacks.push(endTimer)
-    }
-
-    {
-      // TODO: check if it's a nodejs environment
-      // Needed for the Meraki metrics
-      const { startTimer, endTimer } = 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())
-          }
-        }
-      })
-      httpRequestCallbacks.push(startTimer)
-      httpResponseCallbacks.push(endTimer)
-    }
-  }
-
-  return registry
-}
-
-async function collectThreadCpuMetrics (registry) {
-  // We need until we switch to 22 as thread-cpu-usage is ESM
-  const { threadCpuUsage } = await import('thread-cpu-usage')
-
-  let lastSample = process.hrtime.bigint()
-  let lastUsage = threadCpuUsage()
-
-  const threadCpuUserUsageCounterMetric = new Counter({
-    name: 'thread_cpu_user_system_seconds_total',
-    help: 'Total user CPU time spent in seconds for the current thread.',
-    registers: [registry]
-  })
-
-  const threadCpuSystemUsageCounterMetric = new Counter({
-    name: 'thread_cpu_system_seconds_total',
-    help: 'Total system CPU time spent in seconds for the current thread.',
-    registers: [registry]
-  })
-
-  const threadCpuPercentUsageGaugeMetric = new Gauge({
-    name: 'thread_cpu_percent_usage',
-    help: 'The thread CPU percent usage.',
-    registers: [registry]
-  })
-
-  const threadCpuUsageCounterMetric = new Counter({
-    name: 'thread_cpu_seconds_total',
-    help: 'Total user and system CPU time spent in seconds for the current threads.',
-    // Use this one metric's `collect` to set all metrics' values.
-    collect () {
-      const newSample = process.hrtime.bigint()
-      const newUsage = threadCpuUsage()
-      const user = newUsage.user - lastUsage.user
-      const system = newUsage.system - lastUsage.system
-      const elapsed = Number(newSample - lastSample)
-
-      lastUsage = newUsage
-      lastSample = newSample
-
-      threadCpuSystemUsageCounterMetric.inc(system / 1e6)
-      threadCpuUserUsageCounterMetric.inc(user / 1e6)
-      threadCpuUsageCounterMetric.inc((user + system) / 1e6)
-      threadCpuPercentUsageGaugeMetric.set((100 * ((user + system) * 1000)) / elapsed)
-    },
-    registers: [registry]
-  })
-
-  registry.registerMetric(threadCpuUserUsageCounterMetric)
-  registry.registerMetric(threadCpuSystemUsageCounterMetric)
-  registry.registerMetric(threadCpuUsageCounterMetric)
-  registry.registerMetric(threadCpuPercentUsageGaugeMetric)
-}
-
-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 }