Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cainky/unixlogmonitor
Unix server log monitoring. Completed as part of a technical interview.
https://github.com/cainky/unixlogmonitor
log-monitor log-monitoring logging logging-facilities unix
Last synced: 2 months ago
JSON representation
Unix server log monitoring. Completed as part of a technical interview.
- Host: GitHub
- URL: https://github.com/cainky/unixlogmonitor
- Owner: cainky
- License: mit
- Created: 2023-07-03T12:22:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-06T00:39:00.000Z (11 months ago)
- Last Synced: 2024-02-06T18:25:31.966Z (11 months ago)
- Topics: log-monitor, log-monitoring, logging, logging-facilities, unix
- Language: Python
- Homepage:
- Size: 182 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# UnixLogMonitor
This project offers a solution for on-demand log monitoring across multiple unix-based servers. With this service, it is no longer necessary to individually access each server and manually open the log files located at /var/log. Instead, by sending a simple REST request to a server, you can easily retrieve its /var/log files. This makes tracking and debugging system events considerably more efficient and user-friendly.
## Installation and Setup
1. Install Python 3.10.x
2. [Install Poetry](https://python-poetry.org/docs/#installation) - Poetry is used for dependency management.
```bash
curl -sSL https://install.python-poetry.org | python -
```
3. Install the project dependencies
```bash
poetry install
```
4. Run the server
```bash
poetry run python app.py
```
Alternatively you can use ```poetry shell``` to activate the environment and run python commands as you normally would: ```python app.py```
## Usage
Make a GET request to `/logs` to retrieve logs from `/var/log`. You can use the following query parameters:
- `filename`: Specify a filename within `/var/log`.
- `term`: Filter results based on this text/keyword.
- `limit`: Specify the last n number of matching entries to retrieve within the log.
For example:
```bash
curl http://localhost:5000/logs?filename=syslog&term=error&limit=5
```
## Project Files and Directories
```
.
├── .env # Environment variables
├── README.md # This file
├── app.py # The main application script
├── views # Request & response handling
└── tests # Tests for the app
└── var
└── log # Directory for local testing of logs
```
#### `.env`
Be sure to create this file for local testing and development.
You can use the ```.env.example``` file to help you get started, just rename it to ```.env```
This file contains environment variables for local development. It is read by `dotenv.load_dotenv()` at the start of `app.py`.
The environment variables are:
- `TESTING`: Determines whether the app is running in a local development environment. If `True`, the app will read from the local `tests/var/log` directory for log files. If `False` or not set, the app will read from `/var/log`.
#### `README.md`
This file provides information about the project, including this description of the file structure.
#### `app.py`
This is the main script for the Flask application. It defines the route for the log reading API and handles requests to that route. The log reading functionality is controlled by environment variables.
#### `tests/var/log`
This directory is used for local testing of the log reading functionality. When `TESTING` is `True`, the app will attempt to read log files from this directory. You can place any files you want to test with in this directory.
## Running the Tests
```bash
poetry run python -m unittest
```
## Contributing
Please open an issue to discuss potential contributions before submitting a pull request.
## License
This project is licensed under the terms of the MIT license.