monitoror/monitoror

Unified monitoring wallboard — Light, ergonomic and reliable monitoring for anything.

---

Monitoror

Monitoror is a wallboard monitoring app to monitor server status; monitor CI builds progress or even display critical values.

Demo

Visit Monitoror live demo

Getting started

Monitoror is a single file app written in Go which can be run on these platforms:

• Linux (64bits, ARM)
• macOS
• Windows (64bits)

The app is divided into two parts: Core and UI.

Core is the server-side Monitoror HTTP API, configured by the environment variables or .env file.

UI is the client-side Monitoror loaded in browser, which is the wallboard itself.

Visit the Monitoror website for more details

Documentation

All details about installation and configuration are on our documentation

Development

See our development guide

Authors

@jsdidierlaurent Jean-Sébastien Didierlaurent Mostly on Monitoror Core • • • https://twitter.com/Akhiro

@Alex-D Alexandre Demode Mostly on Monitoror UI • • • https://twitter.com/AlexandreDemode

Support us

You can support Monitoror ongoing development by doing a donation or being a backer or a sponsor:

License

This project is licensed under the MIT License - see the LICENSE file for details.

monitoror's Issues

Adding Cache Middleware

To avoid spamming your own services, add cache middleware with 8s TTL (with gcache ?)
Don't forget headers

Add Gitlab Count (issues/MR) support

See: https://github.com/xanzy/go-gitlab

Add circleci integration and code coverage

see : https://github.com/digineo/go-ping/blob/master/codecov.yml
see: https://circleci.com/blog/go-v1.11-modules-and-circleci/
see: https://circleci.com/docs/2.0/code-coverage/#codecov

Create sub project for faking monitored service

Create a service for faking Gitlab/Jenkins ...

Use project param for asking response.
Ex : gitlab projet name : test.success.12365 for

{
   "Status": "SUCCESS",
   "Label": "test",
   "Duration": 12365
}

Add dynamic tiles for jenkins multibranch pipeline

Make "nightly" builds for develop and PRs

Maybe something like this ?

Tag: x.x.x
Master: x.x.x-master-{hash}
Develop: x.x.x-develop-{hash}
PR: x.x.x-nightly-{hash}

Add dynamic tiles for gitlab merge request

Add param to HTTP-RAW and HTTP-FORMATTED to set values unit

Add Azure DevOps support

https://github.com/microsoft/azure-devops-go-api

Add Jenkins route for jenkins jobs / pipelines

https://github.com/bndr/gojenkins

Update CI for build front

• Split build/ tests into buid-front / back and test-font/back
• Adding news steps for deploying coverage for front
• Adding language tags for coverage : https://docs.codecov.io/docs/merging-reports

Change group `params` key to `subTiles` in verify

To improve split between which data is sent to server and which one is used in front only, I think using a custom key for group sub titles can be great.

It allows to do something like that in front state:

export interface TileState {
  type: TileType,
  label?: string,
  subTiles?: TileState[],
}

Add Pingdom support

https://github.com/russellcardullo/go-pingdom

Improve values rendering

123456789 => 123 456 789
15346ms => 15,3s ?

Refactor tiles definition

https://gist.github.com/jsdidierlaurent/e3dd5c939263c80d2202ba4eceabfd53

Improve Echo Logger

Change default logger for something like this :

[2018-01-16 10:35:24.38231] [MiddlewareServer/server.go:147] [INFO ] – Starting....
[2018-01-16 10:35:24.38252] [MiddlewareServer/server.go:148] [ERROR] – some error

Instead of JSON

See : labstack/echo#1017

Monitoror doesn't seem to work

Hi guys!

The demo on your website doesn't seem to work.

In the same way, I can't get Monitoror to run on my machine (Debian 64 bits) with the provided executable and default configuration. I get the same error as on your site using ?configPath mode. At the end I'm asked to check my configuration because it can't be loaded.

Did I miss a step?

Add client-config validation route

GET : /api/v1/config/validate
With 2 possible parameters:

• url: url of hosted config (like on github/gitlab/web server, watever)
• file: file name of configuration file hosted in config directory on host (require --client-config-directory parameter)

See: https://eagain.net/articles/go-dynamic-json/

Add HTTP support for simple http check

see : https://github.com/Alex-D/MonitoWall/blob/develop/server/modules/server.http.js

Change project structure

Change structure for something like this :
/cmd
├── main.go
/server
├── api/
├── route/
...
├── server.go
/front
...

https://www.codementor.io/packt/how-to-set-up-a-project-in-echo-mpo39w5zu

Create Makefile

Add Makefile for tarting build / tests / package front

Add command line interface

• monitoror version : expose full build info
• monitoror --version : expose version
• monitoror --help
• monitoror validate config.json
• monitoror --verbose
• monitoror init

Add CRC of builded artifacts to release

Retry configuration loading if first try fail

Change url in configuration / front

