If my app is running in cluster mode (via cluster module or PM2), every time I call the /metrics endpoint I'll get data from a different process, without the possibility to have the "general picture". Am I missing something?

Thanks

My web application has around ~80~ 1000 endpoints, so the API Responses page is unresponsive because of too many charts, making the page unusable.

What would be the best way to address this issue in Swagger Stats UI. Something that comes in my mind:

• Pagination for API Responses charts
• Virtualization, virtual scroll
• Divide into multiple routes/pages for each endpoint, just like API Operations

I would like to discuss if we want to fix this. I am able to contribute to fixing this with a PR, once we agreed on the solution.

We recently noticed that swagger-stats appears to be missing some requests in the exposed swagger-stats/metrics route. The application in question is using Open API using express-openapi. We also have metrics for the HA proxies fronting the application as well as a bunyan middleware logging all requests within the same application that happens to also report request-finish events along with a status code.

Looking at the latest metrics, we see a little over 1.7M 200s and 100K 401s being reported by HA proxy, whereas swagger-stats is reporting a little less than 700K 200s and only 282 401s. The logs being written to by the bunyan middleware match what HA proxy is reporting.

We are looking specifically at the api_request_total metrics.

Our package versions are:

{
  "bunyan": "^1.8.12",
  "bunyan-middleware": "^1.0.0",
  "express": "^4.17.1",
  "express-async-handler": "^1.1.4",
  "express-openapi": "^6.0.0",
  "swagger-stats": "^0.95.17",
}

We are configuring the swagger-stats middleware as follows:

app.use(
  swStats.getMiddleware({
    swaggerSpec: apiDoc,
    swaggerOnly: true,
    authentication: true,
    onAuthenticate: (req, username, password) => {
        // check auth for metrics
    })
  })
);

In case that helps here is how we are configuring the bunyan middleware:

app.use(
  bunyanMiddleware({
    obscureHeaders: [],
    logger,
    requestStart: true,
  })
);

We are using version 12.16.2 of Node.js.

The application where swagger-stats is installed has been running for 10 days straight without a restart so we don't believe this is due to stats being reset due to a restart.

The issue is also not that some routes are not in the swagger definition and therefore not being kept track of as we do see some metrics for all routes, just nowhere near as many as we would expect to see.

The swagger-stats/metrics route is being scrapped by Prometheus against the application directly as opposed to going through HA Proxy so we also do not believe that is to blame for the discrepancies, nor would that explain the difference in 401s we are seeing.

We are at a loss as to why swagger-stats appears to be missing so many requests.

Any help tracking this down would be appreciated.

In the root directory of my nodejs application, I installed swagger-stats using

npm install swagger-stats --save Then, in my app.js file, I required the following 3 lines: var swStats = require('swagger-stats'); var apiSpec = require('swagger.json'); app.use(swStats.getMiddleware({swaggerSpec:apiSpec}));

But I get this error:

`internal/modules/cjs/loader.js:582 throw err; ^

Error: Cannot find module 'swagger.json' at Function.Module._resolveFilename (internal/modules/cjs/loader.js:580:15) at Function.Module._load (internal/modules/cjs/loader.js:506:25) at Module.require (internal/modules/cjs/loader.js:636:17) at require (internal/modules/cjs/helpers.js:20:18) at Object. (/home/p11p3/Desktop/mydir/app.js:9:15) at Module._compile (internal/modules/cjs/loader.js:688:30) at Object.Module._extensions..js (internal/modules/cjs/loader.js:699:10) at Module.load (internal/modules/cjs/loader.js:598:32) at tryModuleLoad (internal/modules/cjs/loader.js:537:12) at Function.Module._load (internal/modules/cjs/loader.js:529:3) `

I'm using node version v10.12.0

Please tell me what needs to be done.

Hello!

If I create a swagger doc to track specific URL, let's give an example I want to track

/iwanttotrack/certainIssue

But this URL falls under a routing system that does

/iwanttotrack/:issue

As of now, swagger-stats tracks both. Is there a way that I can prevent the tracking of the latter route and only track the specific URL that I want it to track?

Thanks!

Hi,

i'm trying to install swagger stats but i get this error when i start the app:

/src/node_modules/prom-client/lib/gauge.js:219
                        throw new TypeError(Value is not a valid number: ${util.format(value)});
                        ^

TypeError: Value is not a valid number: undefined
    at /src/node_modules/prom-client/lib/gauge.js:219:10
    at Gauge.set (/src/node_modules/prom-client/lib/gauge.js:85:31)
    at swsCoreStats.calculateSystemStats (/src/node_modules/swagger-stats/lib/swsCoreStats.js:151:65)
    at swsCoreStats.tick (/src/node_modules/swagger-stats/lib/swsCoreStats.js:121:10)
    at Timeout.swsProcessor.tick (/src/node_modules/swagger-stats/lib/swsProcessor.js:137:20)
    at Timeout.ontimeout [as _repeat] (timers.js:400:34)
    at Timeout.wrapper [as _onTimeout] (timers.js:425:11)
    at tryOnTimeout (timers.js:232:11)
    at Timer.listOnTimeout (timers.js:202:5)

