{"_id":"@brandednomad/servermetric","_rev":"3-f7039ecc9161f0f429df58d06bee2337","name":"@brandednomad/servermetric","dist-tags":{"latest":"0.3.0"},"versions":{"0.1.0":{"name":"@brandednomad/servermetric","version":"0.1.0","description":"A package that measures and records server performance","main":"index.js","types":"index.d.ts","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","start-dev":"nodemon server.js"},"keywords":["server","metrics","performance"],"repository":{"type":"git","url":"git+https://github.com/BrandedNomad/npm-package-servermetric.git"},"author":{"name":"Charl Swart"},"license":"ISC","dependencies":{"@types/node":"^16.7.2"},"devDependencies":{"@types/express":"^4.17.13","express":"^4.17.1","tsc":"^2.0.3","typescript":"^4.4.2"},"gitHead":"b42ef7c33235f512b5143c32e4aa4f6d1fb151a9","bugs":{"url":"https://github.com/BrandedNomad/npm-package-servermetric/issues"},"homepage":"https://github.com/BrandedNomad/npm-package-servermetric#readme","_id":"@brandednomad/servermetric@0.1.0","_nodeVersion":"15.0.1","_npmVersion":"7.0.3","dist":{"integrity":"sha512-w1rzOJpeBo4QSsqeuJysnhfbKUNPks6ObE/q19WXDtpcsVxOBrCJChFOdlCES3XD1cXkg432JJd5EEbSUerfKg==","shasum":"1f97ff867f4a49022476cd15f08993175f088ecf","tarball":"https://registry.npmjs.org/@brandednomad/servermetric/-/servermetric-0.1.0.tgz","fileCount":7,"unpackedSize":43063,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhKIt5CRA9TVsSAnZWagAAQCsQAJ6akFewJmer6El9ue46\nDtuO/gCi79homIGLWhsFQu2Q4lvU/DfZFUJ3Td7vsEyB0QU9uNKfZFiHUHoy\nOCvQwNwKC1/vJomt5e+iRY6uokwosmHjZZe9H3wY7BQ16qgF7EtwSqahcb08\ntuERp0vIwXunJzaq4TaII/qL+SKMj+QZypSVCbuIQ5TDIBM+pWR0ZD6B0oBp\nwZswfDcDptacKScY2V2AjQhxJlvClTSi/n9RDH9PSfSITxH9kbFR6Z5pUAat\nFu7JUna8r39DgpXNqOXspYhsAok20Cl3sLXbo7BOg1Wem543+/gq/qsVLrMa\niG9fTw5c28bKmlZode3w6Xh4H28sjP9ew824FIe1R4GXC4cWr1utlhYWeFue\nD79cIcHFcR344+0Zm19+MOuW4fqRGvwuw7DiKLKM0jK4B0zy9GBMfg2vmvgP\n7su4f0HmDI5CqmokakvVEADle+/HkYVuZSfi51R4q4yy8b4WYAlKAfGhAXq3\nHr9949mbDxh/arif63Nlkg5GjmaGzS8R1oQ77lBEOgB0A6imc1me/+hL7CvE\nfMc6jbGYe1EWzlIy7HFDP3h+xol3+ZwFII3FgJlKv4DvDrZ4FDq8P7uZXdpC\n6oTORcciOmo+tQ7NlSxgl4hbK9IfAbUgHjin+W+wDQ/U8YA0IdZGKYIhyU5u\n72Uh\r\n=L2qn\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIF4o0HIgOTO8P5qHTJsVfG3kRm4cekcRLniJbFvxcXJbAiABAto/qepA+3PkbG7nRWbDvWnf/EIS2ZhoyqCRhrYIKA=="}]},"_npmUser":{"name":"brandednomad","email":"cshandwritten@gmail.com"},"directories":{},"maintainers":[{"name":"brandednomad","email":"cshandwritten@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/servermetric_0.1.0_1630047097148_0.05141710685061884"},"_hasShrinkwrap":false},"0.2.0":{"name":"@brandednomad/servermetric","version":"0.2.0","description":"A package that measures and records server performance","main":"index.js","types":"index.d.ts","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","start-dev":"nodemon server.js"},"keywords":["server","metrics","performance"],"repository":{"type":"git","url":"git+https://github.com/BrandedNomad/npm-package-servermetric.git"},"author":{"name":"Charl Swart"},"license":"ISC","dependencies":{"@types/node":"^16.7.2"},"devDependencies":{"@types/express":"^4.17.13","express":"^4.17.1","tsc":"^2.0.3","typescript":"^4.3.2"},"gitHead":"b42ef7c33235f512b5143c32e4aa4f6d1fb151a9","bugs":{"url":"https://github.com/BrandedNomad/npm-package-servermetric/issues"},"homepage":"https://github.com/BrandedNomad/npm-package-servermetric#readme","_id":"@brandednomad/servermetric@0.2.0","_nodeVersion":"15.0.1","_npmVersion":"7.0.3","dist":{"integrity":"sha512-Se19PHXWO2YP8GPLT3CvMUgeaw62NmEdHA1xbjU9/2o9Z067cvIlgUmLZogoBcnAMrgIZqBtf4xejhzRH3CRkQ==","shasum":"354d19987fd76ea18ce96e7baf61e08d1181fba4","tarball":"https://registry.npmjs.org/@brandednomad/servermetric/-/servermetric-0.2.0.tgz","fileCount":7,"unpackedSize":43105,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhLKarCRA9TVsSAnZWagAA3uAP/j/E2oQkHu3tiM3tx2fB\n5krXmTtscPrxYq8PlWPg8knJq+7IJvBTmx/QiY6NZ0mg8QFAOdjuMsOzxt3o\nvUnN0tkm7pH9pgBIcLjR010FqXWHISQK4LUcEP+LUhpROM0YYSaR7E73ULYi\ndEMu91RPAlC67jF4bfB5WgdnMx35XF5xbp85oLp2aIOPeQhN+5LCqb0r3Osy\n/BuMRU1kn6i/gkfKP85Dc2i5n0bTRHXXTKVCW9WRJZccUoh5lfeTwwM8X+ge\neTjvBJo2R46zecfTctmfGUTDBNILeLGWD5ozl0kaoET9RdUN1f5Yc9o0vQcv\nE5e4DfbpRAXqdsHknGBa3jgkemh+wI9tFn4eMM63TpPGpjBbTVbq8n4+KYlV\nbKRWerEkUd6i8CZlQn/wdZtdiB5xZroxOlJ8CjbJdfRKZC28ncK+mQB383He\nWjgnfC1Jauyw2Z3vhJgtGc1h66C66ZAyINPmmvRv8AWgnfFKv3G7EhjDpSZK\nNU0aevizdLUUjdJbUIg67GDTJwmw9nG9fU39zKxrzOKbE7UgyHlHPOmVnB9t\n2JvoZZe6dhDMZBB0TTew0ZTMiS20BN7706Snccbgxo3YAGJHZyBOrqNMHdlb\nTjBphQnXGOS1x7cPOOd1w62Ql3BldY0Bch+f5U5zb7FhmBxIZX8MyI6nR24C\ngKg5\r\n=RbR0\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCsE/vsqkD2wplZd7W4ls9FKPOvmc92cQh84xZU2beS/wIhAN4ZCEttsjz3D+b4UasGYn3qRr1zLrgxIrwmCp6MEDqZ"}]},"_npmUser":{"name":"brandednomad","email":"cshandwritten@gmail.com"},"directories":{},"maintainers":[{"name":"brandednomad","email":"cshandwritten@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/servermetric_0.2.0_1630316203511_0.06752023354719361"},"_hasShrinkwrap":false},"0.3.0":{"name":"@brandednomad/servermetric","version":"0.3.0","description":"A package that measures and records server performance","main":"index.js","types":"index.d.ts","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc","start-dev":"nodemon server.js"},"keywords":["server","metrics","performance"],"repository":{"type":"git","url":"git+https://github.com/BrandedNomad/npm-package-servermetric.git"},"author":{"name":"Charl Swart"},"license":"ISC","dependencies":{"@types/node":"^16.7.2"},"devDependencies":{"@types/express":"^4.17.13","express":"^4.17.1","tsc":"^2.0.3","typescript":"^4.3.2"},"gitHead":"b42ef7c33235f512b5143c32e4aa4f6d1fb151a9","bugs":{"url":"https://github.com/BrandedNomad/npm-package-servermetric/issues"},"homepage":"https://github.com/BrandedNomad/npm-package-servermetric#readme","_id":"@brandednomad/servermetric@0.3.0","_nodeVersion":"15.0.1","_npmVersion":"7.0.3","dist":{"integrity":"sha512-4Uw97SSA4LEgYJtofN3XREf7bzJ6oYIpkXWlbDCCvZDJK0lsGKJwD5JQrTfLKLcBI56hVmCUQF6gz7YFkcjhFw==","shasum":"933a61212288e29b1d4f63c3b0870206cf95691f","tarball":"https://registry.npmjs.org/@brandednomad/servermetric/-/servermetric-0.3.0.tgz","fileCount":7,"unpackedSize":43105,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhLKeHCRA9TVsSAnZWagAA5icP/iu6GI1NhDgt2Rbgvm2O\nfO0zpPVcEmZnsEPnUHm9b7TFWIkpmj0de9EicWGcEmh5ddAlRfUz12IQa82I\nSOXIymAIMla0Xl5s1OrJm7rckKdsWBu1aELcxPzq42cLXZ1R3GKVP9NJUMjQ\nodEYLmSk3wYm4IW4EGyGqJXIPV1UetooBtQylG1vke/rY9CahIzYNkMueupN\nkoDTpEdG8l7TGvO7uAmcILsn9olyTYnr9FqnJZgsKYtBHaJdBdh2mtL3dJCF\nNMKc8eJAQYMz7/La2UHaTp3fZczCRf+0N34h7Mt7Pn1DU8qBNtR5GDaWol2g\n0V4kFYJ/Sd/h/DESMcQvGwUkMxq52t+7weMfxAjp2MiWnJIiHSdz6NNBQlJ5\nK5JCqkoHCBJCmaVRqIWKan6d13sC959J8B0vT2021i/5iQ9QpGU016fjzTK/\nNQbTA1Jj4cWTqG1n/zEhHx8xMmICZj7so3FMNyuh2iYXVKQDfQvRGjC0KtLz\nBNAjRv6MEz1/GFF/J0xYceZDiPw9K/Q9fSpMA+OXo6gjQDaNASM+dER4Z663\n+4nXDuzJAwzjWzYrpZftHSGCy2g6gzZbDf13IqRS7s2OrKccqDw+iSHbuFzn\nlsnxL6QsZjvMUQmMrUOrWssjpMCHUPd2cpM1VRemzfunzjvzj0cMxImUXpM3\nTnKB\r\n=kKpy\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGgbZ1VLYqF/SfXZg0h+3WlTJVYlWDOEkdxnCNZb3UACAiBrDXCWGv665yMLFEpxEEityCvhRConYKFCVaXX0/gcKQ=="}]},"_npmUser":{"name":"brandednomad","email":"cshandwritten@gmail.com"},"directories":{},"maintainers":[{"name":"brandednomad","email":"cshandwritten@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/servermetric_0.3.0_1630316423711_0.4595032739097289"},"_hasShrinkwrap":false}},"time":{"created":"2021-08-27T06:51:37.081Z","0.1.0":"2021-08-27T06:51:37.268Z","modified":"2022-04-04T20:22:17.575Z","0.2.0":"2021-08-30T09:36:43.656Z","0.3.0":"2021-08-30T09:40:23.834Z"},"maintainers":[{"name":"brandednomad","email":"cshandwritten@gmail.com"}],"description":"A package that measures and records server performance","homepage":"https://github.com/BrandedNomad/npm-package-servermetric#readme","keywords":["server","metrics","performance"],"repository":{"type":"git","url":"git+https://github.com/BrandedNomad/npm-package-servermetric.git"},"author":{"name":"Charl Swart"},"bugs":{"url":"https://github.com/BrandedNomad/npm-package-servermetric/issues"},"license":"ISC","readme":"@brandednomad/servermetric\r\n==\r\nThe Servermetric package records and displays server metrics via the /healthz or /metrics endpoint. NOTE: This package is still under development\r\n\r\n## Installation\r\n\r\nRequires __npm 2.7.0__ or higher\r\n\r\n`npm init`\r\n\r\n`npm install @brandednomad/servermetric --save`\r\n\r\n***\r\n\r\n## Usage\r\n\r\nNote the metrics.startRequestTimer() and metrics.measure() methods need to be added to each endpoint. The metrics.startRequestTimer() method is added at the start of a request and the metrics.measure() method is added after each response\r\n\r\n    const metrics = require(\"@brandednomad/servermetric\");\r\n    \r\n    server.get('/',(req,res)=>{\r\n        const startTime = metrics.startRequestTimer()\r\n        res.status(200).send('Hello World');\r\n        metrics.measure(startTime,'homePage',200)\r\n    })\r\n\r\n    server.get('/metrics',(req,res)=>{\r\n        res.status(200).send(metrics.getMetrics())\r\n    })\r\n\r\n***\r\n\r\n## Methods\r\n\r\n### object.startRequestTimer()\r\n\r\nCalculates and returns the start time of a request\r\n\r\n### object.measure()\r\n\r\nRecords the performance of a request.\r\n\r\nIt takes the return value of the startRequestTimer() method as an argument\r\n\r\n### object.getMetrics()\r\n\r\nReturns an metrics object that contains all the recorded metrics\r\n\r\n\r\n***\r\n\r\n## Testing\r\n\r\nTo test, go to the root folder and type \r\n\r\n`npm test`\r\n\r\n***\r\n\r\n## Repo(s)\r\n\r\n* [github.com/brandednomad/npm-package-servermetric.git](https://github.com/BrandedNomad/npm-package-servermetric.git)\r\n\r\n***\r\n\r\n## contributing\r\n\r\nContributions not accepted at this moment\r\n\r\n## Version History\r\n\r\n\r\n#### Version 0.1.0\r\n\r\n* initial release\r\n","readmeFilename":"README.md"}