@platformatic/basic 3.13.0 → 3.14.0

package/config.d.ts

@@ -13,7 +13,20 @@ export interface PlatformaticBasicConfig {
     services?: {
       [k: string]: unknown;
     }[];
-    workers?: number | string;
+    workers?:
+      | number
+      | string
+      | {
+          static?: number;
+          dynamic?: boolean;
+          minimum?: number;
+          maximum?: number;
+          total?: number;
+          maxMemory?: number;
+          cooldown?: number;
+          gracePeriod?: number;
+          [k: string]: unknown;
+        };
     workersRestartDelay?: number | string;
     logger?: {
       level: (
@@ -221,6 +234,37 @@ export interface PlatformaticBasicConfig {
               };
           plugins?: string[];
           timeout?: number | string;
+          /**
+           * Configuration for exporting metrics to an OTLP endpoint
+           */
+          otlpExporter?: {
+            /**
+             * Enable or disable OTLP metrics export
+             */
+            enabled?: boolean | string;
+            /**
+             * OTLP endpoint URL (e.g., http://collector:4318/v1/metrics)
+             */
+            endpoint: string;
+            /**
+             * Interval in milliseconds between metric pushes
+             */
+            interval?: number | string;
+            /**
+             * Additional HTTP headers for authentication
+             */
+            headers?: {
+              [k: string]: string;
+            };
+            /**
+             * Service name for OTLP resource attributes
+             */
+            serviceName?: string;
+            /**
+             * Service version for OTLP resource attributes
+             */
+            serviceVersion?: string;
+          };
         };
     telemetry?: {
       enabled?: boolean | string;
@@ -304,13 +348,28 @@ export interface PlatformaticBasicConfig {
       maxTotalMemory?: number;
       minWorkers?: number;
       maxWorkers?: number;
+      cooldownSec?: number;
+      gracePeriod?: number;
+      /**
+       * @deprecated
+       */
       scaleUpELU?: number;
+      /**
+       * @deprecated
+       */
       scaleDownELU?: number;
+      /**
+       * @deprecated
+       */
       timeWindowSec?: number;
+      /**
+       * @deprecated
+       */
       scaleDownTimeWindowSec?: number;
-      cooldownSec?: number;
+      /**
+       * @deprecated
+       */
       scaleIntervalSec?: number;
-      gracePeriod?: number;
     };
     inspectorOptions?: {
       host?: string;

package/lib/capability.js

@@ -6,7 +6,7 @@ import {
   kMetadata,
   kTimeout
 } from '@platformatic/foundation'
-import { client, collectMetrics, ensureMetricsGroup } from '@platformatic/metrics'
+import { client, collectMetrics, ensureMetricsGroup, setupOtlpExporter } from '@platformatic/metrics'
 import { parseCommandString } from 'execa'
 import { spawn } from 'node:child_process'
 import EventEmitter, { once } from 'node:events'
@@ -50,7 +50,8 @@ export class BaseCapability extends EventEmitter {
   subprocessForceClose
   subprocessTerminationSignal
   logger
-  metricsRegistr
+  metricsRegistry
+  otlpBridge
 
   #subprocessStarted
   #metricsCollected
@@ -69,7 +70,7 @@ export class BaseCapability extends EventEmitter {
     this.standardStreams = standardStreams
 
     this.applicationId = this.context.applicationId
-    this.workerId = this.context.worker.count > 1 ? this.context.worker.index : undefined
+    this.workerId = this.context.worker.index
     this.telemetryConfig = this.context.telemetryConfig
     this.serverConfig = deepmerge(this.context.serverConfig ?? {}, config.server ?? {})
     this.openapiSchema = null
@@ -118,6 +119,7 @@ export class BaseCapability extends EventEmitter {
       this.registerGlobals({ prometheus: { client, registry: this.metricsRegistry } })
     }
 
+    this.otlpBridge = null
     this.#metricsCollected = false
     this.#pendingDependenciesWaits = new Set()
   }
@@ -156,6 +158,12 @@ export class BaseCapability extends EventEmitter {
     if (this.#pendingDependenciesWaits.size > 0) {
       await Promise.allSettled(this.#pendingDependenciesWaits)
     }
+
+    // Stop OTLP bridge if running
+    if (this.otlpBridge) {
+      this.otlpBridge.stop()
+      this.otlpBridge = null
+    }
   }
 
   build () {
@@ -620,6 +628,7 @@ export class BaseCapability extends EventEmitter {
 
     await this.#collectMetrics()
     this.#setHttpCacheMetrics()
+    await this.#setupOtlpExporter()
   }
 
   async #collectMetrics () {
@@ -736,6 +745,33 @@ export class BaseCapability extends EventEmitter {
     globalThis.platformatic.onActiveResourcesEventLoop = val => activeResourcesEventLoopMetric.set(val)
   }
 
+  async #setupOtlpExporter () {
+    const metricsConfig = this.context.metricsConfig
+    if (!metricsConfig || !metricsConfig.otlpExporter) {
+      return
+    }
+
+    // Wait for telemetry to be ready before loading promotel to avoid race condition
+    if (globalThis.platformatic?.telemetryReady) {
+      await globalThis.platformatic.telemetryReady
+    }
+
+    // Setup and start OTLP exporter bridge
+    this.otlpBridge = await setupOtlpExporter(
+      this.metricsRegistry,
+      metricsConfig.otlpExporter,
+      this.applicationId
+    )
+
+    if (this.otlpBridge) {
+      this.otlpBridge.start()
+      this.logger.info({
+        endpoint: metricsConfig.otlpExporter.endpoint,
+        interval: metricsConfig.otlpExporter.interval || 60000
+      }, 'OTLP metrics exporter started')
+    }
+  }
+
   async #invalidateHttpCache (opts = {}) {
     await globalThis[kITC].send('invalidateHttpCache', opts)
   }

package/lib/worker/child-process.js

@@ -100,6 +100,10 @@ export class ChildProcess extends ITC {
           }
 
           if (!handled) {
+            this.#logger.warn(
+              `Please register a "close" event handler in globalThis.platformatic.events for application "${this.applicationId}" to make sure resources have been closed properly and avoid exit timeouts.`
+            )
+
             // No user event, just exit without errors
             setImmediate(() => {
               process.exit(process.exitCode ?? 0)
@@ -327,7 +331,7 @@ export class ChildProcess extends ITC {
       pinoOptions.timestamp = buildPinoTimestamp(loggerOptions.timestamp)
     }
 
-    if (loggerOptions.base !== null && typeof globalThis.platformatic.workerId !== 'undefined') {
+    if (loggerOptions.base !== null) {
       pinoOptions.base = {
         ...(pinoOptions.base ?? {}),
         pid: process.pid,
@@ -401,10 +405,7 @@ export class ChildProcess extends ITC {
   }
 
   #setupHandlers () {
-    const errorLabel =
-      typeof globalThis.platformatic.workerId !== 'undefined'
-        ? `worker ${globalThis.platformatic.workerId} of the application "${globalThis.platformatic.applicationId}"`
-        : `application "${globalThis.platformatic.applicationId}"`
+    const errorLabel = `worker ${globalThis.platformatic.workerId} of the application "${globalThis.platformatic.applicationId}"`
 
     function handleUnhandled (type, err) {
       this.#logger.error({ err: ensureLoggableError(err) }, `Child process for the ${errorLabel} threw an ${type}.`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "3.13.0",
+  "version": "3.14.0",
   "description": "",
   "main": "index.js",
   "types": "index.d.ts",
@@ -25,10 +25,10 @@
     "split2": "^4.2.0",
     "undici": "^7.0.0",
     "ws": "^8.18.0",
-    "@platformatic/foundation": "3.13.0",
-    "@platformatic/itc": "3.13.0",
-    "@platformatic/telemetry": "3.13.0",
-    "@platformatic/metrics": "3.13.0"
+    "@platformatic/itc": "3.14.0",
+    "@platformatic/foundation": "3.14.0",
+    "@platformatic/metrics": "3.14.0",
+    "@platformatic/telemetry": "3.14.0"
   },
   "devDependencies": {
     "cleaner-spec-reporter": "^0.5.0",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/basic/3.13.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/basic/3.14.0.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Basic Config",
   "type": "object",
@@ -71,11 +71,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
+                      }
+                    }
                   }
                 ]
               },
@@ -296,6 +312,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
+                }
+              }
             }
           ]
         },
@@ -1072,6 +1125,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
@@ -1231,35 +1336,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
             }
           },
           "additionalProperties": false