https://github.com/tsuru/healthcheck-as-a-service

tsuru service API for on demand web application monitoring.
https://github.com/tsuru/healthcheck-as-a-service

Last synced: 3 months ago
JSON representation

tsuru service API for on demand web application monitoring.

• Host: GitHub
• URL: https://github.com/tsuru/healthcheck-as-a-service
• Owner: tsuru
• License: bsd-3-clause
• Archived: true
• Created: 2013-10-24T17:55:28.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-05-01T20:19:01.000Z (about 1 year ago)
• Last Synced: 2024-01-08T01:45:11.211Z (6 months ago)
• Language: Python
• Homepage:
• Size: 209 KB
• Stars: 31
• Watchers: 25
• Forks: 16
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-tsuru - healthcheck-as-a-service - tsuru service API for on demand web application monitoring (Extensions / Services)

README

        
# healthcheck-as-a-service

[![Build Status](https://travis-ci.org/tsuru/healthcheck-as-a-service.png?branch=master)](https://travis-ci.org/tsuru/healthcheck-as-a-service)

This project is a http API to abstract healthcheck operations, like verify if a web application is working fine and notify to some users if some of this applications are in trouble.

## supported backends:

 * [zabbix](http://zabbix.com)

## configuring

* `API_URL` - the api base url

* `API_DEBUG` - enables the debug mode

### zabbix backend

* `ZABBIX_URL` - the zabbix api endpoint

* `ZABBIX_USER` - zabbix user

* `ZABBIX_PASSWORD` - zabbix password

* `ZABBIX_HOST_GROUP` - host group used to create the web monitoring

* `ZABBIX_HOST` - host used to create the web monitoring

### mongodb storage

* `MONGODB_DATABASE` - default is hcapi

* `MONGODB_URI` - mongodb full address

## deploying

### zabbix (optional)

    $ git clone [email protected]:zabbix/zabbix-docker.git

    $ cd zabbix-docker

    $ docker-compose -f docker-compose_v3_alpine_mysql_latest.yaml up -d

### hcaas

    $ git clone [email protected]:tsuru/healthcheck-as-a-service.git

    $ cd healthcheck-as-a-service

    $ tsuru app-create hcaas python

    $ tsuru env-set -a hcaas API_DEBUG=true ZABBIX_URL=$ZABBIX_URL MONGODB_URI=$MONGODB_URI

    $ tsuru app-deploy -a hcaas .

    $ export API_URL=$(tsuru app-info -a hcaas | grep Address: |awk '{print $2}')

## installing healthcheck tsuru plugin

    $ tsuru plugin-install hc /plugin

## using healthcheck tsuru plugin

### creating new service

edit `service.yaml` `endpoint:production` with hcaas address

    $ tsuru service create service.yaml

### creating a new healtcheck

    $ tsuru service-instance-add  

### removing a healthcheck

    $ tsuru service-instance-remove  

### adding a new url to be monitored

    $ tsuru hc add-url    [expected string]

## removing a url

    $ tsuru hc remove-url  

## adding a new watcher

    $ tsuru hc add-watcher   

## removing a watcher

    $ tsuru hc remove-watcher  

## listing service hostgroups

    $ tsuru hc list-service-groups  [search-keyword]

## adding instance to a hostgroup

    $ tsuru hc add-group   

## removing instance from a hostgroup

    $ tsuru hc-remove-group   

## listing instance hostgroups

    $ tsuru hc list-groups  

## development

 * [Source hosted at GitHub](http://github.com/tsuru/healthcheck-as-a-service)

 * [Report issues on GitHub Issues](http://github.com/tsuru/healthcheck-as-a-service/issues)

Pull requests are very welcomed! Make sure your patches are well tested.

### Running tests

If you are using a virtualenv, all you need is:

    $ make test