swagger-stats-ext
More Features
call init manually
import * as swStats from 'swagger-stats-ext'
swStats.init(promConf)
koa middleware, not use express-to-koa
import * as swStats from 'swagger-stats-ext'
const app = new Koa()
app.use(swStats.koaMiddleware())
report calls bewtween modules based on http protocol manually
add metric data for prometheus, "mcall_request_total" labeled
# HELP mcall_request_total The total number of all mcall based on http protocol requests
# TYPE mcall_request_total counter
mcall_request_total{service="user",method="GET",path="/info/get",http_status_code="400",code="0"} 1
import * as swStats from 'swagger-stats-ext'
swStats.reportMCall('user', 'GET', '/info/get', 200, 0)
params for reportMCall
name | optional | default | comments |
---|---|---|---|
service | N | module name | |
method | N | http method(GET/POST) | |
path | N | http path | |
http_code | N | http status code | |
code | Y | 0 | code returned by module |
more settings
const promConf = {
pm2: false, // use pm2 for node server
pathProm: '/prometheus', // add route like: "ip:port/{pathProm}",return prometheus metrics data
// ...
}