{"id":27440281,"url":"https://github.com/fealone/monitapi","last_synced_at":"2025-04-14T22:39:41.885Z","repository":{"id":47787726,"uuid":"303558218","full_name":"fealone/monitapi","owner":"fealone","description":"monitapi is something to monitor API(URL) by a serverless.","archived":false,"fork":false,"pushed_at":"2024-08-30T05:10:00.000Z","size":1434,"stargazers_count":7,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-06T15:12:41.366Z","etag":null,"topics":["agraffe","async","aws-lambda","docusaurus2","fastapi","gcp-cloud-functions","python","python3","serverless"],"latest_commit_sha":null,"homepage":"https://fealone.github.io/monitapi/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fealone.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":"2020-10-13T01:45:11.000Z","updated_at":"2024-02-22T12:20:18.000Z","dependencies_parsed_at":"2022-09-26T17:21:29.452Z","dependency_job_id":null,"html_url":"https://github.com/fealone/monitapi","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fealone%2Fmonitapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fealone%2Fmonitapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fealone%2Fmonitapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fealone%2Fmonitapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fealone","download_url":"https://codeload.github.com/fealone/monitapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248813826,"owners_count":21165631,"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":["agraffe","async","aws-lambda","docusaurus2","fastapi","gcp-cloud-functions","python","python3","serverless"],"created_at":"2025-04-14T22:39:41.233Z","updated_at":"2025-04-14T22:39:41.875Z","avatar_url":"https://github.com/fealone.png","language":"Python","readme":"# monitapi\n\n\u003cimg src=\"https://raw.githubusercontent.com/fealone/monitapi/master/website/static/img/logo.png\" width=\"600px\"\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n---\n\n## What is this\nmonitapi is something to monitor API(URL) by a serverless.  \nIt supports hosting with FastAPI, running with CLI, and deploying to serverless.\n\n## Getting Started\nPlease refer to the documents created by Docusaurus.  \nA rich README and website are in preparation.\n\nhttps://fealone.github.io/monitapi\n\n## Image of operating environment\n\n### GCP\n\n\u003cimg src=\"https://raw.githubusercontent.com/fealone/monitapi/master/website/static/img/gcp.rediagram.png\" width=\"600px\"\u003e\n\n### AWS\n\n\u003cimg src=\"https://raw.githubusercontent.com/fealone/monitapi/master/website/static/img/aws.rediagram.png\" width=\"600px\"\u003e\n\n### Installation\nmonitapi is made by Python, so can you install it via PyPI.\n\n```shell\npip install monitapi\n```\n\n### Example targets file\n```yaml\nmonitor_targets:\n    - github-monitapi\n      method: \"GET\"\n      url: https://github.com/fealone/monitapi\n      status_code: 200\n      timeout: 5\n      retry: 1\n      retry_wait: 5\n\nnotification_targets:\n    - notification-to-slack:\n      type: slack\n      endpoint: {Slack Incoming Webhooks endpoint}\n      payload:\n          blocks:\n              -\n                type: section\n                text:\n                    type: mrkdwn\n                    text: \"Target: {{url}}, Status: {{status_code}}, Expect: {{expected_status_code}}, Message: {{message}}\"\n\n```\n\n### Usage\n\n#### One shot \n```shell\nmonitapi monitor {targets.yaml}\n```\n\n#### Run with FastAPI\nYou need to put targets.yaml in the current directory.\n\n```shell\nmonitapi serve\n```\n\n#### Deploy to serverless\n```shell\nmonitapi deploy {platform} --name {function-name} --file {targets.yaml} --options {deploy-option}\n```\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"http://lonesec.com\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/57695598?v=4\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003efealone\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/fealone/monitapi/commits?author=fealone\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#content-fealone\" title=\"Content\"\u003e🖋\u003c/a\u003e \u003ca href=\"#design-fealone\" title=\"Design\"\u003e🎨\u003c/a\u003e \u003ca href=\"#example-fealone\" title=\"Examples\"\u003e💡\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n## License\n\nThis project is licensed under the GPLv3 License - see the [LICENSE](LICENSE) file for details\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffealone%2Fmonitapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffealone%2Fmonitapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffealone%2Fmonitapi/lists"}