https://github.com/guardian/vidispine-monitor

Simple health monitoring for the Vidispine application, linked to PagerDuty.
https://github.com/guardian/vidispine-monitor

multimedia-tech

Last synced: 24 days ago
JSON representation

Simple health monitoring for the Vidispine application, linked to PagerDuty.

• Host: GitHub
• URL: https://github.com/guardian/vidispine-monitor
• Owner: guardian
• Created: 2023-01-20T15:06:45.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-12T09:32:36.000Z (11 months ago)
• Last Synced: 2025-01-01T20:42:16.489Z (24 days ago)
• Topics: multimedia-tech
• Language: Go
• Homepage:
• Size: 45.9 KB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vidispine-monitor

## What is it?

Vidispine monitor is a small piece of software that performs systems

checks on an active Vidispine server at a set interval.

If problems are found, then alerts are sent to the PagerDuty monitoring

system for action by administrators.

## Checks carried out

Checks are carried out in order, not in parallel.  If an internal error is found

trying to carry out the check (e.g. Vidispine responded with a 500, or content could

not be parsed, Pagerduty is offline, or we ran out of memory etc.) then this message is displayed and the

app exits.  In Kubernetes this causes a crashloop state, which should be easy to

identify in order to isolate the issue.

Error exit only occurs after _every_ check has been completed.

### 1. System health

The /healthcheck/ endpoint on the 9001 admin port is checked for all subcomponents;

this includes message broker, index, database, etc.  A message is sent for every failure

identified by the server

### 2. Storages

The /API/storage endpoint on the 8080 API port is checked.  For each storage identified,

the state is checked as well as whether the storage is over the high watermark and

whether it is over 95% full.

This check requires regular API permissions to work, refer to README.md in the

`vidispine` subdirectory to see how to set these up.

## Build and deployment

You need to have Go installed, ideally version 1.14 or later (modules support

is a must).  You'll make life easier if you have GNU make installed too.

Assuming you have these two, simply:

```bash

$ make clean && make

$ docker build . -t your_org/vidispine-monitor:DEV

```

For a deployment manifest, refer to `vidispine/vidispine-monitor.yaml` in

the prexit-local repo.  You should only ever need one instance of this app

running at a time.