@platformatic/runtime 2.5.1 → 2.5.3

package/config.d.ts

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

package/lib/worker/main.js

@@ -85,7 +85,9 @@ async function main () {
   setGlobalDispatcher(globalDispatcher)
 
   // Setup mesh networker
-  const threadDispatcher = wire({ port: parentPort, useNetwork: service.useHttp, timeout: true })
+  // The timeout is set to 5 minutes to avoid long term memory leaks
+  // TODO: make this configurable
+  const threadDispatcher = wire({ port: parentPort, useNetwork: service.useHttp, timeout: 5 * 60 * 1000 })
 
   // If the service is an entrypoint and runtime server config is defined, use it.
   let serverConfig = null

package/lib/worker/metrics.js

@@ -2,7 +2,7 @@
 
 const os = require('node:os')
 const { eventLoopUtilization } = require('node:perf_hooks').performance
-const { Registry, Gauge, collectDefaultMetrics } = require('prom-client')
+const { Registry, Gauge, Counter, collectDefaultMetrics } = require('prom-client')
 const collectHttpMetrics = require('@platformatic/http-metrics')
 
 async function collectMetrics (stackable, serviceId, opts = {}) {
@@ -23,13 +23,14 @@ async function collectMetrics (stackable, serviceId, opts = {}) {
   if (metricsConfig.defaultMetrics) {
     collectDefaultMetrics({ register: registry })
     collectEluMetric(registry)
+    await collectThreadCpuMetrics(registry)
   }
 
   if (metricsConfig.httpMetrics) {
     {
       const { startTimer, endTimer } = collectHttpMetrics(registry, {
         customLabels: ['telemetry_id'],
-        getCustomLabels: (req) => {
+        getCustomLabels: req => {
           const telemetryId = req.headers?.['x-plt-telemetry-id'] ?? 'unknown'
           return { telemetry_id: telemetryId }
         }
@@ -43,7 +44,7 @@ async function collectMetrics (stackable, serviceId, opts = {}) {
       // Needed for the Meraki metrics
       const { startTimer, endTimer } = collectHttpMetrics(registry, {
         customLabels: ['telemetry_id'],
-        getCustomLabels: (req) => {
+        getCustomLabels: req => {
           const telemetryId = req.headers?.['x-plt-telemetry-id'] ?? 'unknown'
           return { telemetry_id: telemetryId }
         },
@@ -52,15 +53,15 @@ async function collectMetrics (stackable, serviceId, opts = {}) {
           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)
@@ -70,6 +71,59 @@ async function collectMetrics (stackable, serviceId, opts = {}) {
   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({
@@ -81,7 +135,7 @@ function collectEluMetric (register) {
       eluMetric.set(result)
       startELU = endELU
     },
-    registers: [register],
+    registers: [register]
   })
   register.registerMetric(eluMetric)
 
@@ -107,14 +161,14 @@ function collectEluMetric (register) {
       const idleDiff = idleTime - previousIdleTime
       const totalDiff = totalTime - previousTotalTime
 
-      const usagePercent = 100 - ((100 * idleDiff) / totalDiff)
+      const usagePercent = 100 - (100 * idleDiff) / totalDiff
       const roundedUsage = Math.round(usagePercent * 100) / 100
       cpuMetric.set(roundedUsage)
 
       previousIdleTime = idleTime
       previousTotalTime = totalTime
     },
-    registers: [register],
+    registers: [register]
   })
   register.registerMetric(cpuMetric)
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "2.5.1",
+  "version": "2.5.3",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -34,11 +34,11 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "2.5.1",
-    "@platformatic/db": "2.5.1",
-    "@platformatic/service": "2.5.1",
-    "@platformatic/sql-graphql": "2.5.1",
-    "@platformatic/sql-mapper": "2.5.1"
+    "@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"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
@@ -65,16 +65,17 @@
     "prom-client": "^15.1.2",
     "semgrator": "^0.3.0",
     "tail-file-stream": "^0.2.0",
+    "thread-cpu-usage": "^0.2.0",
     "undici": "^6.9.0",
     "undici-thread-interceptor": "^0.7.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "2.5.1",
-    "@platformatic/config": "2.5.1",
-    "@platformatic/generators": "2.5.1",
-    "@platformatic/itc": "2.5.1",
-    "@platformatic/ts-compiler": "2.5.1",
-    "@platformatic/telemetry": "2.5.1",
-    "@platformatic/utils": "2.5.1"
+    "@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"
   },
   "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.1.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/2.5.3.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {