Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

endpoint

package

Go to main page

Versions in this module

v5

v5.15.0

Dec 28, 2024

v5.14.0

Dec 19, 2024

v5.13.1

Nov 4, 2024

v5.13.0

Oct 22, 2024

v5.12.1

Aug 28, 2024

v5.12.0

Aug 27, 2024

v5.11.0

May 21, 2024

Changes in this version

+ const AnyFunctionPrefix

+ const BodyPlaceholder

+ const CertificateExpirationPlaceholder

+ const ConnectedPlaceholder

+ const DNSRCodePlaceholder

+ const DomainExpirationPlaceholder

+ const FunctionSuffix

+ const HasFunctionPrefix

+ const IPPlaceholder

+ const InvalidConditionElementSuffix

+ const LengthFunctionPrefix

+ const PatternFunctionPrefix

+ const ResponseTimePlaceholder

+ const StatusPlaceholder

+ var ErrEndpointWithInvalidNameOrGroup = errors.New("endpoint name and group must not have \" or \\")

+ var ErrEndpointWithNoCondition = errors.New("you must specify at least one condition per endpoint")

+ var ErrEndpointWithNoName = errors.New("you must specify a name for each endpoint")

+ var ErrEndpointWithNoURL = errors.New("you must specify an url for each endpoint")

+ var ErrExternalEndpointWithNoToken = errors.New("you must specify a token for each external endpoint")

+ var ErrInvalidConditionFormat = errors.New("invalid condition format: does not match '<VALUE> <COMPARATOR> <VALUE>'")

+ var ErrInvalidEndpointIntervalForDomainExpirationPlaceholder = errors.New(...)

+ var ErrUnknownEndpointType = errors.New("unknown endpoint type")

+ func ConvertGroupAndEndpointNameToKey(groupName, endpointName string) string

+ type Condition string

+ func (c Condition) Validate() error

+ type ConditionResult struct

+ Condition string

+ Success bool

+ type Endpoint struct

+ Alerts []*alert.Alert

+ Body string

+ ClientConfig *client.Config

+ Conditions []Condition

+ DNSConfig *dns.Config

+ Enabled *bool

+ GraphQL bool

+ Group string

+ Headers map[string]string

+ Interval time.Duration

+ Method string

+ Name string

+ NumberOfFailuresInARow int

+ NumberOfSuccessesInARow int

+ SSHConfig *sshconfig.Config

+ UIConfig *ui.Config

+ URL string

+ func (e *Endpoint) Close()

+ func (e *Endpoint) DisplayName() string

+ func (e *Endpoint) EvaluateHealth() *Result

+ func (e *Endpoint) IsEnabled() bool

+ func (e *Endpoint) Key() string

+ func (e *Endpoint) Type() Type

+ func (e *Endpoint) ValidateAndSetDefaults() error

+ type Event struct

+ Timestamp time.Time

+ Type EventType

+ func NewEventFromResult(result *Result) *Event

+ type EventType string

+ var EventHealthy EventType = "HEALTHY"

+ var EventStart EventType = "START"

+ var EventUnhealthy EventType = "UNHEALTHY"

+ type ExternalEndpoint struct

+ Alerts []*alert.Alert

+ Enabled *bool

+ Group string

+ Name string

+ NumberOfFailuresInARow int

+ NumberOfSuccessesInARow int

+ Token string

+ func (externalEndpoint *ExternalEndpoint) DisplayName() string

+ func (externalEndpoint *ExternalEndpoint) IsEnabled() bool

+ func (externalEndpoint *ExternalEndpoint) Key() string

+ func (externalEndpoint *ExternalEndpoint) ToEndpoint() *Endpoint

+ func (externalEndpoint *ExternalEndpoint) ValidateAndSetDefaults() error

+ type HourlyUptimeStatistics struct

+ SuccessfulExecutions uint64

+ TotalExecutions uint64

+ TotalExecutionsResponseTime uint64

+ type Result struct

+ Body []byte

+ CertificateExpiration time.Duration

+ ConditionResults []*ConditionResult

+ Connected bool

+ DNSRCode string

+ DomainExpiration time.Duration

+ Duration time.Duration

+ Errors []string

+ HTTPStatus int

+ Hostname string

+ IP string

+ Success bool

+ Timestamp time.Time

+ func (r *Result) AddError(error string)

+ type Status struct

+ Events []*Event

+ Group string

+ Key string

+ Name string

+ Results []*Result

+ Uptime *Uptime

+ func NewStatus(group, name string) *Status

+ type Type string

+ const ContentTypeHeader

+ const GatusUserAgent

+ const HostHeader

+ const TypeDNS

+ const TypeHTTP

+ const TypeICMP

+ const TypeSCTP

+ const TypeSSH

+ const TypeSTARTTLS

+ const TypeTCP

+ const TypeTLS

+ const TypeUDP

+ const TypeUNKNOWN

+ const TypeWS

+ const UserAgentHeader

+ type Uptime struct

+ HourlyStatistics map[int64]*HourlyUptimeStatistics

+ func NewUptime() *Uptime