@platformatic/runtime 3.61.1 → 3.62.0

package/lib/worker/health-signals.js

@@ -1,4 +1,5 @@
 import { getITC, updateGlobals } from '@platformatic/globals'
+import { monitorEventLoopDelay } from 'node:perf_hooks'
 import {
   HealthSignalMustBeObjectError,
   HealthSignalTypeMustBeStringError
@@ -79,4 +80,37 @@ export function initHealthSignalsApi (options = {}) {
   }
 
   updateGlobals({ sendHealthSignal })
+
+  return sendHealthSignal
+}
+
+// Samples the event loop delay and reports it as an eventLoopDelay health
+// signal once per second, in milliseconds. The measurement must run inside
+// the worker (monitorEventLoopDelay is per-isolate, there is no cross-thread
+// equivalent): during a hard block nothing is reported and a sample with a
+// large max arrives once the loop unblocks — full blocks are already caught
+// by the main-thread measured ELU, this signal catches long individual
+// stalls at low average utilization, which are invisible to any ELU
+// threshold.
+export function startEventLoopDelayMonitor (sendHealthSignal, options = {}) {
+  const histogram = monitorEventLoopDelay({ resolution: options.resolution ?? 20 })
+  histogram.enable()
+
+  const interval = setInterval(() => {
+    // With one-second windows the p99 is close to the max (few dozen samples
+    // per window), but it smooths single outliers on consumers that prefer it
+    const max = histogram.max / 1e6
+    const mean = histogram.mean / 1e6
+    const p99 = histogram.percentile(99) / 1e6
+    histogram.reset()
+
+    // Signals are delivered on a best-effort basis
+    sendHealthSignal({ type: 'eventLoopDelay', max, mean, p99 }).catch(() => {})
+  }, options.interval ?? 1000)
+  interval.unref()
+
+  return function stopEventLoopDelayMonitor () {
+    clearInterval(interval)
+    histogram.disable()
+  }
 }

package/lib/worker/main.js

@@ -22,7 +22,7 @@ import pino from 'pino'
 import { install as installUndiciGlobals } from 'undici'
 import { exitCodes } from '../errors.js'
 import { Controller } from './controller.js'
-import { initHealthSignalsApi } from './health-signals.js'
+import { initHealthSignalsApi, startEventLoopDelayMonitor } from './health-signals.js'
 import { setDispatcher } from './interceptors.js'
 import { setupITC } from './itc.js'
 import { SharedContext } from './shared-context.js'
@@ -338,11 +338,27 @@ async function main () {
     }
   }
 
-  initHealthSignalsApi({
+  const sendHealthSignal = initHealthSignalsApi({
     workerId: workerData.worker.id,
     applicationId: applicationConfig.id
   })
 
+  // When health.maxEventLoopDelay or health.maxEventLoopDelayP99 are
+  // configured, sample the event loop delay and report it as a health
+  // signal: the main thread evaluates it as part of the health checks and it
+  // is exposed on the health metrics event.
+  const maxEventLoopDelay = Number(applicationConfig.health?.maxEventLoopDelay ?? runtimeConfig.health?.maxEventLoopDelay)
+  const maxEventLoopDelayP99 = Number(
+    applicationConfig.health?.maxEventLoopDelayP99 ?? runtimeConfig.health?.maxEventLoopDelayP99
+  )
+
+  if (
+    (Number.isFinite(maxEventLoopDelay) && maxEventLoopDelay > 0) ||
+    (Number.isFinite(maxEventLoopDelayP99) && maxEventLoopDelayP99 > 0)
+  ) {
+    startEventLoopDelayMonitor(sendHealthSignal)
+  }
+
   itc.notify('init')
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@platformatic/runtime",
-  "version": "3.61.1",
-  "description": "",
+  "version": "3.62.0",
+  "description": "Platformatic runtime",
   "main": "index.js",
   "type": "module",
   "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
@@ -36,17 +36,17 @@
     "pino-sentry-transport": "^1.6.0",
     "split2": "^4.2.0",
     "tstyche": "^6.2.0",
-    "typescript": "^5.5.4",
+    "typescript": "^5.9.3",
     "undici-oidc-interceptor": "^0.9.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/db": "3.61.1",
-    "@platformatic/gateway": "3.61.1",
-    "@platformatic/service": "3.61.1",
-    "@platformatic/node": "3.61.1",
-    "@platformatic/composer": "3.61.1",
-    "@platformatic/sql-graphql": "3.61.1",
-    "@platformatic/wattpm-pprof-capture": "3.61.1",
-    "@platformatic/sql-mapper": "3.61.1"
+    "@platformatic/db": "3.62.0",
+    "@platformatic/composer": "3.62.0",
+    "@platformatic/node": "3.62.0",
+    "@platformatic/service": "3.62.0",
+    "@platformatic/sql-mapper": "3.62.0",
+    "@platformatic/wattpm-pprof-capture": "3.62.0",
+    "@platformatic/sql-graphql": "3.62.0",
+    "@platformatic/gateway": "3.62.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -77,13 +77,13 @@
     "undici": "^7.27.2",
     "undici-thread-interceptor": "^1.3.1",
     "ws": "^8.16.0",
-    "@platformatic/basic": "3.61.1",
-    "@platformatic/foundation": "3.61.1",
-    "@platformatic/globals": "3.61.1",
-    "@platformatic/itc": "3.61.1",
-    "@platformatic/metrics": "3.61.1",
-    "@platformatic/telemetry": "3.61.1",
-    "@platformatic/generators": "3.61.1"
+    "@platformatic/basic": "3.62.0",
+    "@platformatic/foundation": "3.62.0",
+    "@platformatic/generators": "3.62.0",
+    "@platformatic/globals": "3.62.0",
+    "@platformatic/itc": "3.62.0",
+    "@platformatic/metrics": "3.62.0",
+    "@platformatic/telemetry": "3.62.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.61.1.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.62.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",
@@ -22,6 +22,59 @@
         }
       ]
     },
