@platformatic/watt-extra 0.1.8-alpha.0 → 0.1.9

package/.github/workflows/test.yml

@@ -41,7 +41,7 @@ jobs:
           version: 10
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v5
         with:
           node-version: ${{ matrix.node-version }}
           # https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#use-private-packages

package/lib/watt.js

@@ -201,6 +201,7 @@ class Watt {
         applicationId: this.#instanceConfig?.applicationId,
         instanceId: this.#instanceId,
       },
+      applicationLabel: this.#instanceConfig?.applicationMetricsLabel ?? 'serviceId'
     }
 
     if (this.#env.PLT_DISABLE_FLAMEGRAPHS !== true) {
@@ -251,11 +252,11 @@ class Watt {
   }
 
   #getTrafficInterceptorConfig () {
-    if (!this.#instanceConfig?.iccServices?.trafficante?.url) {
+    if (!this.#instanceConfig?.iccServices?.trafficInspector?.url) {
       return
     }
-    const { origin: trafficanteOrigin, pathname: trafficantePath } = new URL(
-      this.#instanceConfig.iccServices.trafficante.url
+    const { origin: trafficInspectorOrigin, pathname: trafficInspectorPath } = new URL(
+      this.#instanceConfig.iccServices.trafficInspector.url
     )
     return {
       module: require.resolve(
@@ -271,9 +272,9 @@ class Watt {
         },
         maxResponseSize: 5 * 1024 * 1024, // 5MB
         trafficInspectorOptions: {
-          url: trafficanteOrigin,
-          pathSendBody: join(trafficantePath, '/requests'),
-          pathSendMeta: join(trafficantePath, '/requests/hash'),
+          url: trafficInspectorOrigin,
+          pathSendBody: join(trafficInspectorPath, '/requests'),
+          pathSendMeta: join(trafficInspectorPath, '/requests/hash'),
         },
         matchingDomains: [this.#env.PLT_APP_INTERNAL_SUB_DOMAIN],
       },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/watt-extra",
-  "version": "0.1.8-alpha.0",
+  "version": "0.1.9",
   "description": "The Platformatic runtime manager",
   "type": "module",
   "scripts": {
@@ -13,25 +13,25 @@
   },
   "devDependencies": {
     "@fastify/websocket": "^11.1.0",
-    "@platformatic/composer": "^3.0.5",
-    "@platformatic/next": "^3.0.5",
-    "@platformatic/node": "^3.0.5",
-    "@platformatic/service": "^3.0.5",
+    "@platformatic/composer": "^3.3.0",
+    "@platformatic/next": "^3.3.0",
+    "@platformatic/node": "^3.3.0",
+    "@platformatic/service": "^3.3.0",
     "borp": "^0.20.0",
     "eslint": "9",
     "fastify": "^5.4.0",
     "fastify-plugin": "^5.0.1",
     "neostandard": "^0.12.0",
     "next": "^15.3.4",
-    "platformatic": "^3.0.5",
+    "platformatic": "^3.3.0",
     "pprof-format": "^2.1.0",
     "why-is-node-running": "^2.3.0"
   },
   "dependencies": {
     "@datadog/pprof": "^5.9.0",
     "@fastify/error": "^4.2.0",
-    "@platformatic/runtime": "^3.0.5",
-    "@platformatic/wattpm-pprof-capture": "^3.0.5",
+    "@platformatic/runtime": "^3.3.0",
+    "@platformatic/wattpm-pprof-capture": "^3.3.0",
     "avvio": "^9.1.0",
     "chalk": "^4.1.2",
     "commist": "^3.2.0",

package/plugins/alerts.js

@@ -4,6 +4,10 @@ async function alerts (app, _opts) {
   const healthCache = [] // It's OK to have this in memory, this is per-pod.
   const podHealthWindow =
     app.instanceConfig?.config?.scaler?.podHealthWindow || 60 * 1000
+  const alertRetentionWindow =
+    app.instanceConfig?.config?.scaler?.alertRetentionWindow || 10 * 1000
+
+  const lastServicesAlertTime = {}
 
   async function setupAlerts () {
     // Skip alerts setup if ICC is not configured
@@ -62,6 +66,17 @@ async function alerts (app, _opts) {
       // }
 
       if (healthInfo.unhealthy) {
+        const currentTime = Date.now()
+
+        const serviceId = healthInfo.id
+        const lastAlertTime = lastServicesAlertTime[serviceId]
+
+        if (lastAlertTime && currentTime - lastAlertTime < alertRetentionWindow) {
+          app.log.debug('Skipping alert, within retention window')
+          return
+        }
+
+        lastServicesAlertTime[serviceId] = currentTime
         delete healthInfo.healthConfig
 
         const authHeaders = await app.getAuthorizationHeader()
@@ -86,7 +101,6 @@ async function alerts (app, _opts) {
         }
 
         const alert = await body.json()
-        const serviceId = healthInfo.id
 
         try {
           await app.sendFlamegraphs({

package/plugins/compliancy.js

@@ -60,7 +60,7 @@ async function compliancy (app, _opts) {
       const { compliant, report } = JSON.parse(res.body)
 
       if (!compliant) {
-        app.log.error(report, 'Compliancy check failed')
+        app.log.warn(report, 'Compliancy check failed')
       }
     }
   }

package/test/alerts.test.js

@@ -327,6 +327,94 @@ test('should not fail when health info is missing', async (t) => {
   assert.strictEqual(alertReceived, null, 'No alert should have been received')
 })
 
+test('should respect alert retention window', async (t) => {
+  const applicationName = 'test-app'
+  const applicationId = randomUUID()
+  const applicationPath = join(__dirname, 'fixtures', 'service-1')
+
+  const alertsReceived = []
+
+  const getAuthorizationHeader = async (headers) => {
+    return { ...headers, authorization: 'Bearer test-token' }
+  }
+
+  const icc = await startICC(t, {
+    applicationId,
+    applicationName,
+    iccConfig: {
+      scaler: {
+        alertRetentionWindow: 500
+      }
+    },
+    processAlerts: (req) => {
+      const alert = req.body
+      assert.equal(req.headers.authorization, 'Bearer test-token')
+      alertsReceived.push(alert)
+      return { id: 'test-alert-id', ...alert }
+    }
+  })
+
+  setUpEnvironment({
+    PLT_APP_NAME: applicationName,
+    PLT_APP_DIR: applicationPath,
+    PLT_ICC_URL: 'http://127.0.0.1:3000'
+  })
+
+  const app = await start()
+
+  app.getAuthorizationHeader = getAuthorizationHeader
+
+  await app.setupAlerts()
+
+  t.after(async () => {
+    await app.close()
+    await icc.close()
+  })
+
+  // Create a health info template
+  const createHealthInfo = (serviceId, unhealthy = true) => ({
+    id: serviceId,
+    service: serviceId,
+    currentHealth: {
+      elu: unhealthy ? 0.95 : 0.5,
+      heapUsed: 76798040,
+      heapTotal: 99721216
+    },
+    unhealthy,
+    healthConfig: {
+      enabled: true,
+      interval: 1000,
+      gracePeriod: 1000,
+      maxUnhealthyChecks: 10,
+      maxELU: 0.99,
+      maxHeapUsed: 0.99,
+      maxHeapTotal: 4294967296
+    }
+  })
+
+  // Send first unhealthy event - should trigger alert
+  app.watt.runtime.emit('application:worker:health', createHealthInfo('service-1', true))
+  await sleep(50)
+
+  // Send second unhealthy event immediately - should trigger alert
+  app.watt.runtime.emit('application:worker:health', createHealthInfo('service-2', true))
+  await sleep(50)
+
+  // Send second unhealthy event immediately - should be ignored due to retention window
+  app.watt.runtime.emit('application:worker:health', createHealthInfo('service-1', true))
+  await sleep(100)
+
+  assert.strictEqual(alertsReceived.length, 2, 'Only one alert should be sent within retention window')
+
+  await sleep(500)
+
+  // Send third unhealthy event - should trigger second alert
+  app.watt.runtime.emit('application:worker:health', createHealthInfo('service-1', true))
+  await sleep(100)
+
+  assert.strictEqual(alertsReceived.length, 3, 'Second alert should be sent after retention window expires')
+})
+
 test('should not set up alerts when scaler URL is missing', async (t) => {
   const applicationName = 'test-app'
   const applicationId = randomUUID()

package/test/auto-cache.test.js

@@ -128,7 +128,7 @@ test('should spawn an app with auto caching', async (t) => {
     assert.strictEqual(headers['x-foo-bar'], undefined)
     assert.strictEqual(headers['x-custom-cache-tags'], undefined)
 
-    // Wait for interceptor to send data to the Trafficante
+    // Wait for interceptor to send data to the Traffic Inspector
     await sleep(1000)
 
     assert.strictEqual(savedRequestHashes.length, 1)

package/test/helper.js

@@ -34,6 +34,7 @@ async function startICC (t, opts = {}) {
   let {
     applicationId,
     applicationName,
+    applicationMetricsLabel,
     iccServices,
     iccConfig = {},
     enableOpenTelemetry = false,
@@ -46,8 +47,8 @@ async function startICC (t, opts = {}) {
     riskEngine: {
       url: 'http://127.0.0.1:3000/risk-service'
     },
-    trafficante: {
-      url: 'http://127.0.0.1:3000/trafficante'
+    trafficInspector: {
+      url: 'http://127.0.0.1:3000/traffic-inspector'
     },
     compliance: {
       url: 'http://127.0.0.1:3000/compliance'
@@ -108,6 +109,7 @@ async function startICC (t, opts = {}) {
       return controlPlaneResponse || {
         applicationId,
         applicationName,
+        applicationMetricsLabel,
         iccServices,
         config: iccConfig,
         enableOpenTelemetry,
@@ -143,7 +145,7 @@ async function startICC (t, opts = {}) {
     })
   }, { prefix: '/compliance' })
 
-  // Trafficante
+  // Traffic Inspector
   await icc.register(async (icc) => {
     icc.post('/requests/hash', async (req) => {
       const { taxonomyId, applicationId } = JSON.parse(req.headers['x-labels'])
@@ -159,7 +161,7 @@ async function startICC (t, opts = {}) {
 
       opts.saveRequest?.({ taxonomyId, applicationId, request, response })
     })
-  }, { prefix: '/trafficante' })
+  }, { prefix: '/traffic-inspector' })
 
   // Risk Service
   await icc.register(async (icc) => {

package/test/init.test.js

@@ -63,7 +63,7 @@ test('init plugin with optional PLT_APP_NAME - uses ICC response', async (t) =>
       applicationName, // ICC returns the application name
       iccServices: {
         riskEngine: { url: 'http://127.0.0.1:3000/risk-service' },
-        trafficante: { url: 'http://127.0.0.1:3000/trafficante' },
+        trafficInspector: { url: 'http://127.0.0.1:3000/traffic-inspector' },
         compliance: { url: 'http://127.0.0.1:3000/compliance' },
         cron: { url: 'http://127.0.0.1:3000/cron' },
         scaler: { url: 'http://127.0.0.1:3000/scaler' }
@@ -166,7 +166,7 @@ test('init plugin sends correct request structure when PLT_APP_NAME provided', a
         applicationName,
         iccServices: {
           riskEngine: { url: 'http://127.0.0.1:3000/risk-service' },
-          trafficante: { url: 'http://127.0.0.1:3000/trafficante' },
+          trafficInspector: { url: 'http://127.0.0.1:3000/traffic-inspector' },
           compliance: { url: 'http://127.0.0.1:3000/compliance' },
           cron: { url: 'http://127.0.0.1:3000/cron' },
           scaler: { url: 'http://127.0.0.1:3000/scaler' }
@@ -212,7 +212,7 @@ test('init plugin sends request without applicationName when not provided', asyn
         applicationName, // ICC provides the name
         iccServices: {
           riskEngine: { url: 'http://127.0.0.1:3000/risk-service' },
-          trafficante: { url: 'http://127.0.0.1:3000/trafficante' },
+          trafficInspector: { url: 'http://127.0.0.1:3000/traffic-inspector' },
           compliance: { url: 'http://127.0.0.1:3000/compliance' },
           cron: { url: 'http://127.0.0.1:3000/cron' },
           scaler: { url: 'http://127.0.0.1:3000/scaler' }

package/test/metrics.test.js

@@ -0,0 +1,107 @@
+import assert from 'node:assert'
+import { test } from 'node:test'
+import { randomUUID } from 'node:crypto'
+import { request } from 'undici'
+import { join, dirname } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { setUpEnvironment, startICC } from './helper.js'
+import { start } from '../index.js'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+test('should generate metrics with a correct labels', async (t) => {
+  const applicationName = 'test-app'
+  const applicationId = randomUUID()
+  const applicationPath = join(__dirname, 'fixtures', 'service-1')
+
+  const icc = await startICC(t, {
+    applicationId,
+    applicationName
+  })
+
+  process.env.PLT_TEST_APP_1_URL = 'http://test-app-1:3042'
+  t.after(() => {
+    delete process.env.PLT_TEST_APP_1_URL
+  })
+
+  setUpEnvironment({
+    PLT_APP_NAME: applicationName,
+    PLT_APP_DIR: applicationPath,
+    PLT_ICC_URL: 'http://127.0.0.1:3000',
+  })
+
+  const app = await start()
+
+  t.after(async () => {
+    await app.close()
+    await icc.close()
+  })
+
+  const { statusCode, body } = await request('http://127.0.0.1:9090/metrics', {
+    headers: {
+      accept: 'application/json',
+    }
+  })
+  assert.strictEqual(statusCode, 200)
+
+  const metrics = await body.json()
+
+  {
+    const eluMetrics = metrics.find((metric) => metric.name === 'nodejs_eventloop_utilization')
+    assert.ok(eluMetrics)
+
+    const labels = eluMetrics.values[0].labels
+    assert.strictEqual(labels.applicationId, applicationId)
+    assert.strictEqual(labels.serviceId, 'main')
+  }
+})
+
+test('should generate metrics with a custom metrics label', async (t) => {
+  const applicationName = 'test-app'
+  const applicationId = randomUUID()
+  const applicationPath = join(__dirname, 'fixtures', 'service-1')
+  const applicationMetricsLabel = 'customLabel'
+
+  const icc = await startICC(t, {
+    applicationId,
+    applicationName,
+    applicationMetricsLabel
+  })
+
+  process.env.PLT_TEST_APP_1_URL = 'http://test-app-1:3042'
+  t.after(() => {
+    delete process.env.PLT_TEST_APP_1_URL
+  })
+
+  setUpEnvironment({
+    PLT_APP_NAME: applicationName,
+    PLT_APP_DIR: applicationPath,
+    PLT_ICC_URL: 'http://127.0.0.1:3000',
+  })
+
+  const app = await start()
+
+  t.after(async () => {
+    await app.close()
+    await icc.close()
+  })
+
+  const { statusCode, body } = await request('http://127.0.0.1:9090/metrics', {
+    headers: {
+      accept: 'application/json',
+    }
+  })
+  assert.strictEqual(statusCode, 200)
+
+  const metrics = await body.json()
+
+  {
+    const eluMetrics = metrics.find((metric) => metric.name === 'nodejs_eventloop_utilization')
+    assert.ok(eluMetrics)
+
+    const labels = eluMetrics.values[0].labels
+    assert.strictEqual(labels.applicationId, applicationId)
+    assert.strictEqual(labels[applicationMetricsLabel], 'main')
+  }
+})

package/test/patch-config.test.js

@@ -80,6 +80,7 @@ test('should spawn a service app settings labels for metrics', async (t) => {
       instanceId: app.instanceId,
       applicationId,
     },
+    applicationLabel: 'serviceId'
   }
   assert.deepStrictEqual(metrics, expectedMetrics)
 })

package/pnpm-workspace.yaml

@@ -1,2 +0,0 @@
-ignoredBuiltDependencies:
-  - better-sqlite3