@platformatic/runtime 3.13.1 → 3.14.0

package/lib/scaling-algorithm.js

@@ -1,23 +1,28 @@
-class ScalingAlgorithm {
-  #scaleUpELU
-  #scaleDownELU
+export const scaleUpELUThreshold = 0.8
+export const scaleDownELUThreshold = 0.2
+export const scaleUpTimeWindow = 10_000
+export const scaleDownTimeWindow = 60_000
+
+export class ScalingAlgorithm {
   #maxTotalWorkers
-  #scaleUpTimeWindowSec
-  #scaleDownTimeWindowSec
   #appsMetrics
   #appsConfigs
 
   constructor (options = {}) {
-    this.#scaleUpELU = options.scaleUpELU ?? 0.8
-    this.#scaleDownELU = options.scaleDownELU ?? 0.2
     this.#maxTotalWorkers = options.maxTotalWorkers ?? Infinity
-    this.#scaleUpTimeWindowSec = options.scaleUpTimeWindowSec ?? 10
-    this.#scaleDownTimeWindowSec = options.scaleDownTimeWindowSec ?? 60
     this.#appsConfigs = options.applications ?? {}
-
     this.#appsMetrics = {}
   }
 
+  addApplication (id, config) {
+    this.#appsConfigs[id] = config
+  }
+
+  removeApplication (id) {
+    delete this.#appsConfigs[id]
+    delete this.#appsMetrics[id]
+  }
+
   addWorkerHealthInfo (healthInfo) {
     const { workerId, applicationId, elu, heapUsed } = healthInfo
     const timestamp = Date.now()
@@ -50,7 +55,7 @@ class ScalingAlgorithm {
       appsInfo.push({
         applicationId,
         workersCount,
-        avgHeapUsed: heapUsed,
+        avgHeapUsed: heapUsed
       })
 
       totalWorkersCount += workersCount
@@ -112,9 +117,7 @@ class ScalingAlgorithm {
         if (workersCount >= appMaxWorkers) continue
         if (avgHeapUsed >= totalAvailableMemory) continue
 
-        const isScaled = recommendations.some(
-          r => r.applicationId === applicationId
-        )
+        const isScaled = recommendations.some(r => r.applicationId === applicationId)
         if (isScaled) continue
 
         const recommendation = this.#getApplicationScaleRecommendation(applicationId)
@@ -122,10 +125,8 @@ class ScalingAlgorithm {
 
         if (
           !scaleUpCandidate ||
-          (recommendation.scaleUpELU > scaleUpCandidate.scaleUpELU) ||
-          (recommendation.scaleUpELU === scaleUpCandidate.scaleUpELU &&
-            workersCount < scaleUpCandidate.workersCount
-          )
+          recommendation.scaleUpELU > scaleUpCandidate.scaleUpELU ||
+          (recommendation.scaleUpELU === scaleUpCandidate.scaleUpELU && workersCount < scaleUpCandidate.workersCount)
         ) {
           scaleUpCandidate = {
             applicationId,
@@ -186,8 +187,8 @@ class ScalingAlgorithm {
       count++
     }
 
-    const elu = Math.round(eluSum / count * 100) / 100
-    const heapUsed = Math.round(heapUsedSum / count * 100) / 100
+    const elu = Math.round((eluSum / count) * 100) / 100
+    const heapUsed = Math.round((heapUsedSum / count) * 100) / 100
     return { elu, heapUsed }
   }
 
@@ -226,28 +227,22 @@ class ScalingAlgorithm {
   }
 
   #getMetricsTimeWindow () {
-    return Math.max(this.#scaleUpTimeWindowSec, this.#scaleDownTimeWindowSec) * 1000
+    return Math.max(scaleUpTimeWindow, scaleDownTimeWindow) * 1000
   }
 
   #getApplicationScaleRecommendation (applicationId) {
-    const { elu: scaleUpELU } = this.#calculateAppAvgMetrics(applicationId, {
-      timeWindow: this.#scaleUpTimeWindowSec * 1000
-    })
-    const { elu: scaleDownELU } = this.#calculateAppAvgMetrics(applicationId, {
-      timeWindow: this.#scaleDownTimeWindowSec * 1000
-    })
+    const { elu: scaleUpELU } = this.#calculateAppAvgMetrics(applicationId, { timeWindow: scaleUpTimeWindow })
+    const { elu: scaleDownELU } = this.#calculateAppAvgMetrics(applicationId, { timeWindow: scaleDownTimeWindow })
     const { heapUsed: avgHeapUsage } = this.#calculateAppAvgMetrics(applicationId)
 
     let recommendation = null
-    if (scaleUpELU > this.#scaleUpELU) {
+    if (scaleUpELU > scaleUpELUThreshold) {
       recommendation = 'scaleUp'
     }
-    if (scaleDownELU < this.#scaleDownELU) {
+    if (scaleDownELU < scaleDownELUThreshold) {
       recommendation = 'scaleDown'
     }
 
     return { recommendation, scaleUpELU, scaleDownELU, avgHeapUsage }
   }
 }
-
-export default ScalingAlgorithm

package/lib/worker/controller.js

@@ -161,7 +161,7 @@ export class Controller extends EventEmitter {
       return
     }
 
-    this.capability.updateStatus('starting')
+    this.#updateCapabilityStatus('starting')
     this.emit('starting')
 
     if (this.#watch) {
@@ -185,7 +185,7 @@ export class Controller extends EventEmitter {
       this.#listening = listen
       /* c8 ignore next 5 */
     } catch (err) {
-      this.capability.updateStatus('start:error')
+      this.#updateCapabilityStatus('start:error')
       this.emit('start:error', err)
 
       this.capability.log({ message: err.message, level: 'debug' })
@@ -196,7 +196,7 @@ export class Controller extends EventEmitter {
     this.#started = true
     this.#starting = false
 
-    this.capability.updateStatus('started')
+    this.#updateCapabilityStatus('started')
     this.emit('started')
   }
 
@@ -218,7 +218,7 @@ export class Controller extends EventEmitter {
     this.#starting = false
     this.#listening = false
 
-    this.capability.updateStatus('stopped')
+    this.#updateCapabilityStatus('stopped')
     this.emit('stopped')
   }
 
@@ -333,4 +333,14 @@ export class Controller extends EventEmitter {
       }
     })
   }
+
+  #updateCapabilityStatus (status) {
+    if (typeof this.capability.updateStatus === 'function') {
+      this.capability.updateStatus(status)
+    } else {
+      // This is horrible but needed for backward compatibility
+      this.capability.status = status
+      this.capability.emit(status)
+    }
+  }
 }

