{"id":18868707,"url":"https://github.com/inspector-apm/inspector-nodejs","last_synced_at":"2025-04-14T14:31:57.115Z","repository":{"id":42731460,"uuid":"256777565","full_name":"inspector-apm/inspector-nodejs","owner":"inspector-apm","description":"Connect your nodejs, express, fastify application to Inspector monitoring dashboard.","archived":false,"fork":false,"pushed_at":"2025-03-10T22:42:51.000Z","size":785,"stargazers_count":4,"open_issues_count":2,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T04:01:50.664Z","etag":null,"topics":["inspector","inspector-nodejs","monitoring","nodejs-applications","nodejs-backend-applications"],"latest_commit_sha":null,"homepage":"https://www.inspector.dev","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/inspector-apm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-18T14:45:08.000Z","updated_at":"2024-09-22T08:34:13.000Z","dependencies_parsed_at":"2024-02-21T16:12:42.058Z","dependency_job_id":"fccd5203-69ed-43b6-9a06-e578406ef43f","html_url":"https://github.com/inspector-apm/inspector-nodejs","commit_stats":{"total_commits":127,"total_committers":4,"mean_commits":31.75,"dds":0.5275590551181102,"last_synced_commit":"f9caad9361f6084da08b90552c4df97fb8018c81"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inspector-apm%2Finspector-nodejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inspector-apm%2Finspector-nodejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inspector-apm%2Finspector-nodejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inspector-apm%2Finspector-nodejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inspector-apm","download_url":"https://codeload.github.com/inspector-apm/inspector-nodejs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248816695,"owners_count":21166123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["inspector","inspector-nodejs","monitoring","nodejs-applications","nodejs-backend-applications"],"created_at":"2024-11-08T05:14:33.305Z","updated_at":"2025-04-14T14:31:56.749Z","avatar_url":"https://github.com/inspector-apm.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Inspector | Code Execution Monitoring Tool\n\n[![npm version](https://badge.fury.io/js/@inspector-apm%2Finspector-nodejs.svg)](https://badge.fury.io/js/@inspector-apm%2Finspector-nodejs)\n[![npm downloads](https://img.shields.io/npm/dt/@inspector-apm/inspector-nodejs)](https://www.npmjs.com/package/@inspector-apm/inspector-nodejs)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)\n\nSimple code execution monitoring for NodeJs backend applications.\n\n## Install\nInstall the latest version via npm:\n\n```\nnpm install @inspector-apm/inspector-nodejs --save\n```\n\n## Configure the Ingestion Key\n\nYou need an Ingestion Key to create an Inspector instance. You can obtain a key creating a new project in your [dashboard](https://www.inspector.dev).\n\nIf you use `dotenv` you can configure the Ingestion Key in your environment file:\n\n```\nINSPECTOR_INGESTION_KEY=[ingestion key]\n```\n\n## Integrate in your code\n\nInspector must be initialized before you require any other modules - i.e. before, `express`, `http`, `mysql`, etc.\n\n```javascript\n/*\n * Initialize Inspector with the Ingestion Key.\n */\nconst inspector = require('@inspector-apm/inspector-nodejs')({\n  ingestionKey: 'xxxxxxxxxxxxx',\n})\n\nconst app = require('express')()\n\n/*\n * Attach the middleware to monitor HTTP requests fulfillment.\n */\napp.use(inspector.expressMiddleware())\n\n\napp.get('/', function (req, res) {\n    return res.send('Home Page!')\n})\n\napp.get('/posts/:id', function (req, res) {\n    return res.send('Single Post Details!')\n})\n\napp.listen(3006)\n```\n\nInspector will monitor your code execution in real time, alerting you if something goes wrong.\n\n## Supported frameworks:\n\n- [ExpressJs](https://docs.inspector.dev/guides/get-started-with-express)\n- [Fastify](https://docs.inspector.dev/guides/fastify)\n\n## Official Documentation\n\n**[Go to the official documentation](https://docs.inspector.dev/platforms/nodejs)**\n\n## Contributing\n\nWe encourage you to contribute to Inspector! Please check out the [Contribution Guidelines](CONTRIBUTING.md) about how to proceed. Join us!\n\n## LICENSE\n\nThis package is licensed under the [MIT](LICENSE) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finspector-apm%2Finspector-nodejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finspector-apm%2Finspector-nodejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finspector-apm%2Finspector-nodejs/lists"}