https://github.com/michael-lazar/akita
:dog2: An HTTP log monitoring tool for your terminal
https://github.com/michael-lazar/akita
Last synced: 2 months ago
JSON representation
:dog2: An HTTP log monitoring tool for your terminal
- Host: GitHub
- URL: https://github.com/michael-lazar/akita
- Owner: michael-lazar
- License: mit
- Created: 2018-03-23T23:30:25.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-10T22:18:49.000Z (over 5 years ago)
- Last Synced: 2025-04-10T08:08:08.529Z (2 months ago)
- Language: Python
- Homepage:
- Size: 237 KB
- Stars: 22
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Akita
*Akita* is a local HTTP log monitoring tool that runs in your terminal. With Akita, you can view a summary of you webserver's activity in real-time. All server access logs that use the [Common Log Format](https://en.wikipedia.org/wiki/Common_Log_Format) are supported, including Apache and Nginx.
*Akita* is also a breed of dog originating from the mountainous northern regions of Japan. The Akita is courageous, a natural guardian of his family. Stubborn and willful, he won't back down from a challenge. [[0]](http://dogtime.com/dog-breeds/akita)
## Installation
Akita is available on [PyPI](https://pypi.python.org/pypi/akita/) and can be installed using pip:
```bash
# Requires python 3!
$ pip install akita
```
Alternatively, you can clone the repository and run the code directly:
```bash
$ git clone https://github.com/michael-lazar/Akita.git
$ cd Akita
$ python -m akita
```
## Usage
Launch Akita by pointing it at the server access log file that you want to monitor:
```bash
$ akita /var/log/apache/access.log
```
You can also provide a stream via a unix pipe:
```bash
$ tail -n 1 -f /var/log/apache/access.log | akita -
```
If you want to try running Akita but you don't have a webserver to point it to, you can use the [apache-loggen](https://github.com/tamtam180/apache_log_gen) command line tool to generate fake log data.
```bash
$ gem install apache-loggen
$ apache-loggen --rate=10 | akita -
```
## Options
```bash
$ akita --help
usage: akita [--help] [--version] FILE
/ \ _-'
_/| \-''- _ /
__-' { | \
/ \
/ "o. |o } Akita - Terminal HTTP Log Monitoring
| \ ;
',
\_ __\
''-_ \.//
/ '-____'
/
_'
_-'
positional arguments:
FILE A log file to watch, use "-" to pipe from stdin
optional arguments:
-h, --help show this help message and exit
--alert-threshold ALERT_THRESHOLD
High traffic alert threshold, requests/second
--alert-window ALERT_WINDOW
High traffic alert window, in seconds
-V, --version show program's version number and exit
```
## Testing
This repository is continuously tested on [TravisCI](https://travis-ci.org/michael-lazar/Akita), but you can also run the test suite locally:
```bash
$ git clone https://github.com/michael-lazar/Akita.git
$ cd Akita
$ pip install .[test] # Installs pytest
$ env PYTHONPATH=. py.test -v
```
## License
This project is distributed under the [MIT](LICENSE) license.