2024-05-09 22:56:16 -04:00
package endpoint
2024-04-08 21:00:40 -04:00
import (
"errors"
2025-07-30 12:18:10 -04:00
"time"
2024-04-08 21:00:40 -04:00
"github.com/TwiN/gatus/v5/alerting/alert"
2025-07-30 12:18:10 -04:00
"github.com/TwiN/gatus/v5/config/endpoint/heartbeat"
2025-09-05 15:39:12 -04:00
"github.com/TwiN/gatus/v5/config/key"
2025-07-30 12:18:10 -04:00
"github.com/TwiN/gatus/v5/config/maintenance"
2024-04-08 21:00:40 -04:00
)
var (
// ErrExternalEndpointWithNoToken is the error with which Gatus will panic if an external endpoint is configured without a token.
ErrExternalEndpointWithNoToken = errors . New ( "you must specify a token for each external endpoint" )
2025-07-30 12:18:10 -04:00
// ErrExternalEndpointHeartbeatIntervalTooLow is the error with which Gatus will panic if an external endpoint's heartbeat interval is less than 10 seconds.
ErrExternalEndpointHeartbeatIntervalTooLow = errors . New ( "heartbeat interval must be at least 10 seconds" )
2024-04-08 21:00:40 -04:00
)
// ExternalEndpoint is an endpoint whose result is pushed from outside Gatus, which means that
// said endpoints are not monitored by Gatus itself; Gatus only displays their results and takes
// care of alerting
type ExternalEndpoint struct {
// Enabled defines whether to enable the monitoring of the endpoint
Enabled * bool `yaml:"enabled,omitempty"`
// Name of the endpoint. Can be anything.
Name string `yaml:"name"`
// Group the endpoint is a part of. Used for grouping multiple endpoints together on the front end.
Group string `yaml:"group,omitempty"`
// Token is the bearer token that must be provided through the Authorization header to push results to the endpoint
Token string `yaml:"token,omitempty"`
// Alerts is the alerting configuration for the endpoint in case of failure
Alerts [] * alert . Alert `yaml:"alerts,omitempty"`
2025-07-30 12:18:10 -04:00
// MaintenanceWindow is the configuration for per-endpoint maintenance windows
MaintenanceWindows [] * maintenance . Config `yaml:"maintenance-windows,omitempty"`
// Heartbeat is the configuration that checks if the external endpoint has received new results when it should have.
Heartbeat heartbeat . Config `yaml:"heartbeat,omitempty"`
2024-04-08 21:00:40 -04:00
// NumberOfFailuresInARow is the number of unsuccessful evaluations in a row
NumberOfFailuresInARow int `yaml:"-"`
// NumberOfSuccessesInARow is the number of successful evaluations in a row
NumberOfSuccessesInARow int `yaml:"-"`
}
// ValidateAndSetDefaults validates the ExternalEndpoint and sets the default values
func ( externalEndpoint * ExternalEndpoint ) ValidateAndSetDefaults () error {
if err := validateEndpointNameGroupAndAlerts ( externalEndpoint . Name , externalEndpoint . Group , externalEndpoint . Alerts ); err != nil {
return err
}
if len ( externalEndpoint . Token ) == 0 {
return ErrExternalEndpointWithNoToken
}
2025-07-30 12:18:10 -04:00
if externalEndpoint . Heartbeat . Interval != 0 && externalEndpoint . Heartbeat . Interval < 10 * time . Second {
// If the heartbeat interval is set (non-0), it must be at least 10 seconds.
return ErrExternalEndpointHeartbeatIntervalTooLow
}
2024-04-08 21:00:40 -04:00
return nil
}
// IsEnabled returns whether the endpoint is enabled or not
func ( externalEndpoint * ExternalEndpoint ) IsEnabled () bool {
if externalEndpoint . Enabled == nil {
return true
}
return * externalEndpoint . Enabled
}
// DisplayName returns an identifier made up of the Name and, if not empty, the Group.
func ( externalEndpoint * ExternalEndpoint ) DisplayName () string {
if len ( externalEndpoint . Group ) > 0 {
return externalEndpoint . Group + "/" + externalEndpoint . Name
}
return externalEndpoint . Name
}
// Key returns the unique key for the Endpoint
func ( externalEndpoint * ExternalEndpoint ) Key () string {
2025-09-05 15:39:12 -04:00
return key . ConvertGroupAndNameToKey ( externalEndpoint . Group , externalEndpoint . Name )
2024-04-08 21:00:40 -04:00
}
// ToEndpoint converts the ExternalEndpoint to an Endpoint
func ( externalEndpoint * ExternalEndpoint ) ToEndpoint () * Endpoint {
endpoint := & Endpoint {
Enabled : externalEndpoint . Enabled ,
Name : externalEndpoint . Name ,
Group : externalEndpoint . Group ,
Alerts : externalEndpoint . Alerts ,
NumberOfFailuresInARow : externalEndpoint . NumberOfFailuresInARow ,
NumberOfSuccessesInARow : externalEndpoint . NumberOfSuccessesInARow ,
}
return endpoint
}