package/lib/worker/health-signals.js

@@ -0,0 +1,80 @@
+import {
+  HealthSignalMustBeObjectError,
+  HealthSignalTypeMustBeStringError
+} from '../errors.js'
+
+export class HealthSignalsQueue {
+  #size
+  #values
+
+  constructor (options = {}) {
+    this.#size = options.size ?? 100
+    this.#values = []
+  }
+
+  add (value) {
+    if (Array.isArray(value)) {
+      for (const v of value) {
+        this.#values.push(v)
+      }
+    } else {
+      this.#values.push(value)
+    }
+    if (this.#values.length > this.#size) {
+      this.#values.splice(0, this.#values.length - this.#size)
+    }
+  }
+
+  getAll () {
+    const values = this.#values
+    this.#values = []
+    return values
+  }
+}
+
+export function initHealthSignalsApi (options = {}) {
+  const queue = new HealthSignalsQueue()
+  const timeout = options.timeout ?? 1000
+  const workerId = options.workerId
+
+  let isSending = false
+  let promise = null
+
+  async function sendHealthSignal (signal) {
+    if (typeof signal !== 'object') {
+      throw new HealthSignalMustBeObjectError()
+    }
+    if (typeof signal.type !== 'string') {
+      throw new HealthSignalTypeMustBeStringError(signal.type)
+    }
+    if (!signal.timestamp || typeof signal.timestamp !== 'number') {
+      signal.timestamp = Date.now()
+    }
+
+    queue.add(signal)
+
+    if (!isSending) {
+      isSending = true
+      promise = new Promise((resolve, reject) => {
+        setTimeout(async () => {
+          isSending = false
+          try {
+            const signals = queue.getAll()
+            await globalThis.platformatic.itc.send('sendHealthSignals', {
+              workerId,
+              signals
+            })
+          } catch (err) {
+            reject(err)
+            return
+          }
+          resolve()
+        }, timeout)
+      })
+    }
+
+    return promise
+  }
+
+  globalThis.platformatic.sendHealthSignal = sendHealthSignal
+}

package/lib/worker/main.js

@@ -20,6 +20,7 @@ import { setDispatcher } from './interceptors.js'
 import { setupITC } from './itc.js'
 import { SharedContext } from './shared-context.js'
 import { kId, kITC, kStderrMarker } from './symbols.js'
