https://github.com/fealone/monitapi
monitapi is something to monitor API(URL) by a serverless.
https://github.com/fealone/monitapi
agraffe async aws-lambda docusaurus2 fastapi gcp-cloud-functions python python3 serverless
Last synced: 2 months ago
JSON representation
monitapi is something to monitor API(URL) by a serverless.
- Host: GitHub
- URL: https://github.com/fealone/monitapi
- Owner: fealone
- License: gpl-3.0
- Created: 2020-10-13T01:45:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-30T05:10:00.000Z (10 months ago)
- Last Synced: 2025-04-06T15:12:41.366Z (3 months ago)
- Topics: agraffe, async, aws-lambda, docusaurus2, fastapi, gcp-cloud-functions, python, python3, serverless
- Language: Python
- Homepage: https://fealone.github.io/monitapi/
- Size: 1.37 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# monitapi
[](#contributors-)
---
## What is this
monitapi is something to monitor API(URL) by a serverless.
It supports hosting with FastAPI, running with CLI, and deploying to serverless.
## Getting Started
Please refer to the documents created by Docusaurus.
A rich README and website are in preparation.
https://fealone.github.io/monitapi
## Image of operating environment
### GCP
### AWS
### Installation
monitapi is made by Python, so can you install it via PyPI.
```shell
pip install monitapi
```
### Example targets file
```yaml
monitor_targets:
- github-monitapi
method: "GET"
url: https://github.com/fealone/monitapi
status_code: 200
timeout: 5
retry: 1
retry_wait: 5
notification_targets:
- notification-to-slack:
type: slack
endpoint: {Slack Incoming Webhooks endpoint}
payload:
blocks:
-
type: section
text:
type: mrkdwn
text: "Target: {{url}}, Status: {{status_code}}, Expect: {{expected_status_code}}, Message: {{message}}"
```
### Usage
#### One shot
```shell
monitapi monitor {targets.yaml}
```
#### Run with FastAPI
You need to put targets.yaml in the current directory.
```shell
monitapi serve
```
#### Deploy to serverless
```shell
monitapi deploy {platform} --name {function-name} --file {targets.yaml} --options {deploy-option}
```
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## License
This project is licensed under the GPLv3 License - see the [LICENSE](LICENSE) file for details
