Releases: TwiN/gatus
v3.3.0
Renamed service
to endpoint
#191 #192
THIS CHANGE IS BACKWARD COMPATIBLE
I've been wanting to rename service
to endpoint
for a while now.
service
is confusing, and it doesn't align well with features I want to implement in the future.
As such, I finally decided to make the move.
What you need to know
For most people, all you need to do is replace services:
by endpoints:
in your configuration file, but here's a full break down of the changes that may impact you.
Endpoint changes
All /api/v1/services/*
routes will continue working until v4.0.0 for the sake of backward compatibility, but should be replaced by /api/v1/endpoints/*
.
This includes badges.
Configuration changes
services
has been renamed to endpoints
, but the former will continue being supported until v5.0.0. This is a pretty big breaking change, and I want people to have enough time to migrate.
Before:
services:
- name: website
url: "https://twin.sh/health"
conditions:
- "[STATUS] == 200"
After:
endpoints:
- name: website
url: "https://twin.sh/health"
conditions:
- "[STATUS] == 200"
If you continue using services
in your configuration, there will be a warning logged in the console pointing to this issue
Storage
SQLite and Postgres
If you are using a storage of type sqlite
or postgres
, the data in the old tables will not be migrated. I considered automatically migrating the data, but decided that it was not worth the trouble given that currently, the retention period is very short.
That being said, the old tables are not going to be automatically deleted, in case you are using said data for other purposes.
Here is a list of the old table names and their replacements:
- service -> endpoints
- service_event -> endpoint_events
- service_result -> endpoint_results
- service_result_condition -> endpoint_result_conditions
- service_uptime -> endpoint_uptimes
If you have any questions, please ask them in #191
v3.2.3
v3.2.2
- Added support for PagerDuty group-specific integration key #181 - Thanks to @achrefbensaadVPaccount
- Fixed #182: ICMP not working on Docker Linux
⚠ Migrated TwinProduction/gatus to TwiN/gatus
NOTE: The Docker repository will not be affected by this change
v3.2.1
v3.2.0
v3.1.0
v3.0.0
Breaking changes
- Kubernetes auto discovery has been removed #135
service[].insecure
has been replaced in favor ofservice[].client.insecure
alerting.mattermost.insecure
has been replaced byalerting.mattermost.client.insecure
alerting.custom.insecure
has been replaced byalerting.custom.client.insecure
The following deprecated endpoints have been removed:
/api/v1/statuses
- Replaced by
/api/v1/services/statuses
- Replaced by
/api/v1/statuses/{key}
- Replaced by
/api/v1/services/{key}/statuses
- Replaced by
/api/v1/badges/uptime/{duration}/{identifier}
- Replaced by
/api/v1/services/{key}/uptimes/{duration}/badge.svg
- Replaced by
Features
- Added the ability to hide the hostname of a service #159
v2.9.0
- Added badges for response time #160 #156
- Added a response time chart #160 #142
- Updated badge colors #125
- Created new endpoints:
/api/v1/services/statuses
/api/v1/services/{key}/statuses
/api/v1/services/{key}/uptimes/{duration}/badge.svg
/api/v1/services/{key}/response-times/{duration}/badge.svg
/api/v1/services/{key}/response-times/{duration}/chart.svg
- Deprecated the following endpoints:
/api/v1/statuses
/api/v1/statuses/{key}
/api/v1/badges/uptime/{duration}/{identifier}
NOTE: This major release may be the last one before v3.0.0. If you're using any of the deprecated endpoints or configuration parameters, make sure to migrate to them as soon as you can.
v2.8.2
- Renamed storage type
inmemory
tomemory
- Added more uptime badge colors #125
NOTICE: v3.0.0 is just around the corner, and with it will come several breaking changes. For those of you using the latest
tag, you may want to pin a specific version. Furthermore, keep an eye on the startup application logs, as most deprecated features your configuration is still leveraging that will be removed or modified in v3.0.0 should have relevant logs warning you of what to expect.
v2.8.1
- Added alerting provider for Microsoft Teams #143 - Thanks to @zeylos
- Added the ability to configure the client used to monitor services (
timeout
,insecure
,ignore-redirect
) and some alerting providers #126- Deprecated
alerting.custom.insecure
in favor ofalerting.custom.client.insecure
- Deprecated
alerting.mattermost.insecure
in favor ofalerting.mattermost.client.insecure
- Deprecated
- Deprecated Kubernetes implementation (see discussion)