@platformatic/service 1.29.0 → 1.31.0

package/config.d.ts

@@ -145,7 +145,7 @@ export interface PlatformaticService {
         port?: number | string;
         hostname?: string;
         endpoint?: string;
-        server?: "own" | "parent";
+        server?: "own" | "parent" | "hide";
         defaultMetrics?: {
           enabled: boolean;
         };

package/lib/plugins/metrics.js

@@ -104,16 +104,25 @@ const metricsPlugin = fp(async function (app, opts = {}) {
     })
   }
 
+  function cleanMetrics () {
+    const metrics = app.metrics.client.register._metrics
+    for (const metricName in metrics) {
+      if (defaultMetrics.enabled || metricName.startsWith(prefix)) {
+        delete metrics[metricName]
+      }
+    }
+  }
+
   let isRestarting = false
   app.addHook('onReady', async () => {
     app.addPreRestartHook(async () => {
       isRestarting = true
-      app.metrics.client.register.clear()
+      cleanMetrics()
     })
   })
   app.addHook('onClose', async () => {
     if (!isRestarting) {
-      app.metrics.client.register.clear()
+      cleanMetrics()
     }
   })
 }, {
@@ -177,38 +186,41 @@ module.exports = fp(async function (app, opts) {
     await closeMetricsServer()
   }
 
-  let onRequestHook
-  if (auth) {
-    const { username, password } = auth
+  if (server !== 'hide') {
+    let onRequestHook
+    if (auth) {
+      const { username, password } = auth
+
+      await metricsServer.register(require('@fastify/basic-auth'), {
+        validate: function (user, pass, req, reply, done) {
+          if (username !== user || password !== pass) {
+            return reply.code(401).send({ message: 'Unauthorized' })
+          }
+          return done()
+        }
+      })
+      onRequestHook = metricsServer.basicAuth
+    }
 
-    await metricsServer.register(require('@fastify/basic-auth'), {
-      validate: function (user, pass, req, reply, done) {
-        if (username !== user || password !== pass) {
-          return reply.code(401).send({ message: 'Unauthorized' })
+    metricsServer.register(require('@fastify/accepts'))
+
+    metricsServer.route({
+      url: metricsEndpoint,
+      method: 'GET',
+      logLevel: 'warn',
+      onRequest: onRequestHook,
+      handler: async (req, reply) => {
+        const promRegistry = app.metrics.client.register
+        const accepts = req.accepts()
+        if (!accepts.type('text/plain') && accepts.type('application/json')) {
+          return promRegistry.getMetricsAsJSON()
         }
-        return done()
+        reply.type('text/plain')
+        return promRegistry.metrics()
       }
     })
-    onRequestHook = metricsServer.basicAuth
   }
 
-  metricsServer.register(require('@fastify/accepts'))
-  metricsServer.route({
-    url: metricsEndpoint,
-    method: 'GET',
-    logLevel: 'warn',
-    onRequest: onRequestHook,
-    handler: async (req, reply) => {
-      const promRegistry = app.metrics.client.register
-      const accepts = req.accepts()
-      if (!accepts.type('text/plain') && accepts.type('application/json')) {
-        return promRegistry.getMetricsAsJSON()
-      }
-      reply.type('text/plain')
-      return promRegistry.metrics()
-    }
-  })
-
   if (server === 'own') {
     await metricsServer.ready()
   }

package/lib/schema.js

@@ -558,7 +558,7 @@ const metrics = {
         endpoint: { type: 'string' },
         server: {
           type: 'string',
-          enum: ['own', 'parent']
+          enum: ['own', 'parent', 'hide']
         },
         defaultMetrics: {
           type: 'object',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "1.29.0",
+  "version": "1.31.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -78,13 +78,13 @@
     "semgrator": "^0.3.0",
     "ua-parser-js": "^1.0.37",
     "undici": "^6.9.0",
-    "@platformatic/authenticate": "1.29.0",
-    "@platformatic/config": "1.29.0",
-    "@platformatic/client": "1.29.0",
-    "@platformatic/scalar-theme": "1.29.0",
-    "@platformatic/generators": "1.29.0",
-    "@platformatic/telemetry": "1.29.0",
-    "@platformatic/utils": "1.29.0"
+    "@platformatic/authenticate": "1.31.0",
+    "@platformatic/client": "1.31.0",
+    "@platformatic/generators": "1.31.0",
+    "@platformatic/config": "1.31.0",
+    "@platformatic/scalar-theme": "1.31.0",
+    "@platformatic/telemetry": "1.31.0",
+    "@platformatic/utils": "1.31.0"
   },
   "standard": {
     "ignore": [

package/schema.json

@@ -1,6 +1,6 @@
 {
-  "$id": "https://platformatic.dev/schemas/v1.29.0/service",
-  "version": "1.29.0",
+  "$id": "https://platformatic.dev/schemas/v1.31.0/service",
+  "version": "1.31.0",
   "title": "Platformatic Service",
   "type": "object",
   "properties": {
@@ -613,7 +613,8 @@
               "type": "string",
               "enum": [
                 "own",
-                "parent"
+                "parent",
+                "hide"
               ]
             },
             "defaultMetrics": {