+import { initHealthSignalsApi } from './health-signals.js'
 
 class ForwardingEventEmitter extends EventEmitter {
   emitAndNotify (event, ...args) {
@@ -190,6 +191,11 @@ async function main () {
   globalThis[kITC] = itc
   globalThis.platformatic.itc = itc
 
+  initHealthSignalsApi({
+    workerId: workerData.worker.id,
+    applicationId: applicationConfig.id
+  })
+
   itc.notify('init')
 }
 

package/lib/worker/symbols.js

@@ -5,7 +5,9 @@ export const kApplicationId = Symbol.for('plt.runtime.application.id')
 export const kWorkerId = Symbol.for('plt.runtime.worker.id')
 export const kITC = Symbol.for('plt.runtime.itc')
 export const kHealthCheckTimer = Symbol.for('plt.runtime.worker.healthCheckTimer')
+export const kHealthMetricsTimer = Symbol.for('plt.runtime.worker.healthMetricsTimer')
 export const kWorkerStatus = Symbol('plt.runtime.worker.status')
+export const kWorkerHealthSignals = Symbol.for('plt.runtime.worker.healthSignals')
 export const kWorkerStartTime = Symbol.for('plt.runtime.worker.startTime')
 export const kInterceptors = Symbol.for('plt.runtime.worker.interceptors')
 export const kLastHealthCheckELU = Symbol.for('plt.runtime.worker.lastHealthCheckELU')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "3.13.1",
+  "version": "3.14.0",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -35,14 +35,14 @@
     "typescript": "^5.5.4",
     "undici-oidc-interceptor": "^0.5.0",
     "why-is-node-running": "^2.2.2",
-    "@platformatic/composer": "3.13.1",
-    "@platformatic/db": "3.13.1",
-    "@platformatic/gateway": "3.13.1",
-    "@platformatic/node": "3.13.1",
-    "@platformatic/service": "3.13.1",
-    "@platformatic/sql-graphql": "3.13.1",
-    "@platformatic/sql-mapper": "3.13.1",
-    "@platformatic/wattpm-pprof-capture": "3.13.1"
+    "@platformatic/db": "3.14.0",
+    "@platformatic/gateway": "3.14.0",
+    "@platformatic/composer": "3.14.0",
+    "@platformatic/node": "3.14.0",
+    "@platformatic/service": "3.14.0",
+    "@platformatic/sql-graphql": "3.14.0",
+    "@platformatic/sql-mapper": "3.14.0",
+    "@platformatic/wattpm-pprof-capture": "3.14.0"
   },
   "dependencies": {
     "@fastify/accepts": "^5.0.0",
@@ -73,12 +73,12 @@
     "undici": "^7.0.0",
     "undici-thread-interceptor": "^0.15.0",
     "ws": "^8.16.0",
-    "@platformatic/basic": "3.13.1",
-    "@platformatic/generators": "3.13.1",
-    "@platformatic/foundation": "3.13.1",
-    "@platformatic/telemetry": "3.13.1",
-    "@platformatic/itc": "3.13.1",
-    "@platformatic/metrics": "3.13.1"
+    "@platformatic/basic": "3.14.0",
+    "@platformatic/metrics": "3.14.0",
+    "@platformatic/foundation": "3.14.0",
+    "@platformatic/generators": "3.14.0",
+    "@platformatic/telemetry": "3.14.0",
+    "@platformatic/itc": "3.14.0"
   },
   "engines": {
     "node": ">=22.19.0"

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.13.1.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/runtime/3.14.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Runtime Config",
   "type": "object",
@@ -67,11 +67,27 @@
               "workers": {
                 "anyOf": [
                   {
-                    "type": "number",
-                    "minimum": 1
+                    "type": "number"
                   },
                   {
                     "type": "string"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "static": {
+                        "type": "number",
+                        "minimum": 1
+                      },
+                      "minimum": {
+                        "type": "number",
+                        "minimum": 1
+                      },
+                      "maximum": {
+                        "type": "number",
+                        "minimum": 0
+                      }
+                    }
                   }
                 ]
               },
@@ -329,11 +345,27 @@
           "workers": {
             "anyOf": [
               {
-                "type": "number",
-                "minimum": 1
+                "type": "number"
               },
               {
                 "type": "string"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "static": {
+                    "type": "number",
+                    "minimum": 1
+                  },
+                  "minimum": {
+                    "type": "number",
+                    "minimum": 1
+                  },
+                  "maximum": {
+                    "type": "number",
+                    "minimum": 0
+                  }
+                }
               }
             ]
           },
