Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bukarinevg/servers-monitoring
Web Servers Monitoring system
https://github.com/bukarinevg/servers-monitoring
Last synced: 21 days ago
JSON representation
Web Servers Monitoring system
- Host: GitHub
- URL: https://github.com/bukarinevg/servers-monitoring
- Owner: bukarinevg
- License: apache-2.0
- Created: 2024-06-26T16:35:32.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-21T05:30:18.000Z (7 months ago)
- Last Synced: 2024-09-15T15:33:58.544Z (5 months ago)
- Language: PHP
- Size: 92.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# servers-monitoring
Web Servers Monitoring system
## Introduction
- System for monitoring HTTP web servers
## Features
- MVC architecture
- implemented PHP8 features as attributes, enums, types definition, etc.:
- Attributes: for validation request data and filtering methods of api requests
- Enums: for defining the constants and dictionaries data
- Implemented PSR-4 autoloading
- Handling api methods
- Handling errors according to the HTTP status codes and not appropiate requests
- API response in JSON format with required status codes and location headers for post requests
- CRON job for monitoring the servers runs every minute
- Asynchronous requests to the servers
- Email notifications for the server status changes
## Endpoints
- GET /get/:id - Get details of a specific server being monitored by its ID.
- GET /get-all - List all servers currently being monitored.
- GET /get-history/:id- Get the monitoring - history of a specific server within a given date range.
- POST /post - Add a new server to monitor.
- PUT /put/:id - Update the monitoring settings for a specific server by its ID.
- DELETE /delete/:id - Remove a server from monitoring by its ID.
## Installation
1. Clone the repository.
2. Run the following command to build the docker image and start the containers(`http://localhost:8080/`):
```bash
docker-compose up --build
```
3. Install the required packages:
```bash
composer install
```
4. Run the following command to create the tables and run the migrations (inside the container):
```bash
vendor/bin/phinx migrate -e development
```
## Usage
You can check all data in the database using phpmyadmin on `http://localhost:8888/` with username `user` and password `user`.
1. Load the postman collection from `postman/` folder.
2. Run the collection to test the endpoints.
3. To run the monitoring script run the following command:
```bash
php script.php
```
4. Add new users to email notifications in the `config/config.php` file.
## Project Structure
- `config/` - This directory contains configuration file.
- `db/` - This directory contains migrations.
- `db-dump/` - This directory contains the database dump file.
- `postman/` - This directory contains the postman collection.
- `docker-images/` - This directory contains Dockerfile images.
- `src/` - This directory contains the main application code.
- `controllers/` - This directory contains the controller classes performing route paths.
- `enums/` - This directory contains the enums classes (dictonaries data).
- `models/` - This directory contains the model classes.
- `source/` - Base code of application.
- `attribute/` - This directory contains the attributes.
- `controller/` - This directory contains the base controller class.
- `model/` - This directory contains the base model class.
`db/` - This directory contains DataBase settings Classes.
- `connectors/` - This directory contains DBConnectionInterface connectors Classes.
- `http/` - This directory contains Request Handler Classes.
- `services/` - This directory contains the services classes.
## DataBase Schema
- `web_server` - This table contains the servers to monitor.
- `web_server_work` - This table contains the monitor checks of the servers.