v5.0.0: Breaking changes

[TwiN]

With v5.0.0 just around the corner, I thought I'd share the upcoming breaking changes to allow users of Gatus to prepare, so here goes.

Upcoming breaking changes

Mandatory space in conditions between comparator and placeholders/values

Before, a condition (e.g. [STATUS] == 200) was split by its comparator (e.g. ==), which made it possible to omit spaces in the condition (e.g. [STATUS]==200).

As of v5.0.0, the comparator in each condition must be wrapped by a space (e.g. [STATUS] == 200) or the condition will not be valid.

Before vs. After

Before

endpoints:
  - name: "..."
    url: "..."
    conditions:
      - "[STATUS]==200"
      - "[RESPONSE_TIME]<1000"

After

endpoints:
  - name: "..."
    url: "..."
    conditions:
      - "[STATUS] == 200"
      - "[RESPONSE_TIME] < 1000"

Note that the "after" was also valid pre-v5.0.0.

Relevant PR: #382

Removal of deprecated services in favor of endpoints

services has been replaced by endpoints in v3.3.0 (#191), but backward compatibility has been retained until now. v5.0.0, however, will no longer support services, so make sure to update your configuration to use endpoints instead.

Before vs. After

Before

services:
  - name: "..."
    url: "..."

After

endpoints:
  - name: "..."
    url: "..."

Relevant PR: #381

Alerts will default to enabled: true

As of v5.0.0, endpoints[].alerts[].enabled will default to true unless alerting.<provider>.default-alert.enabled is set to false.

Before vs. After

Before

alerting:
  slack:
    webhook-url: "..."

endpoints:
  - name: example
    url: "https://example.org"
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: slack
        enabled: true

After

alerting:
  slack:
    webhook-url: "..."

endpoints:
  - name: example
    url: "https://example.org"
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: slack

Relevant PR: #380

Other changes

As of v5.0.0, you may now use ghcr.io/twin/gatus instead of twinproduction/gatus to retrieve the Docker image.

[salim-b]

@TwiN It appears a typo has sneaked in your above message: Instead of

alerting.<provider>.default-alerts.enabled

it should say

alerting.<provider>.default-alert.enabled

(no s in default-alert)

[TwiN]

Thanks for the heads up, I've fixed it!

[TwiN]

As of today, the master branch and the latest Docker image tag are on v5.0.0.

v5.0.0 will be officially released later today or this week.