@platformatic/basic 2.5.4 → 2.5.5-alpha.2

package/lib/base.js

@@ -1,4 +1,5 @@
 import { deepmerge } from '@platformatic/utils'
+import { collectMetrics } from '@platformatic/metrics'
 import { parseCommandString } from 'execa'
 import { spawn } from 'node:child_process'
 import { once } from 'node:events'
@@ -12,7 +13,7 @@ import { cleanBasePath } from './utils.js'
 import { ChildManager } from './worker/child-manager.js'
 
 export class BaseStackable {
-  #childManager
+  childManager
   #subprocess
   #subprocessStarted
 
@@ -29,6 +30,10 @@ export class BaseStackable {
     this.graphqlSchema = null
     this.isEntrypoint = options.context.isEntrypoint
     this.isProduction = options.context.isProduction
+    this.metricsRegistry = null
+    this.startHttpTimer = null
+    this.endHttpTimer = null
+    this.clientWs = null
 
     // Setup the logger
     const pinoOptions = {
@@ -85,13 +90,6 @@ export class BaseStackable {
     return this
   }
 
-  async collectMetrics () {
-    return {
-      defaultMetrics: true,
-      httpMetrics: false
-    }
-  }
-
   async getOpenapiSchema () {
     return this.openapiSchema
   }
@@ -136,7 +134,7 @@ export class BaseStackable {
 
     this.logger.debug(`Executing "${command}" ...`)
 
-    this.#childManager = new ChildManager({
+    this.childManager = new ChildManager({
       logger: this.logger,
       loader,
       scripts,
@@ -153,7 +151,7 @@ export class BaseStackable {
     })
 
     try {
-      await this.#childManager.inject()
+      await this.childManager.inject()
 
       const subprocess = this.spawn(command)
 
@@ -182,15 +180,15 @@ export class BaseStackable {
         throw error
       }
     } finally {
-      await this.#childManager.eject()
-      await this.#childManager.close()
+      await this.childManager.eject()
+      await this.childManager.close()
     }
   }
 
   async startWithCommand (command, loader) {
     const config = this.configManager.current
     const basePath = config.application?.basePath ? cleanBasePath(config.application?.basePath) : ''
-    this.#childManager = new ChildManager({
+    this.childManager = new ChildManager({
       logger: this.logger,
       loader,
       context: {
@@ -206,12 +204,12 @@ export class BaseStackable {
       }
     })
 
-    this.#childManager.on('config', config => {
+    this.childManager.on('config', config => {
       this.subprocessConfig = config
     })
 
     try {
-      await this.#childManager.inject()
+      await this.childManager.inject()
 
       this.subprocess = this.spawn(command)
 
@@ -234,35 +232,36 @@ export class BaseStackable {
 
       this.#subprocessStarted = true
     } catch (e) {
-      this.#childManager.close('SIGKILL')
+      this.childManager.close('SIGKILL')
       throw new Error(`Cannot execute command "${command}": executable not found`)
     } finally {
-      await this.#childManager.eject()
+      await this.childManager.eject()
     }
 
     // If the process exits prematurely, terminate the thread with the same code
     this.subprocess.on('exit', code => {
       if (this.#subprocessStarted && typeof code === 'number' && code !== 0) {
-        this.#childManager.close('SIGKILL')
+        this.childManager.close('SIGKILL')
         process.exit(code)
       }
     })
 
-    const [url] = await once(this.#childManager, 'url')
+    const [url, clientWs] = await once(this.childManager, 'url')
     this.url = url
+    this.clientWs = clientWs
   }
 
   async stopCommand () {
     this.#subprocessStarted = false
     const exitPromise = once(this.subprocess, 'exit')
 
-    this.#childManager.close(this.subprocessTerminationSignal ?? 'SIGINT')
+    this.childManager.close(this.subprocessTerminationSignal ?? 'SIGINT')
     this.subprocess.kill(this.subprocessTerminationSignal ?? 'SIGINT')
     await exitPromise
   }
 
   getChildManager () {
-    return this.#childManager
+    return this.childManager
   }
 
   spawn (command) {
@@ -273,4 +272,44 @@ export class BaseStackable {
       ? spawn(command, { cwd: this.root, shell: true, windowsVerbatimArguments: true })
       : spawn(executable, args, { cwd: this.root })
   }
+
+  async collectMetrics () {
+    let metricsConfig = this.options.context.metricsConfig
+    if (metricsConfig !== false) {
+      metricsConfig = {
+        defaultMetrics: true,
+        httpMetrics: true,
+        ...metricsConfig
+      }
+
+      if (this.childManager && this.clientWs) {
+        await this.childManager.send(this.clientWs, 'collectMetrics', {
+          serviceId: this.id,
+          metricsConfig
+        })
+        return
+      }
+
+      const { registry, startHttpTimer, endHttpTimer } = await collectMetrics(
+        this.id,
+        metricsConfig
+      )
+
+      this.metricsRegistry = registry
+      this.startHttpTimer = startHttpTimer
+      this.endHttpTimer = endHttpTimer
+    }
+  }
+
+  async getMetrics ({ format } = {}) {
+    if (this.childManager && this.clientWs) {
+      return this.childManager.send(this.clientWs, 'getMetrics', { format })
+    }
+
+    if (!this.metricsRegistry) return null
+
+    return format === 'json'
+      ? await this.metricsRegistry.getMetricsAsJSON()
+      : await this.metricsRegistry.metrics()
+  }
 }

package/lib/worker/child-manager.js

@@ -44,6 +44,7 @@ export class ChildManager extends ITC {
   #socketPath
   #clients
   #requests
+  #currentSender
   #currentClient
   #listener
   #originalNodeOptions
@@ -97,11 +98,14 @@ export class ChildManager extends ITC {
 
       ws.on('message', raw => {
         try {
+          this.#currentSender = ws
           const message = JSON.parse(raw)
           this.#requests.set(message.reqId, ws)
           this.#listener(message)
         } catch (error) {
           this.#handleUnexpectedError(error, 'Handling a message failed.', exitCodes.MANAGER_MESSAGE_HANDLING_FAILED)
+        } finally {
+          this.#currentSender = null
         }
       })
 
@@ -182,6 +186,10 @@ export class ChildManager extends ITC {
     register(this.#loader, { data: this.#context })
   }
 
+  emit (...args) {
+    super.emit(...args, this.#currentSender)
+  }
+
   send (client, name, message) {
     this.#currentClient = client
     return super.send(name, message)

package/lib/worker/child-process.js

@@ -1,6 +1,7 @@
 import { ITC } from '@platformatic/itc'
 import { setupNodeHTTPTelemetry } from '@platformatic/telemetry'
 import { createPinoWritable, ensureLoggableError } from '@platformatic/utils'
+import { collectMetrics } from '@platformatic/metrics'
 import { tracingChannel } from 'node:diagnostics_channel'
 import { once } from 'node:events'
 import { readFile } from 'node:fs/promises'
@@ -81,10 +82,22 @@ export class ChildProcess extends ITC {
   #socket
   #child
   #logger
+  #metricsRegistry
   #pendingMessages
 
   constructor () {
-    super({ throwOnMissingHandler: false, name: `${process.env.PLT_MANAGER_ID}-child-process` })
+    super({
+      throwOnMissingHandler: false,
+      name: `${process.env.PLT_MANAGER_ID}-child-process`,
+      handlers: {
+        collectMetrics: (...args) => {
+          return this.#collectMetrics(...args)
+        },
+        getMetrics: (...args) => {
+          return this.#getMetrics(...args)
+        },
+      }
+    })
 
     /* c8 ignore next */
     const protocol = platform() === 'win32' ? 'ws+unix:' : 'ws+unix://'
@@ -152,6 +165,21 @@ export class ChildProcess extends ITC {
     this.#socket.close()
   }
 
+  async #collectMetrics ({ serviceId, metricsConfig }) {
+    const { registry } = await collectMetrics(serviceId, metricsConfig)
+    this.#metricsRegistry = registry
+  }
+
+  async #getMetrics ({ format } = {}) {
+    if (!this.#metricsRegistry) return null
+
+    const res = format === 'json'
+      ? await this.#metricsRegistry.getMetricsAsJSON()
+      : await this.#metricsRegistry.metrics()
+
+    return res
+  }
+
   #setupLogger () {
     // Since this is executed by user code, make sure we only override this in the main thread
     // The rest will be intercepted by the BaseStackable.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "2.5.4",
+  "version": "2.5.5-alpha.2",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -23,10 +23,11 @@
     "split2": "^4.2.0",
     "undici": "^6.19.5",
     "ws": "^8.18.0",
-    "@platformatic/config": "2.5.4",
-    "@platformatic/itc": "2.5.4",
-    "@platformatic/telemetry": "2.5.4",
-    "@platformatic/utils": "2.5.4"
+    "@platformatic/config": "2.5.5-alpha.2",
+    "@platformatic/telemetry": "2.5.5-alpha.2",
+    "@platformatic/itc": "2.5.5-alpha.2",
+    "@platformatic/metrics": "2.5.5-alpha.2",
+    "@platformatic/utils": "2.5.5-alpha.2"
   },
   "devDependencies": {
     "borp": "^0.17.0",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/basic/2.5.4.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/basic/2.5.5-alpha.2.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Stackable",
   "type": "object",