A log anomaly detection framework
Project description
Alogamous
Table of Contents
Description
A Python program that can process log files and generate a daily report on anomalies in a set of logs.
- It should be able to read multiple files and output an html-formatted file.
- It should have multiple metrics/checks for anomalous log lines.
- It should be able to take in a log line format so that it knows how to extract useful information from a log line.
- It should be able to traverse a well-defined file system structure to access all logs.
- It should be able to generate metrics that span multiple files.
- It should be well-tested.
Installation
pip install alogamous
Development
Setup
-
Open a terminal
-
Install hatch
curl -Lo hatch-universal.pkg https://github.com/pypa/hatch/releases/latest/download/hatch-universal.pkg sudo installer -pkg ./hatch-universal.pkg -target /
-
Restart your terminal
Hatch modifies your system PATH variable, and this won't take effect unless you restart the terminal.
-
Make sure hatch works
hatch --version
-
Configure hatch
hatch config set dirs.env.virtual .venv
-
Clone the repo
git clone https://github.com/aquanauts/alogamous.git cd alogamous
-
Install pre-commit hooks
This will make sure certain checks are run when committing code.
hatch run pre-commit:install
-
Run the tests
hatch test
-
Setup your IDE
-
Sign up for a free JetBrains Educational License or buy one
-
Download Pycharm
- Depending on your platform you may need to download and install Python
-
Open Pycharm
-
Click Open on the welcome screen and then select the file alogamous
-
Possible Errors
Permission Error
-
Message: PermissionError: [Errno 13] Permission denied: '/usr/local/hatch/bin/hatch'
-
Fix by running:
sudo chmod a+r /usr/local/hatch/bin/hatch
License
alogamous
is distributed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for alogamous-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 74e19cbffec17edc8bd2d73911460f4f96caead45fecb353914445a82c15a3e1 |
|
MD5 | 29137ffebf34bbe523548304e82b7812 |
|
BLAKE2b-256 | 4bcdca6e320d138a945597629182151f91e05732a35dde72d0d36299444a5051 |