For fixing cache issue in configuration file, we need to replace the full url to path without host:port/api/v1.
Ex :
url: http://localhost:8080/api/v1/http/any?url=test.com
will be :
path: /http/any?url=test.com

For doing this, we need to add apiPath notion in front end.
By default apiPath = front hostname:port + /api/v1 but it's overridable in url params

After this, we can change the actual monitoror path :
http://localhost:8000/?config=http://localhost:8080/api/v1/config?path=./test/faker-config.json
by this :
http://localhost:8000/?apiPath=http://localhost:8080/api/v1&configPath=./test/faker-config.json
Or (in production)
http://localhost:8080/?configUrl=http://github.com/...

Add client-config hydrate route

In the future we will have "dynamic" tile (like list merge request or pipeline multi branch)
In the clinet-config we need a block for this type of config.

This route will transform this bloc in "classical" tile config (0-x tile by line)

POST : /api/v1/config/hydrate

Add range validator to tile with values

Rename darwin artifact to macos

It's a more user friendly name :)

Use the same base for every responses

• Create common struc in model/response.go
• Create "enum" for Status

Implement timeout logic

Return long cache if the call return timeout

Wrap Store for Put the value in the store with different timeout.
Using JSONErrorHandler with custom Error type and get the value if it's a timeout.

Config management

Use Viper for config setting and provide config to all Model and set config in echo.context

Add make command for bump version

cd front
npm --no-git-tag-version version xxx
cd ..
git add front/package.json
git commit -m "chore: bump version to xxxx"
git tag xxxx

Release version pipeline

• If version exist in tags, skip release binaries steps
• use VERSION file in build for setting binaries version
• use monitoror --version to set release / tag version
• create CHANGELOG file to setup CHANGELOG
• use https://github.com/tcnksm/ghr to release version / tag

see : https://circleci.com/blog/publishing-to-github-releases-via-circleci/

Add dynamic tiles for pingdom

Add API URL to each config tile

To keep server things on server side, sending API URLs via the config file seems to be a great way to avoid hardcoded URLs in front. Also, params can be added to the URL as the front does not need them (so we can drop them from config sent to front).

Note: do not forget group items and hydrated ones.

{
  columns: 4,
  tiles: [
    {
      type: 'ping',
      url: 'http://domain.tld:port/api/.../ping?param1&param2'
    }
  ]
}

Add Youtrack support

See : https://github.com/Alex-D/MonitoWall/blob/develop/server/modules/counter.youtrack.js

https://github.com/ckopjiuoh/go-youtrack-api-client

Remove randomized anti-DoS delay if useless + config

Randomized anti-DoS is only useful for some tile types:

• Jenkins

Change Error Handler

Actualy the Error Handler is from https://github.com/eurie-inc/echo-sample

Change it for Monitowall usage

Add scale factor (zoom in / out)

Add optional rowSpan and columnSpan tile configuration

{
  "rowSpan": 2,
  "columnSpan": 5,
}

Hide mouse pointer after a while

Normalize /api/v1/info output keys

Output from: http://localhost:8080/api/v1/info

{
  "build-info": {
    "version": "0.0.2-beta-31-g37cb071",
    "git-commit": "37cb071",
    "build-time": "2019-05-22T22:26:13+00:00"
  },
  "configuration": {
    "Port": 8080,
    "Env": "development",
    "UpstreamCache": {
      "Expire": 10000,
      "CleanupInterval": 1000
    },
    "DownstreamCache": {
      "Expire": 120000,
      "CleanupInterval": 10000
    },
    "Monitorable": {
      "Ping": {
        "Count": 2,
        "Timeout": 1000,
        "Interval": 100
      },
      "Port": {
        "Timeout": 1000
      },
      "Gitlab": {
        "Token": ""
      },
      "Github": {
        "Token": ""
      },
      "TravisCI": {
        "Token": "",
        "Timeout": 2000,
        "Url": "https://api.travis-ci.org/"
      }
    }
  }
}

Some keys are kebab-case, some are PascalCase, I will prefer camelCase everywhere, is that possible?

Rebrand "debug" flag to "faker"

Expose front

• In develop : expose front on port 3000 with npm and webpack
• In builded version : use webpack for building front and inject it inside go binaries and expose it in root directory

⚠️ backend must be start without webpack file (for develop)

• https://github.com/go-webpack/webpack
• https://github.com/go-bindata/go-bindata
• https://github.com/Caiyeon/goldfish
• https://github.com/GeertJohan/go.rice
• https://github.com/dfcook/vue-webpack4-template

Add README.md

Add structure for dynamic tiles

We need a dynamic / generated tiles in config.

• Jenkins multibranch pipeline
• MR build status in Gitlab
• List all checkers for pingdom

We need to add this in hydrate config process

⚠️ must works with groups

Adding cache on HTTP request for the same URL

Http repository can query the same URL with différent parameters (ex : different json key in the same file)

Caching file of the same url should be great

Add tests

Remove binder in ping and bind directly in delivery/http

Remove empty group in hydrate