Overview

Monitor your app

Know yourself but also know others behavior – Onyme Anne

Overwatch is a module that allow you to monitor error or hazardous behavior in your app. To do that you have to set up 2 or 3 things… Don’t worry it shouldn’t be too long ;)

To use the goblin overwatch you have to set up three things :

• Mode = “debounce” to receive error at regular interval via channels you defined or “manual” but you have to implement by yourself the way you report your errors.
• Channels = mail adresse(s) and/or discord channel(s)
• (optional) Agent = a cool character from overwatch that show up in discord. It’s Ana by default but you can customize it for each app :)

In debounce mode (default), you need to set up channels and an agent in your app.json for the app you want to monitor :

"goblin-overwatch": {
    "mode": "debounce",
    "channels": {
        "discord": ["xxxxxxxxxxxxxx9768/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-HF2aj85YGklWeTZWGeouGiIBueiM4m4Hyuc8"],
        "mail": ["goblin-overwatch@my-domain.ch"]
    },
    "agent": "mccree"
}

Once you have done that, at the start of your app, you just need to call the init quest of overwatch and enable log via the buslog :

    const owAPI = quest.getAPI('overwatch');
    yield owAPI.init();
    yield quest.cmd('buslog.enable', {modes: ['overwatch']});

In manual mode, you have to retrieve errors from overwatch by using the quest getAllErrors :

    const owAPI = quest.getAPI('overwatch');
    const errors = yield owAPI.getAllErrors();
    // errors = {exception:[...], hazard:[...]};
    // Do something with your errors, log in a file for example...