Gamedig Monitors

Gamedig monitors are used to monitor games and services. Currently, 320+ games and some services are available. You can view the entire list here. More than just the state of the game/service, it provides information about your game/service, such as players list, world name, connection method, and so on.

Monitors Gamedig

Host

REQUIRED

The host is the domain name, IPv4 or IPv6 of the game/service you want to monitor. The host should be valid.

Port

REQUIRED

The port is the query port of the game/service you want to monitor. Some games use a port, different from the one to connect, to accept queries, such as Minecraft with query-port. If you do not know the query port, you can let the monitor guess the port by checking the option Guess port.

Timeout

REQUIRED

The timeout is used to define the time in milliseconds after which the monitor should timeout. If the monitor does not respond within the timeout period, the monitor will be marked as down. For example, 10000 will set the timeout to 10 seconds. It is required and has to be a number greater than 2000 (or 2 seconds).

Request additional rules

Valve games can provide additional 'rules' to Gamedig monitors. If checked, they will be available in reponseRaw.raw (see Eval), beware that it may increase query time.

Eval

The eval is used to define the JavaScript code that should be used to evaluate the response. It is optional and has be a valid JavaScript code.

This is an anonymous JS function, it should return a Promise, that resolves or rejects to {status, latency}, by default it looks like this.

NOTE: The eval function should always return a json object. The json object can have only status(UP/DOWN/DEGRADED) and latency(number) {status: "DEGRADED", latency: 200}.

(async function (responseTime, responseRaw) {
    return {
        status: "UP",
        latency: responseTime
    }
})
  • responseTime REQUIRED is a number. It is the latency in milliseconds
  • responseRaw REQUIRED is the raw response of the game/service. It varies from game by game, we recommend first printing responseRaw with a simple console.log.

Additional notes

Some games/services need more configuration on their part to accept correctly any query of the monitor. You can consult these notes here.