+    "extensions": {
+      "anyOf": [
+        {
+          "type": "string",
+          "resolvePath": true
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "path"
+          ],
+          "properties": {
+            "path": {
+              "type": "string",
+              "resolvePath": true
+            },
+            "options": {
+              "type": "object",
+              "additionalProperties": true
+            }
+          }
+        },
+        {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string",
+                "resolvePath": true
+              },
+              {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                  "path"
+                ],
+                "properties": {
+                  "path": {
+                    "type": "string",
+                    "resolvePath": true
+                  },
+                  "options": {
+                    "type": "object",
+                    "additionalProperties": true
+                  }
+                }
+              }
+            ]
+          }
+        }
+      ]
+    },
     "entrypoint": {
       "type": "string"
     },
@@ -181,6 +234,28 @@
                       }
                     ]
                   },
+                  "maxEventLoopDelay": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "maxEventLoopDelayP99": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
                   "maxHeapUsed": {
                     "anyOf": [
                       {
@@ -251,6 +326,18 @@
                 },
                 "additionalProperties": false
               },
+              "restartOnError": {
+                "description": "Overrides the runtime-level restartOnError for this application. Set to false or 0 to never restart the application when it crashes, a positive number to wait that amount of milliseconds between restarts, or true to use the default delay.",
+                "anyOf": [
+                  {
+                    "type": "boolean"
+                  },
+                  {
+                    "type": "number",
+                    "minimum": 0
+                  }
+                ]
+              },
               "dependencies": {
                 "type": "array",
                 "items": {
@@ -579,6 +666,28 @@
                   }
                 ]
               },
+              "maxEventLoopDelay": {
+                "anyOf": [
+                  {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "maxEventLoopDelayP99": {
+                "anyOf": [
+                  {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
               "maxHeapUsed": {
                 "anyOf": [
                   {
@@ -649,6 +758,18 @@
             },
             "additionalProperties": false
           },
+          "restartOnError": {
+            "description": "Overrides the runtime-level restartOnError for this application. Set to false or 0 to never restart the application when it crashes, a positive number to wait that amount of milliseconds between restarts, or true to use the default delay.",
+            "anyOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "number",
+                "minimum": 0
+              }
+            ]
+          },
           "dependencies": {
             "type": "array",
             "items": {
@@ -975,6 +1096,28 @@
                   }
                 ]
               },
+              "maxEventLoopDelay": {
+                "anyOf": [
+                  {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "maxEventLoopDelayP99": {
+                "anyOf": [
+                  {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
               "maxHeapUsed": {
                 "anyOf": [
                   {
@@ -1045,6 +1188,18 @@
             },
             "additionalProperties": false
           },
+          "restartOnError": {
+            "description": "Overrides the runtime-level restartOnError for this application. Set to false or 0 to never restart the application when it crashes, a positive number to wait that amount of milliseconds between restarts, or true to use the default delay.",
+            "anyOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "number",
+                "minimum": 0
+              }
+            ]
+          },
           "dependencies": {
             "type": "array",
             "items": {
@@ -1371,6 +1526,28 @@
                   }
                 ]
               },
+              "maxEventLoopDelay": {
+                "anyOf": [
+                  {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "maxEventLoopDelayP99": {
+                "anyOf": [
+                  {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
               "maxHeapUsed": {
                 "anyOf": [
                   {
@@ -1441,6 +1618,18 @@
             },
             "additionalProperties": false
           },
+          "restartOnError": {
+            "description": "Overrides the runtime-level restartOnError for this application. Set to false or 0 to never restart the application when it crashes, a positive number to wait that amount of milliseconds between restarts, or true to use the default delay.",
+            "anyOf": [
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "number",
+                "minimum": 0
+              }
+            ]
+          },
           "dependencies": {
             "type": "array",
             "items": {
@@ -2136,6 +2325,28 @@
           ],
           "default": 0.99
         },
+        "maxEventLoopDelay": {
+          "anyOf": [
+            {
+              "type": "number",
+              "minimum": 0
+            },
+            {
+              "type": "string"
+            }
+          ]
+        },
+        "maxEventLoopDelayP99": {
+          "anyOf": [
+            {
+              "type": "number",
+              "minimum": 0
+            },
+            {
+              "type": "string"
+            }
+          ]
+        },
         "maxHeapUsed": {
           "anyOf": [
             {