Monitoring tool for Hogosha Service that can be used as a standalone tool as a simple ping program.
Currently in development but ready to use in production
composer global require hogosha/monitorIf it is the first time you globally install a dependency then make sure
you include ~/.composer/vendor/bin in $PATH as shown here.
Keep Hogosha Monitor up-to-date
composer global update hogosha/monitorcomposer require hogosha/monitorDownload the last PHAR file from the release panel
VERSION=master; curl -LO "https://raw.githubusercontent.com/hogosha/monitor/$VERSION/build/monitor.phar"
chmod u+x monitor.phar
mv monitor.phar /usr/local/bin/hogosha-monitorOr build it manually
git clone https://github.com/hogosha/monitor.git
composer install
bin/compile
mv monitor.phar /usr/local/bin/hogosha-monitorCreate the configuration file:
hogosha-monitor initor change the directory
hogosha-monitor init -c $HOMEThis will create an yml file with this configuration:
urls:
google: #this has to be unique
url: 'https://www.google.fr'
method: GET
headers: { Accept: text/html }
timeout: 1
validator: { }
status_code: 200 #status expectedThen run the tool
hogosha-monitor run -c $HOMEOutput - List
[OK][200] google - 0.267724Output - Table
+---------------+-------------+---------+---------------+----------------+---------------------+
| Global Status | Status Code | Name | Response Time | Http Error Log | Validator Error Log |
+---------------+-------------+---------+---------------+----------------+---------------------+
| OK | 200 | thefork | 0.274106 | | |
+---------------+-------------+---------+---------------+----------------+---------------------+Output - Csv
"Global Status","Status Code",Name,"Reponse Time","Http Error Log","Validator Error Log"
OK,200,thefork,0.307092,,Sometimes we need more than just status codes. So we introduced a validator system for html, xml and json so you can test a existing string.
Html Validator
urls:
google:
url: 'https://www.google.fr'
method: GET
headers: { Accept: text/html }
timeout: 1
validator:
type: html
match: /images/ #regex will be
status_code: 200 #status expectedJson Validator
Json example:
{"name": "Chuck Norris"}urls:
google:
url: 'https://www.example.org/names.json'
method: GET
headers: { Accept: text/json }
timeout: 1
validator:
type: json
match: name #we use property accessor
status_code: 200 #status expectedXml Validator
Xml example:
<?xml version="1.0"?>
<root>
<name>chuck</name>
</root>urls:
google:
url: 'https://www.example.org/test.xml'
method: GET
headers: { Accept: text/xml }
timeout: 1
validator:
type: xml
match: //name #use xpath selector
status_code: 200 #status expectedOnce you have configured the hogosha portal, you need to add this configuration in your yaml
urls:
google:
url: 'https://www.google.fr'
method: GET
headers: { Accept: text/html }
timeout: 1
status_code: 200 #status expected
metric_uuid: ec9e5ba7-9136-4b67-b049-a969e8e6dcde # Metric uuid you can find in the hogosha portal
service_uuid: 9e231852-5343-4653-81c8-f52ee223d3d2 # Service monitored by the hogosha portal
hogosha_portal:
username: admin
password: admin
base_uri: http://localhost:8000/api/
metric_update: true # Update metric graph
incident_update: true #create an incident when there is a problem and update it when there is one to resolve
default_failed_incident_message: "An error as occured, we are investigating %service_name%",
default_resolved_incident_message: "The service %service_name% is back to normal"- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
- Connnect to the hogosha portal
- Collect metric to the hogosha portal metric system
- Automatic incident update when failing
- Automatic service resolver
- Refacto
Thanks to Silex project for the compiler file.
Hogosha Monitor is licensed under the MIT License - see the LICENSE file for details