https://github.com/cored/http_log_monitor
https://github.com/cored/http_log_monitor
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/cored/http_log_monitor
- Owner: cored
- License: mit
- Created: 2018-11-05T14:35:34.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-20T14:44:17.000Z (over 7 years ago)
- Last Synced: 2025-02-21T12:35:12.823Z (over 1 year ago)
- Language: Ruby
- Size: 84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# HttpLogMonitor
[](https://codeclimate.com/github/cored/http_log_monitor/maintainability)
Monitor [common access](https://httpd.apache.org/docs/1.3/logs.html) logs to display useful statistics and report alerts.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'http_log_monitor'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install http_log_monitor
## Usage
```
Usages: bin/monitor ACCESS_LOG_PATH [options]
Specific options:
-a, --alerts-threshold Hit alert threshold
-t, --threshold Log retention threshold
-r, --refresh Time to refresh the monitor
-h, --help Display help
```
## Report Stats
```
Monitor Info
--------------------------------------------------
Threshold: 120
Alert Threshold: 10
Refresh Time: 10
--------------------------------------------------
Log Stats
--------------------------------------------------
Filename: test_access.log
Total lines processed: 5
Total bytes: 526.00 B
Avg bytes: 100.00 B
---------------------------------------------------
Sections Stats
---------------------------------------------------
Most hits: ["/user", 3]
Less hits: ["/report", 2]
---------------------------------------------------
HTTP Codes Stats
----------------------------------------------------
Code - Hits
200 - 4
503 - 1
----------------------------------------------------
Alerts
-----------------------------------------------------
No Alerts - Recover at 09:40:03 AM
```
## Configuration Settings
```
$ export MONITOR_REFRESH_TIME=10 # 10 by default
$ export MONITOR_ALERTS_THRESHOLD=500 # 500 by default
$ export MONITOR_THRESHOLD=120 # 120 by default
```
*Any of the environment variables will be overwritten by the options passed
through the command line*
## Features
- [x] Monitor a common log file and process statistics
- [x] Maintain the process running until manual user intervention
- [x] Display information for the section with the highest amount of hits
- [x] Check for past processed logs to triggered alerts base on the total amount of
hits
## Known Bugs & Improvements
- [ ] The amount of hits per seconds is not quantifying future hits after
processing for an alert
- [ ] Since the monitoring happens to fast the implementation is not using
a clock wall to calculate the amount of hits past 2 minutes, instead what
is doing is just to gather the total amount of hits across all seconds
prior to the point in time in which the calculation happen
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/cored/http_log_monitor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the HttpLogMonitor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cored/http_log_monitor/blob/master/CODE_OF_CONDUCT.md).