{"id":19055782,"url":"https://github.com/taskrabbit/statusbot","last_synced_at":"2025-04-24T04:29:11.866Z","repository":{"id":19247492,"uuid":"22482798","full_name":"taskrabbit/statusbot","owner":"taskrabbit","description":"Monitor your uptime automagically with statuspage.io","archived":false,"fork":false,"pushed_at":"2016-05-17T20:42:44.000Z","size":33,"stargazers_count":18,"open_issues_count":0,"forks_count":5,"subscribers_count":52,"default_branch":"master","last_synced_at":"2025-04-18T12:19:16.855Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"status.taskrabbit.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/taskrabbit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-31T19:56:24.000Z","updated_at":"2023-05-14T02:34:05.000Z","dependencies_parsed_at":"2022-08-01T04:08:01.715Z","dependency_job_id":null,"html_url":"https://github.com/taskrabbit/statusbot","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskrabbit%2Fstatusbot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskrabbit%2Fstatusbot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskrabbit%2Fstatusbot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taskrabbit%2Fstatusbot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taskrabbit","download_url":"https://codeload.github.com/taskrabbit/statusbot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250563814,"owners_count":21450897,"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":[],"created_at":"2024-11-08T23:47:00.980Z","updated_at":"2025-04-24T04:29:11.841Z","avatar_url":"https://github.com/taskrabbit.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# StatusBot\n\nI check URLs and report their status to statuspage.io.  \nThis powers `status.taskrabbit.com`.\n\nThis tool will gather response times for your METRICS.\nMETRICS are linked to a COMPONENT, and will trigger the COMPONENT status as the metric changes.  For example if you have METRIC \"api_user_search_response_time\" and the COMPONENT \"API\", you can setup StatusBot to note the \"API\" as having an outage if your metric check for the related endpoint to \"api_user_search_response_time\" is either slow or does not return a `200 OK`\n\n- If a metric check is slow (`check.threshold`), the related component is noted as `degraded performance`\n- If there is an HTTP error checking the metric, the related component is noted as having a `partial_outage`\n  - You configure how many times an metric must fail before the outage is triggered (default 10).\n- If you don't want to create an incident for a metric, set `check.impact = 'none'` \n- StatusBot will never close an incident for you.  This should be done manually via your `statuspage.io` dashboard, so you can add incident notes. \n\n## Install\n\n- `npm install`\n- configure your checks in `/config/statuspage.js` (copy from `/config/statuspage.example.js`)\n- `npm start`\n\nStatusBot is an actionhero.js project. Visit [www.actionherojs.com](http://www.actionherojs.com) for more information.\n\n## Notes\n\n- As this is an actionhero project, you can do the following:\n  - Manually run the checks with the action `check`\n    - You can run this action via HTTP, Telnet, and sockets if you configure the server to enable these transports.\n  - Deploy a cluster of statusBots that all share the same redis instance and all the checks will be distributed between them. \n- You can configure the frequency at which all URLs are checked within the `checkAll` task by modifying `task.frequency`.  The default is 10 seconds. \n  - To account for `statuspage.io`'s rate limiting, we will wait 5 seconds before each check within the `checkAll` task.  This is not configurable.\n- You can configure the default message new incidents are created at within `/config/errors.js`\n\n## TODO\n\n- configure the workers so they fairly round-robin the checks between all available nodes. \n- allow for regexp-based body checks\n  - these regexep checks might power the incident messaging\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaskrabbit%2Fstatusbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaskrabbit%2Fstatusbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaskrabbit%2Fstatusbot/lists"}