mirror of
https://github.com/mtan93/cachet-url-monitor.git
synced 2026-03-08 05:31:58 +00:00
Compare commits
80 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b3e4000cc1 | ||
|
|
e132f8660b | ||
|
|
9e5d42f8b8 | ||
|
|
cb6f405e82 | ||
|
|
a296cfc1aa | ||
|
|
9569818bb0 | ||
|
|
3af53ce9b6 | ||
|
|
eae51967c4 | ||
|
|
f1e69bf39b | ||
|
|
393aaa0b30 | ||
|
|
950ef86f33 | ||
|
|
fbc87b7846 | ||
|
|
10e0141454 | ||
|
|
ea4b8ccd4e | ||
|
|
200b255e6b | ||
|
|
300ac29a24 | ||
|
|
609cc57fd9 | ||
|
|
36f4ef6cee | ||
|
|
8fc0f7c77f | ||
|
|
54cfda3177 | ||
|
|
a9035362b9 | ||
|
|
2c354b0960 | ||
|
|
5b6c34741a | ||
|
|
29eb92790f | ||
|
|
1f1bab6398 | ||
|
|
79bb5c5c3a | ||
|
|
57fc100d49 | ||
|
|
5cfef6392e | ||
|
|
68a5609abc | ||
|
|
028488b503 | ||
|
|
4c336ec714 | ||
|
|
2adb5ca095 | ||
|
|
d3c14e6491 | ||
|
|
1899e95642 | ||
|
|
726f5377b1 | ||
|
|
9e66736f48 | ||
|
|
5e5e74938b | ||
|
|
350d125d26 | ||
|
|
0b1e83eae1 | ||
|
|
8ce89e452f | ||
|
|
284ef97168 | ||
|
|
22d032308f | ||
|
|
da7568300e | ||
|
|
fd0cca2060 | ||
|
|
ffa141d114 | ||
|
|
ab9957761c | ||
|
|
6c1b95961e | ||
|
|
c36e42ea11 | ||
|
|
19e6811900 | ||
|
|
cf43e568b1 | ||
|
|
f7381aa2bc | ||
|
|
cfd0ddcb2b | ||
|
|
a055e0b76d | ||
|
|
0ed87469ce | ||
|
|
bdd74a89c7 | ||
|
|
cb5137c526 | ||
|
|
3830063ba4 | ||
|
|
e4bd02c44f | ||
|
|
e8d4b88c79 | ||
|
|
9f3e2b6eff | ||
|
|
740f726b48 | ||
|
|
a147adda35 | ||
|
|
c59126fd0f | ||
|
|
9ccdc7e5c3 | ||
|
|
96346926cd | ||
|
|
194a07c403 | ||
|
|
fe0325dc9e | ||
|
|
23326fd828 | ||
|
|
969a2b1580 | ||
|
|
b018f9e675 | ||
|
|
d63420ac01 | ||
|
|
a3a91edadc | ||
|
|
2c01d8eb30 | ||
|
|
a83abfd1d3 | ||
|
|
ca358eab2b | ||
|
|
0f53ff8678 | ||
|
|
9c8c89c1dd | ||
|
|
9051f2d9b3 | ||
|
|
15dc800c9b | ||
|
|
8fce82b721 |
56
.circleci/config.yml
Normal file
56
.circleci/config.yml
Normal file
@@ -0,0 +1,56 @@
|
||||
# Python CircleCI 2.0 configuration file
|
||||
#
|
||||
# Check https://circleci.com/docs/2.0/language-python/ for more details
|
||||
#
|
||||
version: 2
|
||||
jobs:
|
||||
build:
|
||||
docker:
|
||||
# specify the version you desire here
|
||||
# use `-browsers` prefix for selenium tests, e.g. `3.6.1-browsers`
|
||||
- image: circleci/python:3.7.2
|
||||
|
||||
working_directory: ~/repo
|
||||
|
||||
steps:
|
||||
- checkout
|
||||
|
||||
# Download and cache dependencies
|
||||
- restore_cache:
|
||||
keys:
|
||||
- v1-dependencies-{{ checksum "dev_requirements.txt" }}
|
||||
# fallback to using the latest cache if no exact match is found
|
||||
- v1-dependencies-
|
||||
|
||||
- run:
|
||||
name: install dependencies
|
||||
command: |
|
||||
sudo pip3 install virtualenv
|
||||
virtualenv .
|
||||
source bin/activate
|
||||
pip3 install -r dev_requirements.txt
|
||||
pip3 install -r requirements.txt
|
||||
python3 setup.py install
|
||||
pip3 install coveralls
|
||||
|
||||
- save_cache:
|
||||
paths:
|
||||
- ./venv
|
||||
key: v1-dependencies-{{ checksum "dev_requirements.txt" }}
|
||||
|
||||
- run:
|
||||
name: run tests
|
||||
command: |
|
||||
. bin/activate
|
||||
py.test tests --junitxml=test-reports/junit.xml --cov=cachet_url_monitor
|
||||
coveralls
|
||||
coverage xml
|
||||
python-codacy-coverage -r coverage.xml
|
||||
|
||||
- store_test_results:
|
||||
path: test-reports
|
||||
|
||||
- store_artifacts:
|
||||
path: test-reports
|
||||
destination: test-reports
|
||||
|
||||
5
.gitignore
vendored
5
.gitignore
vendored
@@ -10,3 +10,8 @@ share/
|
||||
*.egg-info
|
||||
MANIFEST
|
||||
dist/
|
||||
.idea
|
||||
.pytest_cache/
|
||||
pip-selfcheck.json
|
||||
.eggs
|
||||
test-reports/
|
||||
|
||||
14
Dockerfile
14
Dockerfile
@@ -1,7 +1,17 @@
|
||||
FROM python:2-onbuild
|
||||
FROM python:3.7.2-alpine
|
||||
MAINTAINER Mitsuo Takaki <mitsuotakaki@gmail.com>
|
||||
|
||||
WORKDIR /usr/src/app
|
||||
|
||||
RUN python3.7 -m pip install --upgrade pip
|
||||
COPY requirements.txt ./
|
||||
RUN pip3 install --no-cache-dir -r requirements.txt
|
||||
|
||||
COPY cachet_url_monitor/*.py /usr/src/app/cachet_url_monitor/
|
||||
COPY setup.py /usr/src/app/
|
||||
RUN python3.7 setup.py install
|
||||
|
||||
COPY config.yml /usr/src/app/config/
|
||||
VOLUME /usr/src/app/config/
|
||||
|
||||
ENTRYPOINT ["python", "cachet_url_monitor/scheduler.py", "config/config.yml"]
|
||||
CMD ["python3.7", "./cachet_url_monitor/scheduler.py", "config/config.yml"]
|
||||
|
||||
61
README.md
61
README.md
@@ -1,7 +1,11 @@
|
||||
# Status
|
||||

|
||||
[](https://circleci.com/gh/mtakaki/cachet-url-monitor/tree/master)
|
||||
[](https://coveralls.io/github/mtakaki/cachet-url-monitor?branch=master)
|
||||
[](https://www.codacy.com/app/mitsuotakaki/cachet-url-monitor?utm_source=github.com&utm_medium=referral&utm_content=mtakaki/cachet-url-monitor&utm_campaign=Badge_Grade)
|
||||
[](https://hub.docker.com/r/mtakaki/cachet-url-monitor/)
|
||||
[](https://hub.docker.com/r/mtakaki/cachet-url-monitor/)
|
||||

|
||||
[](https://pypi.python.org/pypi/cachet-url-monitor)
|
||||
|
||||
cachet-url-monitor
|
||||
========================
|
||||
@@ -15,69 +19,98 @@ This project is available at PyPI: [https://pypi.python.org/pypi/cachet-url-moni
|
||||
endpoint:
|
||||
url: http://www.google.com
|
||||
method: GET
|
||||
timeout: 0.010 # seconds
|
||||
header:
|
||||
SOME-HEADER: SOME-VALUE
|
||||
timeout: 1 # seconds
|
||||
expectation:
|
||||
- type: HTTP_STATUS
|
||||
status: 200
|
||||
status_range: 200-300
|
||||
incident: MAJOR
|
||||
- type: LATENCY
|
||||
threshold: 1
|
||||
- type: REGEX
|
||||
regex: ".*<body>.*"
|
||||
allowed_fails: 0
|
||||
cachet:
|
||||
api_url: http://status.cachethq.io/api/v1/
|
||||
api_url: http://status.cachethq.io/api/v1
|
||||
token: my_token
|
||||
component_id: 1
|
||||
metric_id: 1
|
||||
action:
|
||||
- CREATE_INCIDENT
|
||||
- UPDATE_STATUS
|
||||
public_incidents: true
|
||||
latency_unit: ms
|
||||
frequency: 30
|
||||
```
|
||||
|
||||
- **endpoint**, the configuration about the URL that will be monitored.
|
||||
- **url**, the URL that is going to be monitored.
|
||||
- **method**, the HTTP method that will be used by the monitor.
|
||||
- **header**, client header passed to the request. Remove if you do not want to pass a header.
|
||||
- **timeout**, how long we'll wait to consider the request failed. The unit of it is seconds.
|
||||
- **expectation**, the list of expectations set for the URL.
|
||||
- **HTTP_STATUS**, we will verify if the response status code matches what we expect.
|
||||
- **HTTP_STATUS**, we will verify if the response status code falls into the expected range. Please keep in mind the range is inclusive on the first number and exclusive on the second number. If just one value is specified, it will default to only the given value, for example `200` will be converted to `200-201`.
|
||||
- **LATENCY**, we measure how long the request took to get a response and fail if it's above the threshold. The unit is in seconds.
|
||||
- **REGEX**, we verify if the response body matches the given regex.
|
||||
- **allowed_fails**, create incident/update component status only after specified amount of failed connection trials.
|
||||
- **cachet**, this is the settings for our cachet server.
|
||||
- **api_url**, the cachet API endpoint.
|
||||
- **token**, the API token.
|
||||
- **component_id**, the id of the component we're monitoring. This will be used to update the status of the component.
|
||||
- **metric_id**, this will be used to store the latency of the API. If this is not set, it will be ignored.
|
||||
- **action**, the action to be done when one of the expectations fails. This is optional and if left blank, nothing will be done to the component.
|
||||
- **CREATE_INCIDENT**, we will create an incident when the expectation fails.
|
||||
- **UPDATE_STATUS**, updates the component status
|
||||
- **public_incidents**, boolean to decide if created incidents should be visible to everyone or only to logged in users. Important only if `CREATE_INCIDENT` or `UPDATE_STATUS` are set.
|
||||
- **latency_unit**, the latency unit used when reporting the metrics. It will automatically convert to the specified unit. It's not mandatory and it will default to **seconds**. Available units: `ms`, `s`, `m`, `h`.
|
||||
- **frequency**, how often we'll send a request to the given URL. The unit is in seconds.
|
||||
|
||||
Each `expectation` has their own default incident status. It can be overridden by setting the `incident` property to any of the following values:
|
||||
- `PARTIAL`
|
||||
- `MAJOR`
|
||||
- `PERFORMANCE`
|
||||
|
||||
By choosing any of the aforementioned statuses, it will let you control the kind of incident it should be considered. These are the default incident status for each `expectation` type:
|
||||
|
||||
| Expectation | Incident status |
|
||||
| ----------- | --------------- |
|
||||
| HTTP_STATUS | PARTIAL |
|
||||
| LATENCY | PERFORMANCE |
|
||||
| REGEX | PARTIAL |
|
||||
|
||||
## Setting up
|
||||
|
||||
The application should be installed using **virtualenv**, through the following command:
|
||||
|
||||
```
|
||||
$ git clone git@github.com:mtakaki/cachet-url-monitor.git
|
||||
$ git clone https://github.com/mtakaki/cachet-url-monitor.git
|
||||
$ virtualenv cachet-url-monitor
|
||||
$ cd cachet-url-monitor
|
||||
$ source bin/activate
|
||||
$ pip install -r requirements.txt
|
||||
$ python3 setup.py install
|
||||
```
|
||||
|
||||
To start the agent:
|
||||
|
||||
```
|
||||
$ python cachet_url_monitor/scheduler.py config.yml
|
||||
$ python3 cachet_url_monitor/scheduler.py config.yml
|
||||
```
|
||||
|
||||
## Docker
|
||||
|
||||
You can run the agent in docker, so you won't need to worry about installing python, virtualenv, or any other dependency into your OS. The `Dockerfile` and `docker-compose.yml` files are already checked in and it's ready to be used.
|
||||
You can run the agent in docker, so you won't need to worry about installing python, virtualenv, or any other dependency into your OS. The `Dockerfile` is already checked in and it's ready to be used.
|
||||
|
||||
To start the agent in a container using docker compose:
|
||||
You have two choices, checking this repo out and building the docker image or it can be pulled directly from [dockerhub](https://hub.docker.com/r/mtakaki/cachet-url-monitor/). You will need to create your own custom `config.yml` file and run (it will pull latest):
|
||||
|
||||
```
|
||||
$ docker-compose build
|
||||
$ docker-compose up
|
||||
$ docker pull mtakaki/cachet-url-monitor
|
||||
$ docker run --rm -it -v "$PWD":/usr/src/app/config/ mtakaki/cachet-url-monitor
|
||||
```
|
||||
|
||||
Or pulling directly from [dockerhub](https://hub.docker.com/r/mtakaki/cachet-url-monitor/). You will need to create your own custom `config.yml` file and put it in a folder (`my_config`):
|
||||
If you're going to use a file with a name other than `config.yml`, you will need to map the local file, like this:
|
||||
|
||||
```
|
||||
$ docker pull mtakaki/cachet-url-monitor:0.1
|
||||
$ docker run --rm -it -v my_config/:/usr/src/app/config/ mtakaki/cachet-url-monitor:0.1
|
||||
$ docker run --rm -it -v "$PWD"/my_config.yml:/usr/src/app/config/config.yml:ro mtakaki/cachet-url-monitor
|
||||
```
|
||||
|
||||
@@ -1,22 +1,30 @@
|
||||
#!/usr/bin/env python
|
||||
import abc
|
||||
import copy
|
||||
import logging
|
||||
import os
|
||||
import re
|
||||
import requests
|
||||
import time
|
||||
from yaml import load
|
||||
|
||||
import requests
|
||||
from yaml import dump
|
||||
from yaml import load
|
||||
from yaml import FullLoader
|
||||
|
||||
import cachet_url_monitor.latency_unit as latency_unit
|
||||
import cachet_url_monitor.status as st
|
||||
|
||||
# This is the mandatory fields that must be in the configuration file in this
|
||||
# same exact structure.
|
||||
configuration_mandatory_fields = {
|
||||
'endpoint': ['url', 'method', 'timeout', 'expectation'],
|
||||
'cachet': ['api_url', 'token', 'component_id'],
|
||||
'frequency': []}
|
||||
'endpoint': ['url', 'method', 'timeout', 'expectation'],
|
||||
'cachet': ['api_url', 'token', 'component_id'],
|
||||
'frequency': []}
|
||||
|
||||
|
||||
class ConfigurationValidationError(Exception):
|
||||
"""Exception raised when there's a validation error."""
|
||||
|
||||
def __init__(self, value):
|
||||
self.value = value
|
||||
|
||||
@@ -24,30 +32,123 @@ class ConfigurationValidationError(Exception):
|
||||
return repr(self.value)
|
||||
|
||||
|
||||
class ComponentNonexistentError(Exception):
|
||||
"""Exception raised when the component does not exist."""
|
||||
|
||||
def __init__(self, component_id):
|
||||
self.component_id = component_id
|
||||
|
||||
def __str__(self):
|
||||
return repr(f'Component with id [{self.component_id}] does not exist.')
|
||||
|
||||
|
||||
class MetricNonexistentError(Exception):
|
||||
"""Exception raised when the component does not exist."""
|
||||
|
||||
def __init__(self, metric_id):
|
||||
self.metric_id = metric_id
|
||||
|
||||
def __str__(self):
|
||||
return repr(f'Metric with id [{self.metric_id}] does not exist.')
|
||||
|
||||
|
||||
def get_current_status(endpoint_url, component_id, headers):
|
||||
"""Retrieves the current status of the component that is being monitored. It will fail if the component does
|
||||
not exist or doesn't respond with the expected data.
|
||||
:return component status.
|
||||
"""
|
||||
get_status_request = requests.get(f'{endpoint_url}/components/{component_id}', headers=headers)
|
||||
|
||||
if get_status_request.ok:
|
||||
# The component exists.
|
||||
return int(get_status_request.json()['data']['status'])
|
||||
else:
|
||||
raise ComponentNonexistentError(component_id)
|
||||
|
||||
|
||||
def normalize_url(url):
|
||||
"""If passed url doesn't include schema return it with default one - http."""
|
||||
if not url.lower().startswith('http'):
|
||||
return f'http://{url}'
|
||||
return url
|
||||
|
||||
|
||||
class Configuration(object):
|
||||
"""Represents a configuration file, but it also includes the functionality
|
||||
of assessing the API and pushing the results to cachet.
|
||||
"""
|
||||
|
||||
def __init__(self, config_file):
|
||||
#TODO(mtakaki#1|2016-04-28): Accept overriding settings using environment
|
||||
# variables so we have a more docker-friendly approach.
|
||||
self.logger = logging.getLogger('cachet_url_monitor.configuration.Configuration')
|
||||
self.config_file = config_file
|
||||
self.data = load(file(self.config_file, 'r'))
|
||||
self.data = load(open(self.config_file, 'r'), Loader=FullLoader)
|
||||
self.current_fails = 0
|
||||
self.trigger_update = True
|
||||
|
||||
# Exposing the configuration to confirm it's parsed as expected.
|
||||
self.print_out()
|
||||
|
||||
# We need to validate the configuration is correct and then validate the component actually exists.
|
||||
self.validate()
|
||||
|
||||
self.logger.info('Monitoring URL: %s %s' %
|
||||
(self.data['endpoint']['method'], self.data['endpoint']['url']))
|
||||
self.expectations = [Expectaction.create(expectation) for expectation
|
||||
in self.data['endpoint']['expectation']]
|
||||
# We store the main information from the configuration file, so we don't keep reading from the data dictionary.
|
||||
self.headers = {'X-Cachet-Token': os.environ.get('CACHET_TOKEN') or self.data['cachet']['token']}
|
||||
|
||||
self.endpoint_method = os.environ.get('ENDPOINT_METHOD') or self.data['endpoint']['method']
|
||||
self.endpoint_url = os.environ.get('ENDPOINT_URL') or self.data['endpoint']['url']
|
||||
self.endpoint_url = normalize_url(self.endpoint_url)
|
||||
self.endpoint_timeout = os.environ.get('ENDPOINT_TIMEOUT') or self.data['endpoint'].get('timeout') or 1
|
||||
self.endpoint_header = self.data['endpoint'].get('header') or None
|
||||
self.allowed_fails = os.environ.get('ALLOWED_FAILS') or self.data['endpoint'].get('allowed_fails') or 0
|
||||
|
||||
self.api_url = os.environ.get('CACHET_API_URL') or self.data['cachet']['api_url']
|
||||
self.component_id = os.environ.get('CACHET_COMPONENT_ID') or self.data['cachet']['component_id']
|
||||
self.metric_id = os.environ.get('CACHET_METRIC_ID') or self.data['cachet'].get('metric_id')
|
||||
|
||||
if self.metric_id is not None:
|
||||
self.default_metric_value = self.get_default_metric_value(self.metric_id)
|
||||
|
||||
# The latency_unit configuration is not mandatory and we fallback to seconds, by default.
|
||||
self.latency_unit = os.environ.get('LATENCY_UNIT') or self.data['cachet'].get('latency_unit') or 's'
|
||||
|
||||
# We need the current status so we monitor the status changes. This is necessary for creating incidents.
|
||||
self.status = get_current_status(self.api_url, self.component_id, self.headers)
|
||||
self.previous_status = self.status
|
||||
|
||||
# Get remaining settings
|
||||
self.public_incidents = int(
|
||||
os.environ.get('CACHET_PUBLIC_INCIDENTS') or self.data['cachet']['public_incidents'])
|
||||
|
||||
self.logger.info('Monitoring URL: %s %s' % (self.endpoint_method, self.endpoint_url))
|
||||
self.expectations = [Expectation.create(expectation) for expectation in self.data['endpoint']['expectation']]
|
||||
for expectation in self.expectations:
|
||||
self.logger.info('Registered expectation: %s' % (expectation,))
|
||||
self.headers = {'X-Cachet-Token': self.data['cachet']['token']}
|
||||
|
||||
def get_default_metric_value(self, metric_id):
|
||||
"""Returns default value for configured metric."""
|
||||
get_metric_request = requests.get('%s/metrics/%s' % (self.api_url, metric_id), headers=self.headers)
|
||||
|
||||
if get_metric_request.ok:
|
||||
return get_metric_request.json()['data']['default_value']
|
||||
else:
|
||||
raise MetricNonexistentError(metric_id)
|
||||
|
||||
def get_action(self):
|
||||
"""Retrieves the action list from the configuration. If it's empty, returns an empty list.
|
||||
:return: The list of actions, which can be an empty list.
|
||||
"""
|
||||
if self.data['cachet'].get('action') is None:
|
||||
return []
|
||||
else:
|
||||
return self.data['cachet']['action']
|
||||
|
||||
def validate(self):
|
||||
"""Validates the configuration by verifying the mandatory fields are
|
||||
present and in the correct format. If the validation fails, a
|
||||
ConfigurationValidationError is raised. Otherwise nothing will happen.
|
||||
"""
|
||||
configuration_errors = []
|
||||
for key, sub_entries in configuration_mandatory_fields.iteritems():
|
||||
for key, sub_entries in configuration_mandatory_fields.items():
|
||||
if key not in self.data:
|
||||
configuration_errors.append(key)
|
||||
|
||||
@@ -58,14 +159,13 @@ class Configuration(object):
|
||||
if ('endpoint' in self.data and 'expectation' in
|
||||
self.data['endpoint']):
|
||||
if (not isinstance(self.data['endpoint']['expectation'], list) or
|
||||
(isinstance(self.data['endpoint']['expectation'], list) and
|
||||
len(self.data['endpoint']['expectation']) == 0)):
|
||||
(isinstance(self.data['endpoint']['expectation'], list) and
|
||||
len(self.data['endpoint']['expectation']) == 0)):
|
||||
configuration_errors.append('endpoint.expectation')
|
||||
|
||||
if len(configuration_errors) > 0:
|
||||
raise ConfigurationValidationError(('Config file [%s] failed '
|
||||
'validation. Missing keys: %s') % (self.config_file,
|
||||
', '.join(configuration_errors)))
|
||||
raise ConfigurationValidationError(
|
||||
f"Config file [{self.config_file}] failed validation. Missing keys: {', '.join(configuration_errors)}")
|
||||
|
||||
def evaluate(self):
|
||||
"""Sends the request to the URL set in the configuration and executes
|
||||
@@ -73,84 +173,169 @@ class Configuration(object):
|
||||
according to the expectation results.
|
||||
"""
|
||||
try:
|
||||
self.request = requests.request(self.data['endpoint']['method'],
|
||||
self.data['endpoint']['url'],
|
||||
timeout=self.data['endpoint']['timeout'])
|
||||
if self.endpoint_header is not None:
|
||||
self.request = requests.request(self.endpoint_method, self.endpoint_url, timeout=self.endpoint_timeout,
|
||||
headers=self.endpoint_header)
|
||||
else:
|
||||
self.request = requests.request(self.endpoint_method, self.endpoint_url, timeout=self.endpoint_timeout)
|
||||
self.current_timestamp = int(time.time())
|
||||
except requests.ConnectionError:
|
||||
self.logger.warning('The URL is unreachable: %s %s' %
|
||||
(self.data['endpoint']['method'],
|
||||
self.data['endpoint']['url']))
|
||||
self.status = 3
|
||||
self.message = 'The URL is unreachable: %s %s' % (self.endpoint_method, self.endpoint_url)
|
||||
self.logger.warning(self.message)
|
||||
self.status = st.COMPONENT_STATUS_PARTIAL_OUTAGE
|
||||
return
|
||||
except requests.HTTPError:
|
||||
self.logger.exception('Unexpected HTTP response')
|
||||
self.status = 3
|
||||
self.message = 'Unexpected HTTP response'
|
||||
self.logger.exception(self.message)
|
||||
self.status = st.COMPONENT_STATUS_PARTIAL_OUTAGE
|
||||
return
|
||||
except requests.Timeout:
|
||||
self.logger.warning('Request timed out')
|
||||
self.status = 3
|
||||
self.message = 'Request timed out'
|
||||
self.logger.warning(self.message)
|
||||
self.status = st.COMPONENT_STATUS_PERFORMANCE_ISSUES
|
||||
return
|
||||
|
||||
# We initially assume the API is healthy.
|
||||
self.status = 1
|
||||
self.status = st.COMPONENT_STATUS_OPERATIONAL
|
||||
self.message = ''
|
||||
for expectation in self.expectations:
|
||||
status = expectation.get_status(self.request)
|
||||
|
||||
# The greater the status is, the worse the state of the API is.
|
||||
if status > self.status:
|
||||
self.status = status
|
||||
self.message = expectation.get_message(self.request)
|
||||
self.logger.info(self.message)
|
||||
|
||||
def print_out(self):
|
||||
self.logger.info(f'Current configuration:\n{self.__repr__()}')
|
||||
|
||||
def __repr__(self):
|
||||
temporary_data = copy.deepcopy(self.data)
|
||||
# Removing the token so we don't leak it in the logs.
|
||||
del temporary_data['cachet']['token']
|
||||
return dump(temporary_data, default_flow_style=False)
|
||||
|
||||
def if_trigger_update(self):
|
||||
"""
|
||||
Checks if update should be triggered - trigger it for all operational states
|
||||
and only for non-operational ones above the configured threshold (allowed_fails).
|
||||
"""
|
||||
|
||||
if self.status != 1:
|
||||
self.current_fails = self.current_fails + 1
|
||||
self.logger.warning(f'Failure #{self.current_fails} with threshold set to {self.allowed_fails}')
|
||||
if self.current_fails <= self.allowed_fails:
|
||||
self.trigger_update = False
|
||||
return
|
||||
self.current_fails = 0
|
||||
self.trigger_update = True
|
||||
|
||||
def push_status(self):
|
||||
params = {'id': self.data['cachet']['component_id'], 'status':
|
||||
self.status}
|
||||
component_request = requests.put('%s/components/%d' %
|
||||
(self.data['cachet']['api_url'],
|
||||
self.data['cachet']['component_id']),
|
||||
params=params, headers=self.headers)
|
||||
"""Pushes the status of the component to the cachet server. It will update the component
|
||||
status based on the previous call to evaluate().
|
||||
"""
|
||||
if self.previous_status == self.status:
|
||||
return
|
||||
self.previous_status = self.status
|
||||
|
||||
if not self.trigger_update:
|
||||
return
|
||||
|
||||
self.api_component_status = get_current_status(self.api_url, self.component_id, self.headers)
|
||||
|
||||
if self.status == self.api_component_status:
|
||||
return
|
||||
|
||||
params = {'id': self.component_id, 'status': self.status}
|
||||
component_request = requests.put('%s/components/%d' % (self.api_url, self.component_id), params=params,
|
||||
headers=self.headers)
|
||||
if component_request.ok:
|
||||
# Successful update
|
||||
self.logger.info('Component update: status [%d]' % (self.status,))
|
||||
else:
|
||||
# Failed to update the API status
|
||||
self.logger.warning('Component update failed with status [%d]: API'
|
||||
' status: [%d]' % (component_request.status_code, self.status))
|
||||
' status: [%d]' % (component_request.status_code, self.status))
|
||||
|
||||
def push_metrics(self):
|
||||
"""Pushes the total amount of seconds the request took to get a response from the URL.
|
||||
It only will send a request if the metric id was set in the configuration.
|
||||
In case of failed connection trial pushes the default metric value.
|
||||
"""
|
||||
if 'metric_id' in self.data['cachet'] and hasattr(self, 'request'):
|
||||
params = {'id': self.data['cachet']['metric_id'], 'value':
|
||||
self.request.elapsed.total_seconds(), 'timestamp':
|
||||
self.current_timestamp}
|
||||
metrics_request = requests.post('%s/metrics/%d/points' %
|
||||
(self.data['cachet']['api_url'],
|
||||
self.data['cachet']['metric_id']), params=params,
|
||||
headers=self.headers)
|
||||
# We convert the elapsed time from the request, in seconds, to the configured unit.
|
||||
value = self.default_metric_value if self.status != 1 else latency_unit.convert_to_unit(self.latency_unit,
|
||||
self.request.elapsed.total_seconds())
|
||||
params = {'id': self.metric_id, 'value': value,
|
||||
'timestamp': self.current_timestamp}
|
||||
metrics_request = requests.post('%s/metrics/%d/points' % (self.api_url, self.metric_id), params=params,
|
||||
headers=self.headers)
|
||||
|
||||
if metrics_request.ok:
|
||||
# Successful metrics upload
|
||||
self.logger.info('Metric uploaded: %.6f seconds' %
|
||||
(self.request.elapsed.total_seconds(),))
|
||||
self.logger.info('Metric uploaded: %.6f %s' % (value, self.latency_unit))
|
||||
else:
|
||||
self.logger.warning('Metric upload failed with status [%d]' %
|
||||
(metrics_request.status_code,))
|
||||
self.logger.warning(f'Metric upload failed with status [{metrics_request.status_code}]')
|
||||
|
||||
def push_incident(self):
|
||||
"""If the component status has changed, we create a new incident (if this is the first time it becomes unstable)
|
||||
or updates the existing incident once it becomes healthy again.
|
||||
"""
|
||||
if not self.trigger_update:
|
||||
return
|
||||
if hasattr(self, 'incident_id') and self.status == st.COMPONENT_STATUS_OPERATIONAL:
|
||||
# If the incident already exists, it means it was unhealthy but now it's healthy again.
|
||||
params = {'status': 4, 'visible': self.public_incidents, 'component_id': self.component_id,
|
||||
'component_status': self.status,
|
||||
'notify': True}
|
||||
|
||||
incident_request = requests.put(f'{self.api_url}/incidents/{self.incident_id}', params=params,
|
||||
headers=self.headers)
|
||||
if incident_request.ok:
|
||||
# Successful metrics upload
|
||||
self.logger.info(
|
||||
f'Incident updated, API healthy again: component status [{self.status}], message: "{self.message}"')
|
||||
del self.incident_id
|
||||
else:
|
||||
self.logger.warning(
|
||||
f'Incident update failed with status [{incident_request.status_code}], message: "{self.message}"')
|
||||
elif not hasattr(self, 'incident_id') and self.status != st.COMPONENT_STATUS_OPERATIONAL:
|
||||
# This is the first time the incident is being created.
|
||||
params = {'name': 'URL unavailable', 'message': self.message, 'status': 1, 'visible': self.public_incidents,
|
||||
'component_id': self.component_id, 'component_status': self.status, 'notify': True}
|
||||
incident_request = requests.post(f'{self.api_url}/incidents', params=params, headers=self.headers)
|
||||
if incident_request.ok:
|
||||
# Successful incident upload.
|
||||
self.incident_id = incident_request.json()['data']['id']
|
||||
self.logger.info(
|
||||
f'Incident uploaded, API unhealthy: component status [{self.status}], message: "{self.message}"')
|
||||
else:
|
||||
self.logger.warning(
|
||||
f'Incident upload failed with status [{incident_request.status_code}], message: "{self.message}"')
|
||||
|
||||
|
||||
class Expectaction(object):
|
||||
"""Base class for URL result expectations. Any new excpectation should extend
|
||||
class Expectation(object):
|
||||
"""Base class for URL result expectations. Any new expectation should extend
|
||||
this class and the name added to create() method.
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
def create(configuration):
|
||||
"""Creates a list of expectations based on the configuration types
|
||||
list.
|
||||
"""
|
||||
# If a need expectation is created, this is where we need to add it.
|
||||
expectations = {
|
||||
'HTTP_STATUS': HttpStatus,
|
||||
'LATENCY': Latency,
|
||||
'REGEX': Regex
|
||||
}
|
||||
'HTTP_STATUS': HttpStatus,
|
||||
'LATENCY': Latency,
|
||||
'REGEX': Regex
|
||||
}
|
||||
return expectations.get(configuration['type'])(configuration)
|
||||
|
||||
def __init__(self, configuration):
|
||||
self.incident_status = self.parse_incident_status(configuration)
|
||||
|
||||
@abc.abstractmethod
|
||||
def get_status(self, response):
|
||||
"""Returns the status of the API, following cachet's component status
|
||||
@@ -161,54 +346,83 @@ class Expectaction(object):
|
||||
def get_message(self, response):
|
||||
"""Gets the error message."""
|
||||
|
||||
@abc.abstractmethod
|
||||
def get_default_incident(self):
|
||||
"""Returns the default status when this incident happens."""
|
||||
|
||||
class HttpStatus(Expectaction):
|
||||
def parse_incident_status(self, configuration):
|
||||
return st.INCIDENT_MAP.get(configuration.get('incident', None), self.get_default_incident())
|
||||
|
||||
|
||||
class HttpStatus(Expectation):
|
||||
def __init__(self, configuration):
|
||||
self.status = configuration['status']
|
||||
self.status_range = HttpStatus.parse_range(configuration['status_range'])
|
||||
super(HttpStatus, self).__init__(configuration)
|
||||
|
||||
@staticmethod
|
||||
def parse_range(range_string):
|
||||
statuses = range_string.split("-")
|
||||
if len(statuses) == 1:
|
||||
# When there was no range given, we should treat the first number as a single status check.
|
||||
return int(statuses[0]), int(statuses[0]) + 1
|
||||
else:
|
||||
# We shouldn't look into more than one value, as this is a range value.
|
||||
return int(statuses[0]), int(statuses[1])
|
||||
|
||||
def get_status(self, response):
|
||||
if response.status_code == self.status:
|
||||
return 1
|
||||
if self.status_range[0] <= response.status_code < self.status_range[1]:
|
||||
return st.COMPONENT_STATUS_OPERATIONAL
|
||||
else:
|
||||
return 3
|
||||
return self.incident_status
|
||||
|
||||
def get_default_incident(self):
|
||||
return st.COMPONENT_STATUS_PARTIAL_OUTAGE
|
||||
|
||||
def get_message(self, response):
|
||||
return 'Unexpected HTTP status (%s)' % (response.status_code,)
|
||||
return f'Unexpected HTTP status ({response.status_code})'
|
||||
|
||||
def __str__(self):
|
||||
return repr('HTTP status: %s' % (self.status,))
|
||||
return repr(f'HTTP status range: {self.status_range}')
|
||||
|
||||
|
||||
class Latency(Expectaction):
|
||||
class Latency(Expectation):
|
||||
def __init__(self, configuration):
|
||||
self.threshold = configuration['threshold']
|
||||
super(Latency, self).__init__(configuration)
|
||||
|
||||
def get_status(self, response):
|
||||
if response.elapsed.total_seconds() <= self.threshold:
|
||||
return 1
|
||||
return st.COMPONENT_STATUS_OPERATIONAL
|
||||
else:
|
||||
return 2
|
||||
return self.incident_status
|
||||
|
||||
def get_default_incident(self):
|
||||
return st.COMPONENT_STATUS_PERFORMANCE_ISSUES
|
||||
|
||||
def get_message(self, response):
|
||||
return 'Latency above threshold: %.4f' % (response.elapsed.total_seconds(),)
|
||||
return 'Latency above threshold: %.4f seconds' % (response.elapsed.total_seconds(),)
|
||||
|
||||
def __str__(self):
|
||||
return repr('Latency threshold: %.4f' % (self.threshold,))
|
||||
return repr('Latency threshold: %.4f seconds' % (self.threshold,))
|
||||
|
||||
|
||||
class Regex(Expectaction):
|
||||
class Regex(Expectation):
|
||||
def __init__(self, configuration):
|
||||
self.regex_string = configuration['regex']
|
||||
self.regex = re.compile(configuration['regex'])
|
||||
self.regex = re.compile(configuration['regex'], re.UNICODE + re.DOTALL)
|
||||
super(Regex, self).__init__(configuration)
|
||||
|
||||
def get_status(self, response):
|
||||
if self.regex.match(response.text):
|
||||
return 1
|
||||
return st.COMPONENT_STATUS_OPERATIONAL
|
||||
else:
|
||||
return 3
|
||||
return self.incident_status
|
||||
|
||||
def get_default_incident(self):
|
||||
return st.COMPONENT_STATUS_PARTIAL_OUTAGE
|
||||
|
||||
def get_message(self, response):
|
||||
return 'Regex did not match anything in the body'
|
||||
|
||||
def __str__(self):
|
||||
return repr('Regex: %s' % (self.regex_string,))
|
||||
return repr(f'Regex: {self.regex_string}')
|
||||
|
||||
16
cachet_url_monitor/latency_unit.py
Normal file
16
cachet_url_monitor/latency_unit.py
Normal file
@@ -0,0 +1,16 @@
|
||||
#!/usr/bin/env python
|
||||
|
||||
seconds_per_unit = {"ms": 1000, "milliseconds": 1000, "s": 1, "seconds": 1, "m": float(1) / 60,
|
||||
"minutes": float(1) / 60, "h": float(1) / 3600, "hours": float(1) / 3600}
|
||||
|
||||
|
||||
def convert_to_unit(time_unit, value):
|
||||
"""
|
||||
Will convert the given value from seconds to the given time_unit.
|
||||
|
||||
:param time_unit: The time unit to which the value will be converted to, from seconds.
|
||||
This is a string parameter. The unit must be in the short form.
|
||||
:param value: The given value that will be converted. This value must be in seconds.
|
||||
:return: The converted value.
|
||||
"""
|
||||
return value * seconds_per_unit[time_unit]
|
||||
@@ -1,38 +1,74 @@
|
||||
#!/usr/bin/env python
|
||||
from configuration import Configuration
|
||||
import logging
|
||||
import schedule
|
||||
import sys
|
||||
import time
|
||||
|
||||
import schedule
|
||||
|
||||
from cachet_url_monitor.configuration import Configuration
|
||||
|
||||
|
||||
class Agent(object):
|
||||
"""Monitor agent that will be constantly verifying if the URL is healthy
|
||||
and updating the component.
|
||||
"""
|
||||
def __init__(self, configuration):
|
||||
|
||||
def __init__(self, configuration, decorators=None):
|
||||
self.configuration = configuration
|
||||
if decorators is None:
|
||||
decorators = []
|
||||
self.decorators = decorators
|
||||
|
||||
def execute(self):
|
||||
"""Will verify the API status and push the status and metrics to the
|
||||
cachet server.
|
||||
"""
|
||||
self.configuration.evaluate()
|
||||
self.configuration.push_status()
|
||||
self.configuration.push_metrics()
|
||||
self.configuration.if_trigger_update()
|
||||
|
||||
for decorator in self.decorators:
|
||||
decorator.execute(self.configuration)
|
||||
|
||||
def start(self):
|
||||
"""Sets up the schedule based on the configuration file."""
|
||||
schedule.every(self.configuration.data['frequency']).seconds.do(self.execute)
|
||||
|
||||
|
||||
class Decorator(object):
|
||||
def execute(self, configuration):
|
||||
pass
|
||||
|
||||
|
||||
class UpdateStatusDecorator(Decorator):
|
||||
def execute(self, configuration):
|
||||
configuration.push_status()
|
||||
|
||||
|
||||
class CreateIncidentDecorator(Decorator):
|
||||
def execute(self, configuration):
|
||||
configuration.push_incident()
|
||||
|
||||
|
||||
class Scheduler(object):
|
||||
def __init__(self, config_file):
|
||||
self.logger = logging.getLogger('cachet_url_monitor.scheduler.Scheduler')
|
||||
self.configuration = Configuration(config_file)
|
||||
self.agent = Agent(self.configuration)
|
||||
self.agent = self.get_agent()
|
||||
|
||||
self.stop = False
|
||||
|
||||
def get_agent(self):
|
||||
action_names = {
|
||||
'CREATE_INCIDENT': CreateIncidentDecorator,
|
||||
'UPDATE_STATUS': UpdateStatusDecorator,
|
||||
}
|
||||
actions = []
|
||||
for action in self.configuration.get_action():
|
||||
self.logger.info('Registering action %s' % (action))
|
||||
actions.append(action_names[action]())
|
||||
return Agent(self.configuration, decorators=actions)
|
||||
|
||||
def start(self):
|
||||
self.agent.start()
|
||||
self.logger.info('Starting monitor agent...')
|
||||
@@ -48,7 +84,7 @@ if __name__ == "__main__":
|
||||
handler.addFilter(logging.Filter('cachet_url_monitor'))
|
||||
|
||||
if len(sys.argv) <= 1:
|
||||
logging.fatal('Missing configuration file argument')
|
||||
logging.getLogger('cachet_url_monitor.scheduler').fatal('Missing configuration file argument')
|
||||
sys.exit(1)
|
||||
|
||||
scheduler = Scheduler(sys.argv[1])
|
||||
|
||||
24
cachet_url_monitor/status.py
Normal file
24
cachet_url_monitor/status.py
Normal file
@@ -0,0 +1,24 @@
|
||||
#!/usr/bin/env python
|
||||
"""
|
||||
This file defines all the different status different values.
|
||||
These are all constants and are coupled to cachet's API configuration.
|
||||
"""
|
||||
|
||||
COMPONENT_STATUS_OPERATIONAL = 1
|
||||
COMPONENT_STATUS_PERFORMANCE_ISSUES = 2
|
||||
COMPONENT_STATUS_PARTIAL_OUTAGE = 3
|
||||
COMPONENT_STATUS_MAJOR_OUTAGE = 4
|
||||
|
||||
COMPONENT_STATUSES = [COMPONENT_STATUS_OPERATIONAL,
|
||||
COMPONENT_STATUS_PERFORMANCE_ISSUES, COMPONENT_STATUS_PARTIAL_OUTAGE,
|
||||
COMPONENT_STATUS_MAJOR_OUTAGE]
|
||||
|
||||
INCIDENT_PARTIAL = 'PARTIAL'
|
||||
INCIDENT_MAJOR = 'MAJOR'
|
||||
INCIDENT_PERFORMANCE = 'PERFORMANCE'
|
||||
|
||||
INCIDENT_MAP = {
|
||||
INCIDENT_PARTIAL: COMPONENT_STATUS_PARTIAL_OUTAGE,
|
||||
INCIDENT_MAJOR: COMPONENT_STATUS_MAJOR_OUTAGE,
|
||||
INCIDENT_PERFORMANCE: COMPONENT_STATUS_PERFORMANCE_ISSUES,
|
||||
}
|
||||
13
config.yml
13
config.yml
@@ -1,17 +1,26 @@
|
||||
endpoint:
|
||||
url: http://localhost:8080/swagger
|
||||
method: GET
|
||||
header:
|
||||
SOME-HEADER: SOME-VALUE
|
||||
timeout: 0.01
|
||||
expectation:
|
||||
- type: HTTP_STATUS
|
||||
status: 200
|
||||
status_range: 200-300
|
||||
incident: MAJOR
|
||||
- type: LATENCY
|
||||
threshold: 1
|
||||
- type: REGEX
|
||||
regex: '.*<body>.*'
|
||||
regex: '.*(<body).*'
|
||||
allowed_fails: 0
|
||||
cachet:
|
||||
api_url: https://demo.cachethq.io/api/v1
|
||||
token: my_token
|
||||
component_id: 1
|
||||
#metric_id: 1
|
||||
action:
|
||||
- CREATE_INCIDENT
|
||||
- UPDATE_STATUS
|
||||
public_incidents: true
|
||||
latency_unit: ms
|
||||
frequency: 30
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
PyYAML==3.11
|
||||
ipython==4.2.0
|
||||
codacy-coverage==1.3.11
|
||||
ipython==7.8.0
|
||||
mock==2.0.0
|
||||
pudb==2016.1
|
||||
pytest==2.9.1
|
||||
pytest-cov==2.2.1
|
||||
requests==2.9.1
|
||||
schedule==0.3.2
|
||||
pytest==5.2.2
|
||||
pytest-cov==2.8.1
|
||||
coverage==4.5.2
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
version: '2'
|
||||
services:
|
||||
monitor:
|
||||
build: .
|
||||
volumes:
|
||||
- .:/usr/src/app/
|
||||
@@ -1,3 +1,3 @@
|
||||
PyYAML==3.11
|
||||
requests==2.9.1
|
||||
schedule==0.3.2
|
||||
PyYAML==5.1.2
|
||||
requests==2.22.0
|
||||
schedule==0.6.0
|
||||
|
||||
9
setup.cfg
Normal file
9
setup.cfg
Normal file
@@ -0,0 +1,9 @@
|
||||
[metadata]
|
||||
description-file = README.md
|
||||
|
||||
[aliases]
|
||||
test=pytest
|
||||
|
||||
[tool:pytest]
|
||||
addopts = --verbose
|
||||
python_files = tests/*.py
|
||||
11
setup.py
11
setup.py
@@ -1,8 +1,9 @@
|
||||
#!/usr/bin/env python
|
||||
from distutils.core import setup
|
||||
#from distutils.core import setup
|
||||
from setuptools import setup
|
||||
|
||||
setup(name='cachet-url-monitor',
|
||||
version='0.2',
|
||||
version='0.5',
|
||||
description='Cachet URL monitor plugin',
|
||||
author='Mitsuo Takaki',
|
||||
author_email='mitsuotakaki@gmail.com',
|
||||
@@ -13,5 +14,7 @@ setup(name='cachet-url-monitor',
|
||||
'requests',
|
||||
'yaml',
|
||||
'schedule',
|
||||
]
|
||||
)
|
||||
],
|
||||
setup_requires=["pytest-runner"],
|
||||
tests_require=["pytest"]
|
||||
)
|
||||
|
||||
@@ -1,32 +1,54 @@
|
||||
#!/usr/bin/env python
|
||||
import mock
|
||||
import unittest
|
||||
import sys
|
||||
from requests import ConnectionError,HTTPError,Timeout
|
||||
import unittest
|
||||
|
||||
import mock
|
||||
from requests import ConnectionError, HTTPError, Timeout
|
||||
|
||||
import cachet_url_monitor.status
|
||||
|
||||
sys.modules['requests'] = mock.Mock()
|
||||
sys.modules['logging'] = mock.Mock()
|
||||
from cachet_url_monitor.configuration import Configuration
|
||||
import os
|
||||
|
||||
|
||||
class ConfigurationTest(unittest.TestCase):
|
||||
@mock.patch.dict(os.environ, {'CACHET_TOKEN': 'token2'})
|
||||
def setUp(self):
|
||||
def getLogger(name):
|
||||
self.mock_logger = mock.Mock()
|
||||
return self.mock_logger
|
||||
|
||||
sys.modules['logging'].getLogger = getLogger
|
||||
|
||||
def get(url, headers):
|
||||
get_return = mock.Mock()
|
||||
get_return.ok = True
|
||||
get_return.json = mock.Mock()
|
||||
get_return.json.return_value = {'data': {'status': 1, 'default_value': 0.5}}
|
||||
return get_return
|
||||
|
||||
sys.modules['requests'].get = get
|
||||
|
||||
self.configuration = Configuration('config.yml')
|
||||
sys.modules['requests'].Timeout = Timeout
|
||||
sys.modules['requests'].ConnectionError = ConnectionError
|
||||
sys.modules['requests'].HTTPError = HTTPError
|
||||
|
||||
def test_init(self):
|
||||
assert len(self.configuration.data) == 3
|
||||
assert len(self.configuration.expectations) == 3
|
||||
self.assertEqual(len(self.configuration.data), 3, 'Number of root elements in config.yml is incorrect')
|
||||
self.assertEqual(len(self.configuration.expectations), 3, 'Number of expectations read from file is incorrect')
|
||||
self.assertDictEqual(self.configuration.headers, {'X-Cachet-Token': 'token2'}, 'Header was not set correctly')
|
||||
self.assertEqual(self.configuration.api_url, 'https://demo.cachethq.io/api/v1',
|
||||
'Cachet API URL was set incorrectly')
|
||||
self.assertDictEqual(self.configuration.endpoint_header, {'SOME-HEADER': 'SOME-VALUE'}, 'Header is incorrect')
|
||||
|
||||
def test_evaluate(self):
|
||||
def total_seconds():
|
||||
return 0.1
|
||||
def request(method, url, timeout=None):
|
||||
|
||||
def request(method, url, headers, timeout=None):
|
||||
response = mock.Mock()
|
||||
response.status_code = 200
|
||||
response.elapsed = mock.Mock()
|
||||
@@ -37,12 +59,32 @@ class ConfigurationTest(unittest.TestCase):
|
||||
sys.modules['requests'].request = request
|
||||
self.configuration.evaluate()
|
||||
|
||||
assert self.configuration.status == 1
|
||||
self.assertEqual(self.configuration.status, cachet_url_monitor.status.COMPONENT_STATUS_OPERATIONAL,
|
||||
'Component status set incorrectly')
|
||||
|
||||
def test_evaluate_without_header(self):
|
||||
def total_seconds():
|
||||
return 0.1
|
||||
|
||||
def request(method, url, headers=None, timeout=None):
|
||||
response = mock.Mock()
|
||||
response.status_code = 200
|
||||
response.elapsed = mock.Mock()
|
||||
response.elapsed.total_seconds = total_seconds
|
||||
response.text = '<body>'
|
||||
return response
|
||||
|
||||
sys.modules['requests'].request = request
|
||||
self.configuration.evaluate()
|
||||
|
||||
self.assertEqual(self.configuration.status, cachet_url_monitor.status.COMPONENT_STATUS_OPERATIONAL,
|
||||
'Component status set incorrectly')
|
||||
|
||||
def test_evaluate_with_failure(self):
|
||||
def total_seconds():
|
||||
return 0.1
|
||||
def request(method, url, timeout=None):
|
||||
|
||||
def request(method, url, headers, timeout=None):
|
||||
response = mock.Mock()
|
||||
# We are expecting a 200 response, so this will fail the expectation.
|
||||
response.status_code = 400
|
||||
@@ -54,76 +96,80 @@ class ConfigurationTest(unittest.TestCase):
|
||||
sys.modules['requests'].request = request
|
||||
self.configuration.evaluate()
|
||||
|
||||
assert self.configuration.status == 3
|
||||
self.assertEqual(self.configuration.status, cachet_url_monitor.status.COMPONENT_STATUS_MAJOR_OUTAGE,
|
||||
'Component status set incorrectly or custom incident status is incorrectly parsed')
|
||||
|
||||
def test_evaluate_with_timeout(self):
|
||||
def request(method, url, timeout=None):
|
||||
assert method == 'GET'
|
||||
assert url == 'http://localhost:8080/swagger'
|
||||
assert timeout == 0.010
|
||||
def request(method, url, headers, timeout=None):
|
||||
self.assertEqual(method, 'GET', 'Incorrect HTTP method')
|
||||
self.assertEqual(url, 'http://localhost:8080/swagger', 'Monitored URL is incorrect')
|
||||
self.assertEqual(timeout, 0.010)
|
||||
|
||||
raise Timeout()
|
||||
|
||||
sys.modules['requests'].request = request
|
||||
self.configuration.evaluate()
|
||||
|
||||
assert self.configuration.status == 3
|
||||
self.assertEqual(self.configuration.status, cachet_url_monitor.status.COMPONENT_STATUS_PERFORMANCE_ISSUES,
|
||||
'Component status set incorrectly')
|
||||
self.mock_logger.warning.assert_called_with('Request timed out')
|
||||
|
||||
def test_evaluate_with_connection_error(self):
|
||||
def request(method, url, timeout=None):
|
||||
assert method == 'GET'
|
||||
assert url == 'http://localhost:8080/swagger'
|
||||
assert timeout == 0.010
|
||||
def request(method, url, headers, timeout=None):
|
||||
self.assertEqual(method, 'GET', 'Incorrect HTTP method')
|
||||
self.assertEqual(url, 'http://localhost:8080/swagger', 'Monitored URL is incorrect')
|
||||
self.assertEqual(timeout, 0.010)
|
||||
|
||||
raise ConnectionError()
|
||||
|
||||
sys.modules['requests'].request = request
|
||||
self.configuration.evaluate()
|
||||
|
||||
assert self.configuration.status == 3
|
||||
self.mock_logger.warning.assert_called_with(('The URL is '
|
||||
'unreachable: GET http://localhost:8080/swagger'))
|
||||
self.assertEqual(self.configuration.status, cachet_url_monitor.status.COMPONENT_STATUS_PARTIAL_OUTAGE,
|
||||
'Component status set incorrectly')
|
||||
self.mock_logger.warning.assert_called_with('The URL is unreachable: GET http://localhost:8080/swagger')
|
||||
|
||||
def test_evaluate_with_http_error(self):
|
||||
def request(method, url, timeout=None):
|
||||
assert method == 'GET'
|
||||
assert url == 'http://localhost:8080/swagger'
|
||||
assert timeout == 0.010
|
||||
def request(method, url, headers, timeout=None):
|
||||
self.assertEqual(method, 'GET', 'Incorrect HTTP method')
|
||||
self.assertEqual(url, 'http://localhost:8080/swagger', 'Monitored URL is incorrect')
|
||||
self.assertEqual(timeout, 0.010)
|
||||
|
||||
raise HTTPError()
|
||||
|
||||
sys.modules['requests'].request = request
|
||||
self.configuration.evaluate()
|
||||
|
||||
assert self.configuration.status == 3
|
||||
self.mock_logger.exception.assert_called_with(('Unexpected HTTP '
|
||||
'response'))
|
||||
self.assertEqual(self.configuration.status, cachet_url_monitor.status.COMPONENT_STATUS_PARTIAL_OUTAGE,
|
||||
'Component status set incorrectly')
|
||||
self.mock_logger.exception.assert_called_with('Unexpected HTTP response')
|
||||
|
||||
def test_push_status(self):
|
||||
def put(url, params=None, headers=None):
|
||||
assert url == 'https://demo.cachethq.io/api/v1/components/1'
|
||||
assert params == {'id': 1, 'status': 1}
|
||||
assert headers == {'X-Cachet-Token': 'my_token'}
|
||||
self.assertEqual(url, 'https://demo.cachethq.io/api/v1/components/1', 'Incorrect cachet API URL')
|
||||
self.assertDictEqual(params, {'id': 1, 'status': 1}, 'Incorrect component update parameters')
|
||||
self.assertDictEqual(headers, {'X-Cachet-Token': 'token2'}, 'Incorrect component update parameters')
|
||||
|
||||
response = mock.Mock()
|
||||
response.status_code = 200
|
||||
return response
|
||||
|
||||
sys.modules['requests'].put = put
|
||||
self.configuration.status = 1
|
||||
self.assertEqual(self.configuration.status, cachet_url_monitor.status.COMPONENT_STATUS_OPERATIONAL,
|
||||
'Incorrect component update parameters')
|
||||
self.configuration.push_status()
|
||||
|
||||
def test_push_status_with_failure(self):
|
||||
def put(url, params=None, headers=None):
|
||||
assert url == 'https://demo.cachethq.io/api/v1/components/1'
|
||||
assert params == {'id': 1, 'status': 1}
|
||||
assert headers == {'X-Cachet-Token': 'my_token'}
|
||||
self.assertEqual(url, 'https://demo.cachethq.io/api/v1/components/1', 'Incorrect cachet API URL')
|
||||
self.assertDictEqual(params, {'id': 1, 'status': 1}, 'Incorrect component update parameters')
|
||||
self.assertDictEqual(headers, {'X-Cachet-Token': 'token2'}, 'Incorrect component update parameters')
|
||||
|
||||
response = mock.Mock()
|
||||
response.status_code = 300
|
||||
response.status_code = 400
|
||||
return response
|
||||
|
||||
sys.modules['requests'].put = put
|
||||
self.configuration.status = 1
|
||||
self.assertEqual(self.configuration.status, cachet_url_monitor.status.COMPONENT_STATUS_OPERATIONAL,
|
||||
'Incorrect component update parameters')
|
||||
self.configuration.push_status()
|
||||
|
||||
@@ -1,9 +1,12 @@
|
||||
#!/usr/bin/env python
|
||||
import mock
|
||||
import re
|
||||
import unittest
|
||||
from cachet_url_monitor.configuration import Expectaction,Latency
|
||||
from cachet_url_monitor.configuration import HttpStatus,Regex
|
||||
|
||||
import mock
|
||||
import pytest
|
||||
|
||||
from cachet_url_monitor.configuration import HttpStatus, Regex
|
||||
from cachet_url_monitor.configuration import Latency
|
||||
|
||||
|
||||
class LatencyTest(unittest.TestCase):
|
||||
@@ -16,6 +19,7 @@ class LatencyTest(unittest.TestCase):
|
||||
def test_get_status_healthy(self):
|
||||
def total_seconds():
|
||||
return 0.1
|
||||
|
||||
request = mock.Mock()
|
||||
elapsed = mock.Mock()
|
||||
request.elapsed = elapsed
|
||||
@@ -26,6 +30,7 @@ class LatencyTest(unittest.TestCase):
|
||||
def test_get_status_unhealthy(self):
|
||||
def total_seconds():
|
||||
return 2
|
||||
|
||||
request = mock.Mock()
|
||||
elapsed = mock.Mock()
|
||||
request.elapsed = elapsed
|
||||
@@ -36,21 +41,33 @@ class LatencyTest(unittest.TestCase):
|
||||
def test_get_message(self):
|
||||
def total_seconds():
|
||||
return 0.1
|
||||
|
||||
request = mock.Mock()
|
||||
elapsed = mock.Mock()
|
||||
request.elapsed = elapsed
|
||||
elapsed.total_seconds = total_seconds
|
||||
|
||||
assert self.expectation.get_message(request) == ('Latency above '
|
||||
'threshold: 0.1000')
|
||||
'threshold: 0.1000 seconds')
|
||||
|
||||
|
||||
class HttpStatusTest(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.expectation = HttpStatus({'type': 'HTTP_STATUS', 'status': 200})
|
||||
self.expectation = HttpStatus({'type': 'HTTP_STATUS', 'status_range': "200-300"})
|
||||
|
||||
def test_init(self):
|
||||
assert self.expectation.status == 200
|
||||
assert self.expectation.status_range == (200, 300)
|
||||
|
||||
def test_init_with_one_status(self):
|
||||
"""With only one value, we still expect a valid tuple"""
|
||||
self.expectation = HttpStatus({'type': 'HTTP_STATUS', 'status_range': "200"})
|
||||
|
||||
assert self.expectation.status_range == (200, 201)
|
||||
|
||||
def test_init_with_invalid_number(self):
|
||||
"""Invalid values should just fail with a ValueError, as we can't convert it to int."""
|
||||
with pytest.raises(ValueError):
|
||||
self.expectation = HttpStatus({'type': 'HTTP_STATUS', 'status_range': "foo"})
|
||||
|
||||
def test_get_status_healthy(self):
|
||||
request = mock.Mock()
|
||||
@@ -69,7 +86,7 @@ class HttpStatusTest(unittest.TestCase):
|
||||
request.status_code = 400
|
||||
|
||||
assert self.expectation.get_message(request) == ('Unexpected HTTP '
|
||||
'status (400)')
|
||||
'status (400)')
|
||||
|
||||
|
||||
class RegexTest(unittest.TestCase):
|
||||
@@ -77,11 +94,11 @@ class RegexTest(unittest.TestCase):
|
||||
self.expectation = Regex({'type': 'REGEX', 'regex': '.*(find stuff).*'})
|
||||
|
||||
def test_init(self):
|
||||
assert self.expectation.regex == re.compile('.*(find stuff).*')
|
||||
assert self.expectation.regex == re.compile('.*(find stuff).*', re.UNICODE + re.DOTALL)
|
||||
|
||||
def test_get_status_healthy(self):
|
||||
request = mock.Mock()
|
||||
request.text = 'We could find stuff in this body.'
|
||||
request.text = 'We could find stuff\n in this body.'
|
||||
|
||||
assert self.expectation.get_status(request) == 1
|
||||
|
||||
@@ -96,4 +113,4 @@ class RegexTest(unittest.TestCase):
|
||||
request.text = 'We will not find it here'
|
||||
|
||||
assert self.expectation.get_message(request) == ('Regex did not match '
|
||||
'anything in the body')
|
||||
'anything in the body')
|
||||
|
||||
19
tests/test_latency_unit.py
Normal file
19
tests/test_latency_unit.py
Normal file
@@ -0,0 +1,19 @@
|
||||
#!/usr/bin/env python
|
||||
|
||||
from cachet_url_monitor.latency_unit import convert_to_unit
|
||||
|
||||
|
||||
def test_convert_to_unit_ms():
|
||||
assert convert_to_unit("ms", 1) == 1000
|
||||
|
||||
|
||||
def test_convert_to_unit_s():
|
||||
assert convert_to_unit("s", 20) == 20
|
||||
|
||||
|
||||
def test_convert_to_unit_m():
|
||||
assert convert_to_unit("m", 3) == float(3) / 60
|
||||
|
||||
|
||||
def test_convert_to_unit_h():
|
||||
assert convert_to_unit("h", 7200) == 2
|
||||
@@ -1,10 +1,11 @@
|
||||
#!/usr/bin/env python
|
||||
import mock
|
||||
import unittest
|
||||
import sys
|
||||
import unittest
|
||||
|
||||
import mock
|
||||
|
||||
sys.modules['schedule'] = mock.Mock()
|
||||
sys.modules['cachet_url_monitor.configuration.Configuration'] = mock.Mock()
|
||||
from cachet_url_monitor.scheduler import Agent,Scheduler
|
||||
from cachet_url_monitor.scheduler import Agent, Scheduler
|
||||
|
||||
|
||||
class AgentTest(unittest.TestCase):
|
||||
@@ -21,7 +22,7 @@ class AgentTest(unittest.TestCase):
|
||||
self.agent.execute()
|
||||
|
||||
evaluate.assert_called_once()
|
||||
push_status.assert_called_once()
|
||||
push_status.assert_not_called()
|
||||
|
||||
def test_start(self):
|
||||
every = sys.modules['schedule'].every
|
||||
@@ -33,16 +34,24 @@ class AgentTest(unittest.TestCase):
|
||||
|
||||
|
||||
class SchedulerTest(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.mock_configuration = sys.modules[('cachet_url_monitor.configuration'
|
||||
'.Configuration')]
|
||||
@mock.patch('requests.get')
|
||||
def setUp(self, mock_requests):
|
||||
def get(url, headers):
|
||||
get_return = mock.Mock()
|
||||
get_return.ok = True
|
||||
get_return.json = mock.Mock()
|
||||
get_return.json.return_value = {'data': {'status': 1}}
|
||||
return get_return
|
||||
|
||||
mock_requests.get = get
|
||||
|
||||
self.scheduler = Scheduler('config.yml')
|
||||
|
||||
def test_init(self):
|
||||
assert self.scheduler.stop == False
|
||||
|
||||
def test_start(self):
|
||||
#TODO(mtakaki|2016-05-01): We need a better way of testing this method.
|
||||
# TODO(mtakaki|2016-05-01): We need a better way of testing this method.
|
||||
# Leaving it as a placeholder.
|
||||
self.scheduler.stop = True
|
||||
self.scheduler.start()
|
||||
|
||||
Reference in New Issue
Block a user