{"id":13550962,"url":"https://github.com/sanathp/statusok","last_synced_at":"2025-04-08T11:08:46.570Z","repository":{"id":44696677,"uuid":"41440228","full_name":"sanathp/statusok","owner":"sanathp","description":"Monitor your Website and APIs from your Computer. Get Notified through Slack, E-mail when your server is down or response time is more than expected. ","archived":false,"fork":false,"pushed_at":"2021-08-11T16:30:28.000Z","size":155,"stargazers_count":1627,"open_issues_count":39,"forks_count":198,"subscribers_count":47,"default_branch":"master","last_synced_at":"2025-04-01T09:31:28.298Z","etag":null,"topics":["monitor","monitoring-server","notifications","slack","statusok"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sanathp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"License","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-26T17:39:48.000Z","updated_at":"2025-03-26T00:22:26.000Z","dependencies_parsed_at":"2022-09-19T19:02:46.323Z","dependency_job_id":null,"html_url":"https://github.com/sanathp/statusok","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanathp%2Fstatusok","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanathp%2Fstatusok/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanathp%2Fstatusok/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanathp%2Fstatusok/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sanathp","download_url":"https://codeload.github.com/sanathp/statusok/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247829491,"owners_count":21002995,"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":["monitor","monitoring-server","notifications","slack","statusok"],"created_at":"2024-08-01T12:01:40.383Z","updated_at":"2025-04-08T11:08:46.537Z","avatar_url":"https://github.com/sanathp.png","language":"Go","funding_links":[],"categories":["Software Packages","Go","others","软件包","Go 工具","Go Tools","Opensource","DevOps Tools","軟件包"],"sub_categories":["DevOps Tools","DevOps工具","DevOps 工具","代码分析","devops 工具"],"readme":"# StatusOK\n\nMonitor your Website and APIs from your computer.Get notified through Slack or E-mail when your server is down or response time is more than expected.\n\n\n## Simple Version\n\nSimple Setup to monitor your website and recieve a notification to your Gmail when your website is down.\n\nStep 1: Write a config.json with the url information \n```\n{\n\t\"notifications\":{\n\t\t\"mail\":{\n\t\t\t\"smtpHost\":\"smtp.gmail.com\",\n\t\t\t\"port\":587,\n\t\t\t\"username\":\"yourmailid@gmail.com\",\n\t\t\t\"password\":\"your gmail password\",\n\t\t\t\"from\":\"yourmailid@gmail.com\",\n\t\t\t\"to\":\"destemailid@gmail.com\"\n\t\t}\n\t},\n\t\"requests\":[\n\t\t{\n\t\t\t\"url\":\"http://mywebsite.com\",\n\t\t\t\"requestType\":\"GET\",\n\t\t\t\"checkEvery\":30,\t\n\t\t\t\"responseTime\":800\n\t\t}\n\t]\n}\n```\nTurn on access for your gmail https://www.google.com/settings/security/lesssecureapps .\n\nStep 2: Download bin file from [here](https://github.com/sanathp/statusok/releases/) and run the below command from your terminal\n```\n$ ./statusok --config config.json\n```\nThats it !!!! You will receive a mail when your website is down or response time is more.\n\nTo run as background process add \u0026 at the end\n\n```\n$ ./statusok --config config.json \u0026\t\n```\nto stop the process \n```\n$ jobs\n$ kill %jobnumber\n```\n\n## Complete Version using InfluxDb\n\n![alt text](https://github.com/sanathp/StatusOK/raw/master/screenshots/graphana.png \"Graphana Screenshot\")\n\nYou can save data to influx db and view response times over a period of time as above using graphana.\n\n[Guide to install influxdb and grafana](https://github.com/sanathp/statusok/blob/master/Config.md#database) \n\nWith StatusOk you can monitor all your REST APIs by adding api details to config file as below.A Notification will be triggered when you api is down or response time is more than expected.\n\n```json\n{\n\t\"url\":\"http://mywebsite.com/v1/data\",\n\t\"requestType\":\"POST\",\n\t\"headers\":{\n\t\t\"Authorization\":\"Bearer ac2168444f4de69c27d6384ea2ccf61a49669be5a2fb037ccc1f\",\n\t\t\"Content-Type\":\"application/json\"\n\t},\n\t\"formParams\":{\n\t\t\"description\":\"sanath test\",\n\t\t\"url\":\"http://google.com\"\n\t},\n\t\"checkEvery\":30,\n\t\"responseCode\":200,\t\t\n\t\"responseTime\":800\n},\n\n{\n\t\"url\":\"http://mywebsite.com/v1/data\",\n\t\"requestType\":\"GET\",\n\t\"headers\":{\n\t\t\"Authorization\":\"Bearer ac2168444f4de69c27d6384ea2ccf61a49669be5a2fb037ccc1f\",\t\t\n\t},\n\t\"urlParams\":{\n\t\t\"name\":\"statusok\"\n\t},\n\t\"checkEvery\":300,\n\t\"responseCode\":200,\t\t\n\t\"responseTime\":800\n},\n\n{\n\t\"url\":\"http://something.com/v1/data\",\n\t\"requestType\":\"DELETE\",\n\t\"formParams\":{\n\t\t\"name\":\"statusok\"\n\t},\n\t\"checkEvery\":300,\n\t\"responseCode\":200,\t\t\n\t\"responseTime\":800\n}\n\n```\n[Guide to write config.json file](https://github.com/sanathp/statusok/blob/master/Config.md#writing-a-config-file)\n\n[Sample config.json file](https://github.com/sanathp/StatusOK/blob/master/sample_config.json)\n\nTo run the app\n\n```\n$ ./statusok --config config.json \u0026\n```\n\n## Database\n\nSave Requests response time information and error information to your database by adding database details to config file. Currently only Influxdb 0.9.3+ is supported.\n\nYou can also add data to your own database.[view details](https://github.com/sanathp/statusok/blob/master/Config.md#save-data-to-any-other-database)\n\n## Notifications\n\nNotifications will be triggered when mean response time is below given response time for a request or when an error is occured . Currently the below clients are supported to receive notifications.For more information on setup [click here](https://github.com/sanathp/statusok/blob/master/Config.md#notifications)\n\n1. [Slack](https://github.com/sanathp/statusok/blob/master/Config.md#slack)\n2. [Smtp Email](https://github.com/sanathp/statusok/blob/master/Config.md#e-mail)\n3. [Mailgun](https://github.com/sanathp/statusok/blob/master/Config.md#mailgun)\n4. [Http EndPoint](https://github.com/sanathp/statusok/blob/master/Config.md#http-endpoint)\n5. [Dingding](https://github.com/sanathp/statusok/blob/master/Config.md#dingding)\n\nAdding support to other clients is simple.[view details](https://github.com/sanathp/statusok/blob/master/Config.md#write-your-own-notification-client)\n\n## Running with plain Docker\n\n```\ndocker run -d -v /path/to/config/folder:/config sanathp/statusok\n```\n\n*Note*: Config folder should contain config file with name `config.json`\n\n## Running with Docker Compose\n\nPrepare docker-compose.yml config like this:\n\n```\nversion: '2'\nservices:\n  statusok:\n    build: sanathp/statusok\n    volumes:\n      - /path/to/config/folder:/config\n    depends_on:\n      - influxdb\n  influxdb:\n    image: tutum/influxdb:0.9\n    environment:\n      - PRE_CREATE_DB=\"statusok\" \n    ports:\n      - 8083:8083 \n      - 8086:8086\n  grafana:\n    image: grafana/grafana\n    ports:\n      - 3000:3000\n```\n\nNow run it:\n\n```\ndocker-compose up\n```\n\n## Contribution\n\nContributions are welcomed and greatly appreciated. Create an issue if you find bugs.\nSend a pull request if you have written a new feature or fixed an issue .Please make sure to write test cases.\n\n## License\n```\nCopyright 2015 Sanath Kumar Pasumarthy\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanathp%2Fstatusok","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsanathp%2Fstatusok","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanathp%2Fstatusok/lists"}