Service Monitor is a command line program that pings a http service to measure latency. Response times are printed as the pings return. Finally, some summary statistics of the ping run are calculated and printed.
The challenge was to create a greenfield ruby gem highlighting the following characteristics:
- Ruby gem
- Exposes a CLI to check the status of of a webpage (e.g. https://gitlab.com)
- Reports an average response time after probing the site every 10 seconds for a one minute.
- It should be to be maintainable in a long term by more than one maintainer.
By default, the cli service_monitor tool pings every 10 seconds for a
total duration of 60 seconds. Simply supply a hostname, like this:
$ service_monitor gitlab.com
273.1 ms
249.98 ms
254.63 ms
257.39 ms
256.32 ms
259.0 ms
count: 6 pings
errors: 0 errors
min: 249.98 ms
max: 273.1 ms
stddev: 7.15 ms
average: 258.4 ms
p95: 269.58 ms
p99: 272.4 ms
Usage information is as follows:
Service Monitor: Aggregate average response times for a http/s service.
Usage: service_monitor [options] <hostname>
Specific options:
--duration N Total duration in seconds of this
service testing cycle
--interval N Time in seconds between individual
service tests (pings).
--port N Port to target in ping test.
Default http is port 80 (http).
Use 443 for a https request.
-h, --help Show this message
To install the service_monitor program:
$ git clone https://gitlab.com/vevang/service_monitor.git
$ cd service_monitor/
$ bundle exec rake install
At this point you should be able to run service_monitor --help
If you want to use this gem as part of some other code, add this line to your application's Gemfile:
gem 'service_monitor', '~> 0.1.0' ,:git => "git@gitlab.com:vevang/service_monitor.git"And then execute:
$ bundle
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.
Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/vevang/service_monitor. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the ServiceMonitor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.