{"_id":"@crdtech/express-health-check-middleware","_rev":"3-851c1505d6cb63669c9b6ff120180a5a","name":"@crdtech/express-health-check-middleware","dist-tags":{"latest":"0.1.5"},"versions":{"0.1.3":{"name":"@crdtech/express-health-check-middleware","version":"0.1.3","description":"express-health-check-middleware (forked @ozawa/express-health-check-middleware)","main":"src/index.js","module":"src/index.js","license":"MIT","devDependencies":{"chai":"^4.3.4","chai-http":"^4.3.0","eslint":"^7.30.0","eslint-config-google":"^0.14.0","eslint-plugin-filenames":"^1.3.2","express":"^4.17.1","mocha":"^9.0.2"},"dependencies":{"@crdtech/express-node-metrics":"^1.4.3"},"scripts":{"lint":"eslint . --fix","test":"mocha test/routes/*.js"},"gitHead":"e6a33aa40d3704247a8dd7891ade6c404da0b2d6","_id":"@crdtech/express-health-check-middleware@0.1.3","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"integrity":"sha512-+B7Pry6egeiHJnOj4/GPiOAW0Q5WVEo2PSulWTg6ROYdSLgnqBvloZPK9JxjepmWdzi56y0T9iCKnNxrKR8Y5Q==","shasum":"36e140d30875197d27060a2536ed87be26f8b099","tarball":"https://registry.npmjs.org/@crdtech/express-health-check-middleware/-/express-health-check-middleware-0.1.3.tgz","fileCount":10,"unpackedSize":15684,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg7lU4CRA9TVsSAnZWagAA8B4P/RusKmhc1vr0rs/cPTL9\n9SGQe3RxQPCNPFM02Vg3zJoTtwGa/Dm2Nv1RhkqnpsduE8HLXRwGD9+pcC7L\nWCbkZz8Sc9vb/IE71BlDrlDicTqeF6a1IOpsMICHjZQB/ml8pxO8pOkWadKP\nchwyBldLtjE3KxbMsQvcS04mkVVyGODYK+ORQsGnIODNV+twwn6z1sIF1GlD\nwjUYkS+m8THeiy+SwWLiiywEHGWtHBPztyx3NsoJaRP3d8vs+5LxoynBhMLY\naXktIMBbRcTggs6IARdzj8z5rdgUHJjtYIpe5UFKh8+agAqm3Vp4otwvvTwi\n1hXAv8b7dooYu3+TufXevIjj3/vTjlhkArCSIN52FnALdyoJZrRnao+XE6EV\n0Ng0F7yBmfoQFENYZ2lb8doAEp7716etYkUfB0iliGyzKxaanZfwigpfGmii\nI3wcwIdRZl7cg54oUlBn28Qg/pbWnKA+fNxAZY2DA1FTcC7tPlQZHFlbeYIQ\ngOu4aHGuhNaEjh69yeU+KWB7Jp55ozSLzHXzvElyVkVxOUvUb8cxYXejj6Gr\nNfvX+E7itd7fi3EqxlEJaqeXs7Jobl8W9H8XOZRRX4Xf4/LXdJ8RE86iwwdF\nl4UC8jJXIJ5rCBfgmaJu4L0BnREqD1n2UcX8j2cW1R1cRdv2SGVliNlAKu8s\nyKap\r\n=qK9a\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEDEyLNV/lWWqMm9m16i8cuN3/70cVmMHjVjapXZIxKGAiAlgwTDA3CKN9beFYnujBhtefvlzFYKfZYZLAmONqi8EA=="}]},"_npmUser":{"name":"asoe","email":"robert@mgholidaygroup.com"},"directories":{},"maintainers":[{"name":"asoe","email":"robert@mgholidaygroup.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/express-health-check-middleware_0.1.3_1626232119780_0.25694011351978463"},"_hasShrinkwrap":false},"0.1.4":{"name":"@crdtech/express-health-check-middleware","version":"0.1.4","description":"express-health-check-middleware (forked @ozawa/express-health-check-middleware)","main":"src/index.js","module":"src/index.js","license":"MIT","devDependencies":{"chai":"^4.3.4","chai-http":"^4.3.0","eslint":"^7.30.0","eslint-config-google":"^0.14.0","eslint-plugin-filenames":"^1.3.2","express":"^4.17.1","mocha":"^9.0.2"},"dependencies":{"@crdtech/express-node-metrics":"^1.4.4"},"scripts":{"lint":"eslint . --fix","test":"mocha test/routes/*.js"},"gitHead":"e6a33aa40d3704247a8dd7891ade6c404da0b2d6","_id":"@crdtech/express-health-check-middleware@0.1.4","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"integrity":"sha512-SyqJCIm2TRXzXdanYhvSq0u92/luXucmyDiimCtNuxxv0949sb2BPGi+97ajFvp9vWzpgCvTt8V7E3aMFxaHEg==","shasum":"01122a2f576ec2a45c320f975454dc06a81eca98","tarball":"https://registry.npmjs.org/@crdtech/express-health-check-middleware/-/express-health-check-middleware-0.1.4.tgz","fileCount":10,"unpackedSize":15688,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg7mb8CRA9TVsSAnZWagAAfxQQAIQSVEEoVhqgCvpriX8+\nEmsI54VOaYbAM7I4ytAP23b88rIM4CyL+fKGtHS2ZL0Cs3VNkDS4wCu3ZZpp\ni6DtVgrKdiwTLZ7A4Mon7vDNvnYKMuubURf8Tav7b+WFmPYOTy+qCCH7Gsoi\nKNw3lUCI1yNdEc/DwkLX9YW08mhJriZayGR2YZ9s2Zziotb9LNuxEttIGzd4\nVOK3RvnaL1YDo9tmxMCQ942iUbmJd521spi4uGGoA2ftriwACywTAT08O+dy\n5k/oJVFGziHqIPyBmCLNiKRxEa1tNUzC/RNxhcWQj+TqkSfbufvJJQtwK6Nc\n23iDEDM8oXQgsedo7fpWy7RgQJ05g5CSlRmtDIdDgaJNf9lmk9zz/cW77Yo/\n7ueluFD0jw85e3p5TTjRmgaaefIVt2rLeQSjCzMO74/NnnLeHcEGxTBn+WQP\nBXor0g99sdgRul9Mre00uQq3PMQHANZfwdSdoTKON9osfzV1cKywbpzUIRl4\n+c8rDQY/am+vlBDfGYUqKoqPKxZhFFusNbL/zjTVaNCE9RpiP1kkBO48id01\nc0fyb6TvknPQ5MWOMsWyJsBkk4s0nY43zLH5JtbUEGb8xPnbnwbqk+sOh+CX\nSBv24TsrNL3lqFtsgxLQ+4vF83xVWbD9O2gLGvh+iIGQJBT0uNnBYlFtJHo4\nmxsc\r\n=kTFy\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIB1cb2h9FcpzogvuN+vGtRRkw8aeTHcjs9HlXJ83sMJXAiAtL0XHDW6iulK4eZz4NirfU+IJo5cNhDRLFrOVlmjPyw=="}]},"_npmUser":{"name":"asoe","email":"robert@mgholidaygroup.com"},"directories":{},"maintainers":[{"name":"asoe","email":"robert@mgholidaygroup.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/express-health-check-middleware_0.1.4_1626236667781_0.44365172212593884"},"_hasShrinkwrap":false},"0.1.5":{"name":"@crdtech/express-health-check-middleware","version":"0.1.5","description":"express-health-check-middleware (forked @ozawa/express-health-check-middleware)","main":"src/index.js","module":"src/index.js","license":"MIT","devDependencies":{"chai":"^4.3.4","chai-http":"^4.3.0","eslint":"^7.30.0","eslint-config-google":"^0.14.0","eslint-plugin-filenames":"^1.3.2","express":"^4.17.1","mocha":"^9.0.2"},"dependencies":{"@crdtech/express-node-metrics":"^1.4.5"},"scripts":{"lint":"eslint . --fix","test":"mocha test/routes/*.js"},"gitHead":"e6a33aa40d3704247a8dd7891ade6c404da0b2d6","_id":"@crdtech/express-health-check-middleware@0.1.5","_nodeVersion":"14.17.3","_npmVersion":"6.14.13","dist":{"integrity":"sha512-NQkVYkKYpZg6FUGhIxgGk0mBMBKYiBkeLea6N9Mn5tGdCEX+LHZDgnMmARKhZsh8Xq7quZV+cwJ7MrGborrcOg==","shasum":"dbdfd70070dacd2e93e79773cf557a414d1dbf31","tarball":"https://registry.npmjs.org/@crdtech/express-health-check-middleware/-/express-health-check-middleware-0.1.5.tgz","fileCount":10,"unpackedSize":15688,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg7rQxCRA9TVsSAnZWagAAvLoQAJeKBAp3koiecoum6Yc5\nPkXsHbJswZPnzssnsXzLqaUsnpL+dVudszzjEkO44RNazEReH7RWS8CLBlj2\nYEqOZE8SQ5g8Ha3Tt2f8hTrFpo7RMVCtLTaKKSGXp5QG6iWxqjWyeSrs9KzW\nqHFDMPz1Wbc4hh/EB+oE6zKYUxuH6/Ea4bUridr6SttK+lv6lSJa77bEvyY6\nlpxb93M4LWTYqI70RE3ZrGPy/Rv2J4A3K8M58n0Vfog0//c4I83B6dWBalot\nEtL2yTwg8lNJNxDEOu1HNTbDhvcCpPjzYKcQ4fjZmIbA4NUuoj214ynC7X4V\nTLv5fC19OWCAx0D0k6x4L70eu4Nqs9D89jGNLm/gapZf05zPnvAJcpqx+3JY\nll4JxEZ1u+NRCzDxHO7kGoOWscoDJBNrjklt5QZj+mEqXn7DO1GNBAZ2EFnk\nNl8I92yK/VgHbNvGhj7lNIx7u0ZW+PrN1EeVH0pYXekJiJ7mZ37q9aTgft5m\nc11AzAUBc+UmxzMGHief4ELo25Tud7vgEffeOuE56QhbyKpk80I9XYzPnolI\nkrsdT4mXluHVTagNk7ncxlOqu1yttkaU8f+he48oM5hap5ThirPp1RiXbiu3\npuLlRaQE9G/kWLlPW66QL9Nq1Xp9U2BmkWbUHkU7R7wNgU+uCt3opQ5EUBtT\nIYqR\r\n=gFKB\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEV0MK5JkFZMahJ6DJ/jL/LsFiM4YqN+/OZqNcw+lyVvAiEAvWprEwaLP83CGzHvlQq+Q5jqv0pMEKW3mmCeBTLbgtQ="}]},"_npmUser":{"name":"asoe","email":"robert@mgholidaygroup.com"},"directories":{},"maintainers":[{"name":"asoe","email":"robert@mgholidaygroup.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/express-health-check-middleware_0.1.5_1626256432922_0.07241719027722127"},"_hasShrinkwrap":false}},"time":{"created":"2021-07-14T03:08:39.419Z","0.1.3":"2021-07-14T03:08:39.903Z","modified":"2022-04-05T01:41:00.979Z","0.1.4":"2021-07-14T04:24:27.895Z","0.1.5":"2021-07-14T09:53:53.025Z"},"maintainers":[{"name":"asoe","email":"robert@mgholidaygroup.com"}],"description":"express-health-check-middleware (forked @ozawa/express-health-check-middleware)","license":"MIT","readme":"# Express Health Check Middleware\n\nAdd health, readiness, liveness and metrics functionality to express.\n\n## Features\n\n- Add Health Endpoint\n\n  GET /-/health\n\n  Only checks whether the application server is running It does not verify the database or other services are running. A successful response will return a 200 status code\n\n- Add Readiness Endpoint\n\n  GET /-/readiness\n  \n  Sometimes, applications are temporarily unable to serve traffic. For example, an application might need to load large data or configuration files during startup, \n  or depend on external services after startup. In such cases, you don’t want to kill the application, but you don’t want to send it requests either. \n\n- Add Liveness Endpoint\n\n  GET /-/liveness\n  \n  Many applications running for long periods of time eventually transition to broken states, and cannot recover except by being restarted.\n- Add Metrics Endpoint\n\n  GET /-/metrics\n\n  - Node process metrics\n  - Infrastructure to collect internal metrics (like southbound APIs)\n  - API to retrieve the collected metrics and to reset them.\n\n\n## How to use\n\n\n```bash\nnpm install --save @crdtech/express-health-check-middleware\n```\n\n```javascript\nconst express = require('express');\n\nconst healthCheckMiddleware = require('@crdtech/express-health-check-middleware');\nconst mongoose = require('mongoose');\n\nconst app = express();\n\napp.use(healthCheckMiddleware({\n  checkFunctions: {\n    // Example add check mongo connection\n    mongo: async()=>{\n      let result = await mongoose.connection.db.admin().ping()\n      return result\n    },\n    // You can add your own check function\n    // <key> : <async|return Promise>\n  },\n\n  // Optional, This is default settings\n  authMiddleware: (req, res, next) => {\n    if (process.env.HEALTH_CHECK_ACCESS_TOKEN) {\n      if (req.query.token !== process.env.HEALTH_CHECK_ACCESS_TOKEN) {\n        return res.status(404).send('');\n      }\n    }\n    next();\n  },\n\n  // Optional, This is default settings\n  routes: {\n    health   : '/~/health',\n    readiness: '/~/readiness',\n    liveness : '/~/liveness',\n    metrics  : '/~/metrics',\n  },\n})(app));\n\napp.get('/', function(req, res) {\n  res.json({hello: 'world'});\n});\n\nconst main = async()=>{\n  let mongooseOptions = { useNewUrlParser: true }\n  let databaseUrl = process.env.DATABASE_URL || 'mongodb://localhost:27017/my-app'\n  await mongoose.connect(databaseUrl, mongooseOptions)\n  app.listen(3000);\n}\n\nmain();\n```","readmeFilename":"README.md"}