https://github.com/foomo/petze
monitor web services and report, if they are not working
https://github.com/foomo/petze
elk http-monitor logrus prometheus
Last synced: 3 months ago
JSON representation
monitor web services and report, if they are not working
- Host: GitHub
- URL: https://github.com/foomo/petze
- Owner: foomo
- License: mit
- Created: 2015-12-22T11:58:11.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-11-25T21:25:57.000Z (about 4 years ago)
- Last Synced: 2024-11-04T17:47:46.218Z (4 months ago)
- Topics: elk, http-monitor, logrus, prometheus
- Language: Go
- Homepage:
- Size: 733 KB
- Stars: 5
- Watchers: 18
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/foomo/petze)
# Petze
**Petze monitors web sites and services**.
It exports [prometheus](https://prometheus.io) metrics and writes [logrus](https://github.com/sirupsen/logrus) logs.
Additionally, petze offers a convenient way to receive notifications via [EMail](#SMTP-Integration), [Slack](#Slack-Integration) or [SMS](#SMS-Integration),
without the need to operate a big enterprise monitoring stack.
One instance of petze is designed to monitor many services at little cost.
# Motivation
While there is a vast amount of monitoring solutions out there I still felt there was something simplistic missing, that would play nicely with [prometheus.io](https://prometheus.io), which I have come to appreciate very much.
# Status
As of June 2017 we have a first working version and we are trying to get the configs right - feedback and contributions are most welcome!
# Configuration
Petze is configured through a set of yaml configuration files. The path to folder containing the configuration is passed to petze as the first argument on the commandline.
```bash
$ petze path/to/petzconf
```
Take a look at a simple example config: https://github.com/foomo/petze/tree/master/exampleConfig
## Configuration layout
The configuration file for petze is called: **petze.yml**.
It provides information for the petze service, as well the configuration for your notifications.
## Main config file petze.yml
```yaml
# HTTP endpoint for prometheus metrics
address: server-name.net:8080
# optional basic auth
basicauthfile: path/to/basic-auth-file
# optional: running with TLS
tls:
address: server-name:8443
cert: path/to/cert.pem
key: path/to/key.pem
## Notifications
# optional: notification via slack webhooks
slack: https://hooks.slack.com/services/custom-parameters
# optional: configure SMTP notifications
smtp:
server: smtp-relay.yourprovider.com
user: [email protected]
pass: yourpassword
port: 465
from: [email protected]
to: [email protected]
# optional: SMS notifications
sms:
twilioSID: "yourTwilioSID"
twilioToken: "yourTwilioToken"
from: "+49123456789"
to:
- "+491234567891" # person 1
- "+491234567892" # person 2
```
## Service configuration files
Any other files with a .yml suffix will be treated as service configurations.
It is strongly encouraged to organize them in folder structures.
These will be reflected in the service ids.
```yaml
# the service base URL
endpoint: http://www.bestbytes.de
# interval of the health checks
interval: 5m
# overwrite the default warning of one week before expiry for this service
tlsWarning: 128h
# want to get a heads up once things are back to normal?
# default is false!
# if you set this to true all configured notification providers
# will be used to send a status update once the service checks pass again
notifyIfResolved: true
# service health check sessions
# each session will preserve all cookies that have been set during checks
session:
- uri: "/"
comment: home page visit
check:
- statusCode: 200
- duration: 200ms
- goQuery:
".body div.test":
min: 3
- method: POST
comment: this is how you perform XHR requests
uri: "/path/to/a/rest/service?foo=bar"
contentType: application/json
headers:
"X-Test": ["foo"]
data:
foo: bar
check:
- contentType: application/json
- duration: 100ms
- headers:
"X-Test": "foo"
- jsonPath:
# this is a json path expression
"$[0].product.images+":
min: 1
- uri: "/another/path"
check:
- duration: 100ms
# match the location for checking redirects
- redirect: "https://myservice.com/asdf"
# match the raw response string
- matchReply: "asdf"
```
## SMTP Integration
You can now get notifications by Mail, all you need to provide is an SMTP server!
A summary email with all errors for a service will be generated, in case a check failed.
Add the following to your petze.yml:
```yaml
# configure SMTP notifications
smtp:
server: smtp-relay.yourprovider.com
user: [email protected]
pass: yourpassword
port: 465
from: [email protected]
# enter multiple emails to notify if desired
to:
- [email protected]
- [email protected]
```
## Slack Integration
Using slack incoming webhooks, we can post messages to a slack channel
by simply creating a slack app and enabling the incoming webhook:
https://api.slack.com/messaging/webhooks
1) Add a new App to your Slack workspace
2) Go to the Apps Settings and enable Webhooks
3) Select a channel to notify and generate a new webhook URL
Then add your newly generated webhook URL to your petze.yml:
```yaml
slack: https://hooks.slack.com/services/custom-parameters
```
## SMS Integration
SMS notifications are also supported, currently we have an integration for [twilio](https://twilio.com) and [sendinblue](https://sendinblue.com).
## Twilio
_petze.yml_:
```yaml
sms:
twilioSID: "yourTwilioSID"
twilioToken: "yourTwilioToken"
from: "+49123456789"
to:
- "+491234567891" # person 1
- "+491234567892" # person 2
```
## SendInBlue
_petze.yml_:
```yaml
sms:
sendInBlueAPIKey: "yourSendInBlueAPIKey"
from: "+49123456789"
to:
- "+491234567891" # person 1
- "+491234567892" # person 2
```
## Docker Usage
Prepare your config folder and move it to: /etc/petzconf.
The repository contains an example configuration in the _exampleConfig_ folder.
Then pull and start the container, mounting the config folder into the container:
```bash
$ docker pull foomo/petze
$ docker run -v /etc/petzconf:/etc/petzconf foomo/petze
```
Happy monitoring!