{"_id":"@trussle/tricorder","_rev":"113-84c9b9dc3fe2c178bd42a40e27e3bf63","name":"@trussle/tricorder","dist-tags":{"beta":"1.0.0-beta01","latest":"1.0.2"},"versions":{"1.0.0-beta01":{"name":"@trussle/tricorder","version":"1.0.0-beta01","keywords":["Prometheus","Express","Node","Middleware"],"author":{"name":"Trussle"},"license":"MIT","_id":"@trussle/tricorder@1.0.0-beta01","maintainers":[{"name":"bengladman","email":"ben@trussle.com"},{"name":"chiaratrussle","email":"chiara@trussle.com"},{"name":"chronojam-trussle","email":"calum@trussle.com"},{"name":"daniele.rapati.trussle","email":"daniele.rapati@trussle.com"},{"name":"daningrey","email":"daniel@trussle.com"},{"name":"jonnyarnold","email":"jonny.arnold89@gmail.com"},{"name":"jonnywildey","email":"jonnywildey@gmail.com"},{"name":"josephn","email":"joseph@josephn.net"},{"name":"pete-trussle","email":"pete@trussle.com"},{"name":"stickupkid","email":"stickupkid@gmail.com"},{"name":"timreynolds","email":"tim@timothyreynolds.co.uk"},{"name":"trussle-admin","email":"team@trussle.com"},{"name":"vickyy","email":"vicky.lee@trussle.com"}],"homepage":"https://github.com/trussle/tricorder#readme","bugs":{"url":"https://github.com/trussle/tricorder/issues"},"dist":{"shasum":"bcbe3274618459ff85b24b19f8692fd5789c0e7c","tarball":"https://registry.npmjs.org/@trussle/tricorder/-/tricorder-1.0.0-beta01.tgz","fileCount":6,"integrity":"sha512-c0/WbBRxflembs0bzZT5lRJCLoooEZSs6KNBojatGuNlbDLQG0s1hTKRLuXXiLoMbiXfmpnDGWWOKuOZ6kyRAQ==","signatures":[{"sig":"MEYCIQDgP5hD7JUVoBk8RJwQtoyx06AOFPslNUEHHcaV2ZCcUQIhAO2Rvb/7ew/fnLRz8uVJR/6zHasDudc/GY9yqNKcXEAq","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11553},"main":"lib/index.js","gitHead":"4ca593bb816118a305b34773bffec4dae9cc53f3","scripts":{"lint":"eslint lib/**/*.js","test":"jest --env=node .","lint:fix":"prettier --write lib/**/*.js","postversion":"git push --tags"},"_npmUser":{"name":"timreynolds","email":"tim@timothyreynolds.co.uk"},"repository":{"url":"git+https://github.com/trussle/tricorder.git","type":"git"},"_npmVersion":"5.6.0","description":"Express middleware to provide basic metrics to Prometheus","directories":{},"_nodeVersion":"6.11.5","dependencies":{"prom-client":"^10.2.2","prometheus-gc-stats":"^0.5.0"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^22.3.0","husky":"^0.14.3","eslint":"^4.18.0","express":"^4.16.2","prettier":"1.10.2","supertest":"^3.0.0","eslint-config-prettier":"^2.9.0"},"_npmOperationalInternal":{"tmp":"tmp/tricorder_1.0.0-beta01_1519054388236_0.4756478752881619","host":"s3://npm-registry-packages"}},"1.0.0-beta02":{"name":"@trussle/tricorder","version":"1.0.0-beta02","keywords":["Prometheus","Express","Node","Middleware"],"author":{"name":"Trussle"},"license":"MIT","_id":"@trussle/tricorder@1.0.0-beta02","maintainers":[{"name":"bengladman","email":"ben@trussle.com"},{"name":"chiaratrussle","email":"chiara@trussle.com"},{"name":"chronojam-trussle","email":"calum@trussle.com"},{"name":"daniele.rapati.trussle","email":"daniele.rapati@trussle.com"},{"name":"daningrey","email":"daniel@trussle.com"},{"name":"jonnyarnold","email":"jonny.arnold89@gmail.com"},{"name":"jonnywildey","email":"jonnywildey@gmail.com"},{"name":"josephn","email":"joseph@josephn.net"},{"name":"pete-trussle","email":"pete@trussle.com"},{"name":"stickupkid","email":"stickupkid@gmail.com"},{"name":"timreynolds","email":"tim@timothyreynolds.co.uk"},{"name":"trussle-admin","email":"team@trussle.com"},{"name":"vickyy","email":"vicky.lee@trussle.com"}],"homepage":"https://github.com/trussle/tricorder#readme","bugs":{"url":"https://github.com/trussle/tricorder/issues"},"dist":{"shasum":"22674a37125ec37afb2420e286e3f5cdf405fddb","tarball":"https://registry.npmjs.org/@trussle/tricorder/-/tricorder-1.0.0-beta02.tgz","fileCount":6,"integrity":"sha512-UlkDk59G1lf8vxYrRblkynDBmDVCmA5DC2O5V11OHdbeBaAaoRsCsyK68gajwXHAc5ZlzY7tayyODtid884Fog==","signatures":[{"sig":"MEUCIFu6FiaAUKExnN/s/bbyeeIwYxlrR7FCPImw1Wam6+77AiEAnixJ1O9Tb/Vs5P9vIP89maZ+myIM+7x8XfRtakpkuBU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":13203},"main":"lib/index.js","gitHead":"7c9d7cebbaa9721828c64da1819814803ce93265","scripts":{"lint":"eslint lib/**/*.js","test":"jest --env=node .","lint:fix":"prettier --write lib/**/*.js"},"_npmUser":{"name":"timreynolds","email":"tim@timothyreynolds.co.uk"},"repository":{"url":"git+https://github.com/trussle/tricorder.git","type":"git"},"_npmVersion":"5.6.0","description":"Express middleware to provide basic metrics to Prometheus","directories":{},"_nodeVersion":"6.11.5","dependencies":{"prom-client":"^10.2.2","prometheus-gc-stats":"^0.5.0"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^22.3.0","eslint":"^4.18.0","express":"^4.16.2","prettier":"1.10.2","supertest":"^3.0.0","eslint-config-prettier":"^2.9.0"},"_npmOperationalInternal":{"tmp":"tmp/tricorder_1.0.0-beta02_1519745523854_0.5799297220224398","host":"s3://npm-registry-packages"}},"1.0.0":{"name":"@trussle/tricorder","version":"1.0.0","keywords":["Prometheus","Express","Node","Middleware"],"author":{"name":"Trussle"},"license":"MIT","_id":"@trussle/tricorder@1.0.0","maintainers":[{"name":"bengladman","email":"ben@trussle.com"},{"name":"chiaratrussle","email":"chiara@trussle.com"},{"name":"chronojam-trussle","email":"calum@trussle.com"},{"name":"daniele.rapati.trussle","email":"daniele.rapati@trussle.com"},{"name":"daningrey","email":"daniel@trussle.com"},{"name":"jonnyarnold","email":"jonny.arnold89@gmail.com"},{"name":"jonnywildey","email":"jonnywildey@gmail.com"},{"name":"josephn","email":"joseph@josephn.net"},{"name":"pete-trussle","email":"pete@trussle.com"},{"name":"stickupkid","email":"stickupkid@gmail.com"},{"name":"timreynolds","email":"tim@timothyreynolds.co.uk"},{"name":"trussle-admin","email":"team@trussle.com"},{"name":"vickyy","email":"vicky.lee@trussle.com"}],"homepage":"https://github.com/trussle/tricorder#readme","bugs":{"url":"https://github.com/trussle/tricorder/issues"},"dist":{"shasum":"40bb7e9b78be921b1502fb0a5db2f0d5c04b936d","tarball":"https://registry.npmjs.org/@trussle/tricorder/-/tricorder-1.0.0.tgz","fileCount":6,"integrity":"sha512-jcelSDB5NXPdrksWHNA/ns8iRKdVnqqgxH5Wf7lJgXI3uttaEUqy8yCbO98fMu8dsLO0bh9VZukuEJq2nMbmnQ==","signatures":[{"sig":"MEQCIEsFqdCqvlexMNcCw2+YOligjVL8WHLuckZPHRX+8JuOAiBz1BFngZkezRMXcZh0xVKsbNP2NxWQ1wutxOFzM4rZsg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":13216},"main":"lib/index.js","gitHead":"4564ec6ba4ce68ad8f7592239f23801fcd58020c","private":false,"scripts":{"lint":"eslint lib/**/*.js","test":"jest --env=node .","lint:fix":"prettier --write lib/**/*.js"},"_npmUser":{"name":"timreynolds","email":"tim@timothyreynolds.co.uk"},"repository":{"url":"git+https://github.com/trussle/tricorder.git","type":"git"},"_npmVersion":"5.6.0","description":"Express middleware to provide basic metrics to Prometheus","directories":{},"_nodeVersion":"6.11.5","dependencies":{"prom-client":"^10.2.2","prometheus-gc-stats":"^0.5.0"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^22.3.0","eslint":"^4.18.0","express":"^4.16.2","prettier":"1.10.2","supertest":"^3.0.0","eslint-config-prettier":"^2.9.0"},"_npmOperationalInternal":{"tmp":"tmp/tricorder_1.0.0_1519810619074_0.3141784696011116","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@trussle/tricorder","version":"1.0.1","keywords":["Prometheus","Express","Node","Middleware"],"author":{"name":"Trussle"},"license":"MIT","_id":"@trussle/tricorder@1.0.1","maintainers":[{"name":"bengladman","email":"ben@trussle.com"},{"name":"chiaratrussle","email":"chiara@trussle.com"},{"name":"chronojam-trussle","email":"calum@trussle.com"},{"name":"daniele.rapati.trussle","email":"daniele.rapati@trussle.com"},{"name":"daningrey","email":"daniel@trussle.com"},{"name":"jamietrussle","email":"jamie.thirlwell@trussle.com"},{"name":"jonnyarnold","email":"jonny.arnold89@gmail.com"},{"name":"jonnywildey","email":"jonnywildey@gmail.com"},{"name":"josephn","email":"joseph@josephn.net"},{"name":"pete-trussle","email":"pete@trussle.com"},{"name":"timreynolds","email":"tim@timothyreynolds.co.uk"},{"name":"trussle-admin","email":"team@trussle.com"},{"name":"vickyy","email":"vicky.lee@trussle.com"}],"homepage":"https://github.com/trussle/tricorder#readme","bugs":{"url":"https://github.com/trussle/tricorder/issues"},"dist":{"shasum":"f985745a571fa42514f65fd44766fc11f2de6273","tarball":"https://registry.npmjs.org/@trussle/tricorder/-/tricorder-1.0.1.tgz","fileCount":8,"integrity":"sha512-e10dVrqhl15Lv1KPUwx+VdtXz0G2Z8QcYPrIlunWAzEYUbEy0vSBejMZTXKthTsjrsk5dY43hJ5rbYjTJQLorg==","signatures":[{"sig":"MEUCIHUTFveT1wvHynrx4h74eaWgG1rrcKu2E97MpEfHa+i6AiEAwM3NKAmtQK44yIpVrwBbBECfuQ4ojNwkHy6gMDhqwoE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":14207},"main":"lib/index.js","husky":{"hooks":{"post-version":"git push --tags --no-verify"}},"types":"lib/index.d.ts","gitHead":"447381cbbdab682cdb877a5f62bc97e5f173d95f","private":false,"scripts":{"lint":"eslint lib/**/*.js","test":"jest --env=node .","lint:fix":"prettier --write lib/**/*.js","test:coverage":"jest --env=node --coverage ."},"_npmUser":{"name":"timreynolds","email":"tim@timothyreynolds.co.uk"},"repository":{"url":"git+https://github.com/trussle/tricorder.git","type":"git"},"_npmVersion":"5.6.0","description":"Express middleware to provide basic metrics to Prometheus","directories":{},"_nodeVersion":"6.11.5","dependencies":{"prom-client":"^10.2.2","@types/express":"^4.11.1","prometheus-gc-stats":"^0.5.0"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^22.3.0","husky":"^0.14.3","eslint":"^4.18.0","express":"^4.16.2","prettier":"1.10.2","coveralls":"^3.0.0","supertest":"^3.0.0","eslint-config-prettier":"^2.9.0"},"_npmOperationalInternal":{"tmp":"tmp/tricorder_1.0.1_1521199288722_0.9095283451019829","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@trussle/tricorder","version":"1.0.2","keywords":["Prometheus","Express","Node","Middleware"],"author":{"name":"Trussle"},"license":"MIT","_id":"@trussle/tricorder@1.0.2","maintainers":[{"name":"beauallison","email":"beau.developer@outlook.com"},{"name":"chiaratrussle","email":"chiara@trussle.com"},{"name":"daniele.rapati.trussle","email":"daniele.rapati@trussle.com"},{"name":"daningrey","email":"daniel@trussle.com"},{"name":"jamietrussle","email":"jamie.thirlwell@trussle.com"},{"name":"jonnyarnold","email":"jonny.arnold89@gmail.com"},{"name":"jonnywildey","email":"jonnywildey@gmail.com"},{"name":"mycleung","email":"michaelycleung@gmail.com"},{"name":"renovate","email":"renovate@keylocation.sg"},{"name":"ricardo-trussle","email":"ricardo.marques@trussle.com"},{"name":"stunthamster","email":"npm@stunthamster.com"},{"name":"trussle-admin","email":"team@trussle.com"},{"name":"vickyy","email":"vicky.lee@trussle.com"}],"homepage":"https://github.com/trussle/tricorder#readme","bugs":{"url":"https://github.com/trussle/tricorder/issues"},"dist":{"shasum":"5caaf1b7cdc785addef6b2d6f498db29fed2cc00","tarball":"https://registry.npmjs.org/@trussle/tricorder/-/tricorder-1.0.2.tgz","fileCount":9,"integrity":"sha512-3IgKRTCM7wPnfVC1Td0kBP7fXnU0lC2fbV3GogMZc7Wgr1VfOqciZhamT1MWNnKv6mXrCkWD26oUUzeuTBDWhA==","signatures":[{"sig":"MEUCICv9A7EOED4r2tWl9JAMQ6zZMKxvnsrrbGhjF9RW1ufCAiEAoXG2igUQQBkaiXS0sfvCrv6n+R0xBwtGtQjueNTqZvg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":14672,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh2e/8CRA9TVsSAnZWagAAMpYP/io7/pbW5r94o6XBfukD\nABNYMprzsMACFDwhHqlC8vKOKdIFPlxaqB7Q3iVsr4yZrqwqnIeKMG+/x13y\n/FX7jiMQxXoltjwgzxMRX7Pdusb90NQw0fKtsBoyVnH+e57V4m2dlDy1pi7P\nMeoKPsJP2eXiloZo//zQDt4OIQDRWe6nzQoGv441+n8jUkflUJ3JOhjqVYg+\nX4dXaS7YaJ5QcbfOnFrWWdRTNgDYEYqehQ+D3cHQXKJPSdF9H70XKJAu2JDV\nBYYQua6hi7nU6NNQoKYAAj1Q1RNGDdnNC8Agibmb4duWPtmFl6xhN3VvLjfB\nyRchy0LHWmMLmhwm0FwUZVQEXN35tOS/vRhnKKiJkZEQXbc1C9bTP1Vj6gdE\nLINMVxtEslnb5y9ge+ElDS6NQuz+vqWQjA869kFncW+WM5iYcDZMq6uljQIF\nUHXHP4G5kymZ4irDbysw3zxLay4bst8ziHK5OFl9p+MneenkVEz3tNpDesVL\nWc0a5JLuvhNJth3rRcxbtC1XrwaqIxKV9F8UwkZUbV2V8rKhxSHHAEhxA+Td\nf27LnPLEdDOeVHmv/0tsMgQDSSFf4VubuYOQvFgKgM8IRNqVvzFg3HNZuCtu\ng8hXH9JhQUyl+i0+VcXDEuGKtpgf6aAvsqPS6hPaoVm5KtXk9mfG7CXUJ2jp\nFIFD\r\n=tJCf\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","husky":{"hooks":{"post-version":"git push --tags --no-verify"}},"types":"lib/index.d.ts","gitHead":"ef0ae36bc8248fde3a6ce723cf488e8d00e1c6a5","private":false,"scripts":{"lint":"eslint lib/**/*.js","test":"jest --env=node .","lint:fix":"prettier --write lib/**/*.js","test:coverage":"jest --env=node --coverage ."},"_npmUser":{"name":"jonnyarnold","email":"jonny.arnold89@gmail.com"},"repository":{"url":"git+https://github.com/trussle/tricorder.git","type":"git"},"_npmVersion":"6.4.1","description":"Express middleware to provide basic metrics to Prometheus","directories":{},"_nodeVersion":"11.3.0","dependencies":{"prom-client":"^11.0.0","@types/express":"^4.11.1","prometheus-gc-stats":"^0.6.0"},"_hasShrinkwrap":false,"devDependencies":{"jest":"23.6.0","husky":"1.2.0","eslint":"5.9.0","express":"4.16.4","prettier":"1.15.3","coveralls":"3.0.2","supertest":"3.3.0","eslint-config-prettier":"3.3.0"},"_npmOperationalInternal":{"tmp":"tmp/tricorder_1.0.2_1544090842713_0.030070006925102755","host":"s3://npm-registry-packages"}}},"time":{"created":"2018-02-19T15:33:08.235Z","modified":"2026-08-19T10:39:10.426Z","1.0.0-beta01":"2018-02-19T15:33:08.295Z","1.0.0-beta02":"2018-02-27T15:32:03.992Z","1.0.0":"2018-02-28T09:36:59.153Z","1.0.1":"2018-03-16T11:21:28.778Z","1.0.2":"2018-12-06T10:07:22.876Z"},"bugs":{"url":"https://github.com/trussle/tricorder/issues"},"author":{"name":"Trussle"},"license":"MIT","homepage":"https://github.com/trussle/tricorder#readme","keywords":["Prometheus","Express","Node","Middleware"],"repository":{"url":"git+https://github.com/trussle/tricorder.git","type":"git"},"description":"Express middleware to provide basic metrics to Prometheus","maintainers":[{"email":"engineering@trussle.com","name":"trussle-admin"}],"readme":"# Tricorder\n\n[![Build Status](https://travis-ci.org/trussle/tricorder.svg?branch=master)](https://travis-ci.org/trussle/tricorder)\n[![Maintainability](https://api.codeclimate.com/v1/badges/6886b25aba70b76cbe08/maintainability)](https://codeclimate.com/github/trussle/tricorder/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/6886b25aba70b76cbe08/test_coverage)](https://codeclimate.com/github/trussle/tricorder/test_coverage)\n\n*Maintained by [@jonnyarnold](https://github.com/jonnyarnold/)*\n\n[Express](https://github.com/expressjs/express) middleware to provide basic metrics to [Prometheus](https://prometheus.io).\n\nPrometheus is an open source monitoring solution that obtains metrics from servers by querying against the `/metrics` endpoint upon them.\n\nOnce instrumented, Tricorder automatically serves response duration metrics,  nodejs system and garbage collection metrics on the `/metrics` endpoint ready to be consumed by Prometheus.\n\nThe inbuilt metrics are the basics you'll need to gain insight into your application and conforming to [best practise](https://prometheus.io/docs/practices/naming/).\n\n## Installation and Setup\n\n```bash\nnpm install @trussle/tricorder --save\n```\n\nInstallation into an express application;\n\n```js\nconst express = require(\"express\");\nconst tricorder = require(\"@trussle/tricorder\");\nconst app = express();\n\ntricorder.instrument(app);\n```\n\n## API\n\nTricorder exposes;\n\n* `instrument(Express, options)` - used to add metrics to your express server\n* `client()` - expose `prom-client` for use throughout your application\n\n### Options\n\nThe options object supports the following properties;\n\n* url - metrics url defaults to `/metrics`\n\n## Metrics\n\n### Http\n\n* http_requests_processing (gauge)\n* http_requests_total{labels} (counter)\n* http_request_duration_seconds{labels} (histogram) - count duration in `prom-client` default buckets\n\nWhen labels are indicated as in included they will be as follows;\n\n* status: the http status code of the response, e.g. 200, 500\n* method: the http method of the request, e.g. put, post.\n* path: the path of the request. Note that /users/freddie is labelled /users/:id so not to create a large number of timeseries \n\n### System\n\nThese are metrics provided by [prom-client](https://github.com/siimon/prom-client) that instrument the nodejs heap/rss usage and cpu usage etc.\n\n### Garbage Collection\n\nThese are metrics provided by [prometheus-gc-stats](https://github.com/SimenB/node-prometheus-gc-stats) that instrument the nodejs gc.\n\n## Why\n\nThe node/express eco-system already has a collection of Prometheus middleware implementations which don't all conform to best practise making metrics hard to consume and use to drive alerting.\n\nTricorder is designed to be the swiss army knife of metrics providing everything you need to get started in an easy to consume package.\n","readmeFilename":"README.md"}