@@ -589,11 +621,27 @@
           "workers": {
             "anyOf": [
               {
-                "type": "number",
-                "minimum": 1
+                "type": "number"
               },
               {
                 "type": "string"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "static": {
+                    "type": "number",
+                    "minimum": 1
+                  },
+                  "minimum": {
+                    "type": "number",
+                    "minimum": 1
+                  },
+                  "maximum": {
+                    "type": "number",
+                    "minimum": 0
+                  }
+                }
               }
             ]
           },
@@ -849,11 +897,27 @@
           "workers": {
             "anyOf": [
               {
-                "type": "number",
-                "minimum": 1
+                "type": "number"
               },
               {
                 "type": "string"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "static": {
+                    "type": "number",
+                    "minimum": 1
+                  },
+                  "minimum": {
+                    "type": "number",
+                    "minimum": 1
+                  },
+                  "maximum": {
+                    "type": "number",
+                    "minimum": 0
+                  }
+                }
               }
             ]
           },
@@ -1074,6 +1138,43 @@
         },
         {
           "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "static": {
+              "type": "number",
+              "minimum": 1
+            },
+            "dynamic": {
+              "type": "boolean",
+              "default": false
+            },
+            "minimum": {
+              "type": "number",
+              "minimum": 1
+            },
+            "maximum": {
+              "type": "number",
+              "minimum": 0
+            },
+            "total": {
+              "type": "number",
+              "minimum": 1
+            },
+            "maxMemory": {
+              "type": "number",
+              "minimum": 0
+            },
+            "cooldown": {
+              "type": "number",
+              "minimum": 0
+            },
+            "gracePeriod": {
+              "type": "number",
+              "minimum": 0
+            }
+          }
         }
       ]
     },
@@ -1854,6 +1955,58 @@
                 }
               ],
               "default": 10000
+            },
+            "otlpExporter": {
+              "type": "object",
+              "description": "Configuration for exporting metrics to an OTLP endpoint",
+              "properties": {
+                "enabled": {
+                  "anyOf": [
+                    {
+                      "type": "boolean"
+                    },
+                    {
+                      "type": "string"
+                    }
+                  ],
+                  "description": "Enable or disable OTLP metrics export"
+                },
+                "endpoint": {
+                  "type": "string",
+                  "description": "OTLP endpoint URL (e.g., http://collector:4318/v1/metrics)"
+                },
+                "interval": {
+                  "anyOf": [
+                    {
+                      "type": "integer"
+                    },
+                    {
+                      "type": "string"
+                    }
+                  ],
+                  "default": 60000,
+                  "description": "Interval in milliseconds between metric pushes"
+                },
+                "headers": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string"
+                  },
+                  "description": "Additional HTTP headers for authentication"
+                },
+                "serviceName": {
+                  "type": "string",
+                  "description": "Service name for OTLP resource attributes"
+                },
+                "serviceVersion": {
+                  "type": "string",
+                  "description": "Service version for OTLP resource attributes"
+                }
+              },
+              "required": [
+                "endpoint"
+              ],
+              "additionalProperties": false
             }
           },
           "additionalProperties": false
@@ -2013,35 +2166,40 @@
           "type": "number",
           "minimum": 1
         },
+        "cooldownSec": {
+          "type": "number",
+          "minimum": 0
+        },
+        "gracePeriod": {
+          "type": "number",
+          "minimum": 0
+        },
         "scaleUpELU": {
           "type": "number",
           "minimum": 0,
-          "maximum": 1
+          "maximum": 1,
+          "deprecated": true
         },
         "scaleDownELU": {
           "type": "number",
           "minimum": 0,
-          "maximum": 1
+          "maximum": 1,
+          "deprecated": true
         },
         "timeWindowSec": {
           "type": "number",
-          "minimum": 0
+          "minimum": 0,
+          "deprecated": true
         },
         "scaleDownTimeWindowSec": {
           "type": "number",
-          "minimum": 0
-        },
-        "cooldownSec": {
-          "type": "number",
-          "minimum": 0
+          "minimum": 0,
+          "deprecated": true
         },
         "scaleIntervalSec": {
           "type": "number",
-          "minimum": 0
-        },
-        "gracePeriod": {
-          "type": "number",
-          "minimum": 0
+          "minimum": 0,
+          "deprecated": true
         },
         "applications": {
           "type": "object",