This is the line #151 of swsCoreStats.js: this.promClientMetrics.nodejs_process_memory_external_bytes.set(this.sys.external);

This is this.sys content:

  rss: 95752192,
  heapTotal: 75632640,
  heapUsed: 46559352,
  external: undefined,
  cpu: 26.9837199868224

And this is the result of process.memoryUsage():

{ rss: 95752192, heapTotal: 75632640, heapUsed: 46559352 }

The external property is missing.

I'm adding swagger-stats as a middleware in Fastify. So I guess this whole thing is tricky.

Reproducing the Fastify example in docs didn't work at all as it messed with other Fastify plugins (mongo and others).

But anyway, I tried the encapsulation and it didn't show any errors, so I think the Fastify part of this is fine,

const swagger = require('./config/options/swagger')
fastify.register(require('fastify-swagger'), swagger.options)
fastify.register(setSwaggerStats)

with

const swStats = require('swagger-stats')
const apiSpec = require('./swagger.json')
async function setSwaggerStats(fastify, opts) {
    await fastify.register(require('middie')) // or fastify-express is the same
    fastify.register(swStats.getFastifyPlugin, { swaggerSpec: apiSpec });
}

I also installed prom-client although I will be happy with the native dashboard.

http://localhost:3000/swagger-stats/ http://localhost:3000/swagger-stats/ui didn't show up (404)

It would be nice to provide {debug: true} option with some errors logged if this is feasible.

Thanks a lot !!!

Maybe it will be good to add docs, how to use swagger-stats with Nest.js? It has specific library-plugin for this - https://docs.nestjs.com/recipes/swagger .

  const document = SwaggerModule.createDocument(app, options);

document here is JS object - swagger 2.0 .

app.js: const app = require('koa')(); const api = require('koa-router')(); var swStats = require('swagger-stats'); app.use(swStats.getMiddleware({}));

log： AssertionError: app.use() requires a generator function

So far I'm very impressed, thanks for all the hard work!

Correct me if I'm wrong, but I see 2 big issues with the project at the moment:

1. Functionality is limited to 1 instance, there is no aggregated data. In modern applications 1 node is usually not enough.

2. Data is saved in memory and therefore gets deleted upon application restart, saving data in a database (PostgreSQL; MySQL) will increase the usability of the product by a lot and will also allow issue no. 1 to be solved more easily.

Are these things being considered?

After running npm update and thus upgrading swagger-stats to the latest release I now get the following error when accessing /metrics. It seems to me like a dependency issue on your end, but according to Stackoverflow replacing .end with .send might already solve this issue. Reverting back to 0.95.18 did not solve the issue.

UnhandledPromiseRejectionWarning: TypeError [ERR_INVALID_ARG_TYPE]: The "chunk" argument must be of type string or an instance of Buffer. Received an instance of Promise
    at ServerResponse.end (_http_outgoing.js:759:13)
    at /usr/src/app/node_modules/swagger-stats/lib/swsInterface.js:212:13
    at runMicrotasks (<anonymous>)
    at processTicksAndRejections (internal/process/task_queues.js:97:5)

Running /metrics results in a timeout which breaks prometheus/grafana integrations.

Bumps fastify from 4.10.2 to 4.11.0.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps prom-client from 14.1.0 to 14.1.1.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps supertest from 6.3.2 to 6.3.3.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps mocha from 10.1.0 to 10.2.0.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

I use swagger-jsdoc to document routes on my app. Those defined by me are standalone and easy to define. However, swagger-stats makes it challenging for me to provide a description for routes info, health, and metrics on route /swagger. How can I do it in a neat way?

I use swagger-stats in WSL2, when call constructor there is an error Error: EMFILE: too many open files, uv_resident_set_memory at process.memoryUsage (internal/process/per_thread.js:153:5) at SwsSysStats.calculateSystemStats (/home/tuan1998/aura-sync/crawl-system/node_modules/swagger-stats/lib/swssysstats.js:83:32) at SwsSysStats.tick (/home/tuan1998/aura-sync/crawl-system/node_modules/swagger-stats/lib/swssysstats.js:77:14) at Timeout.tick [as _onTimeout] (/home/tuan1998/aura-sync/crawl-system/node_modules/swagger-stats/lib/swsProcessor.js:126:23) at listOnTimeout (internal/timers.js:557:17) at processTimers (internal/timers.js:498:7) { errno: -24, code: 'EMFILE', syscall: 'uv_resident_set_memory' }

It should be has a try catch outside this statement let memUsage = process.memoryUsage();