https://github.com/artbycrunk/service-monitor

Monitor a list of urls periodically.
https://github.com/artbycrunk/service-monitor

Last synced: about 1 month ago
JSON representation

Monitor a list of urls periodically.

• Host: GitHub
• URL: https://github.com/artbycrunk/service-monitor
• Owner: artbycrunk
• License: mit
• Created: 2020-07-12T13:51:49.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-08-24T16:26:37.000Z (over 4 years ago)
• Last Synced: 2024-10-12T23:11:12.139Z (2 months ago)
• Language: Python
• Size: 445 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# service-monitor

Monitor a list of URLs periodically.

Features

* Accepts a CSV file containing a list of URLs and names

* Interval of the check is configurable.

* Exposes summary over the local port (defaults to 8080)

## Requirements

* Docker and docker-compose

## Getting Started

1. In the project root folder run `docker-compose up --build`

2. By default, the above command will run the server with `./example/sample.csv` and can be changed via the command argument passed in the `docker-compose.yml` file.

## Summary View

The service will also bind to `http://localhost:8080` where

a summary page is served like the below example

![alt text](./images/summary_view.png "summary_page")

* This page will auto-refresh based on the interval time,

and one can hover over each sample for the status code/timestamp of the sample.

* If a JSON response is required one can pass the content-type header of "application/json".

## Service Monitor Arguments

These arguments can be passed as command-line arguments to service-monitor

### Possible Args:

```

usage: service-monitor [-h] [-i INTERVAL] [-ms METRIC_SPAN] [--log-level {INFO,DEBUG}] csv

positional arguments:

  csv                   Path to csv file with list of url(s)

optional arguments:

  -h, --help            show this help message and exit

  -i INTERVAL, --interval INTERVAL

                        Interval to check service health,in minutes (default:

                        10 min)

  -ms METRIC_SPAN, --metric-span METRIC_SPAN

                        Span of time to show metric data, in hours (default: 1

                        hour)

  --log-level {INFO,DEBUG}

                        Span of time to show metric data, in hours (default: 1

                        hour)

```

## Assumptions and limitations

* If the CSV has duplicated entries (i.e. the name, URL pair is the same) that row is skipped.

* The storage layer exists for recovery from crashes.

* The summary is read from storage via an optimized query that takes 0.1s @ 200,000 rows.

* The storage DB is not normalized, to avoid JOINS, in order the summary query (in this scenario it has shown to be faster)

* Currently this service will not check for pending tasks before shutting down or if cancelled.