This is a Gitlab for NZOSS Members

README.md 1.49 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# meeting-monitoring

This repository contains scripts and other resources for
monitoring NZOSS's BigBlueButton instance at https://bbb.nzoss.nz/.

In particular, it builds a dashboard that monitors usage.
Yes we could use grafana and Prometheus, but this is more fun.

# Setup

You need an Ubuntu system running. The fastest way to get one
is by installing [multipass][].

Install all necessary dependencies via `setup.sh`
    
Tim McNamara's avatar
Tim McNamara committed
16
    $ chmod +x setup.sh
17
18
19
20
21
22
    $ setup.sh

Note: if something goes wrong, please set the DEBUG variable and run the script again. See the **Contact** section for where to send this output to for help: 

    $ DEBUG=yes ./setup.sh

Tim McNamara's avatar
Tim McNamara committed
23
24
# Tasks

Tim McNamara's avatar
Tim McNamara committed
25
26
27
28
29
30
31
32
33
34
35
36
Update all data and generate plots:

    $ just go

Post-process any fresh data generate corresponding plots:

    $ make everything

Generate plots from current data:

    $ make plots

Tim McNamara's avatar
Tim McNamara committed
37
38
39
40
41
Synchronise the data/code:

    $ just sync


Tim McNamara's avatar
Tim McNamara committed
42
# Project Tools
43
44
45
46
47
48
49
50
51
52
53
54
55

## Justfile

We use [`just`][] as a task runner.


## Makefile

The Makefile is used exclusively for building things.

We use GNU `make`, although we don't make heavy use of extensions,
so any POSIX-compatible makefile should work.

Tim McNamara's avatar
Tim McNamara committed
56
57
58
## `gnuplot`

gunplot and the pngcairo terminal are used to generate plots.
59
60
61
62
63
64
65
66
67
68
69
70


# Admin

## Licence

All rights reserved.

(This will change shortly)

## Contact

Tim McNamara's avatar
Tim McNamara committed
71
The preferred method is the `#technical` channel within https://chat.nzoss.nz/.c
72
73
74
75
76

## Maintainers

- Tim McNamara <code@timmcnamara.co.nz>

77
[`just`]: https://github.com/casey/just
Tim McNamara's avatar
Tim McNamara committed
78
[multipass]: https://multipass.run/