The highest tagged major version is v5.

client

package

v4.4.0 Latest Latest Go to latest Published: Nov 23, 2022 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/TwiN/gatus

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func CanCreateSCTPConnection(address string, config *Config) bool
func CanCreateTCPConnection(address string, config *Config) bool
func CanCreateUDPConnection(address string, config *Config) bool
func CanPerformStartTLS(address string, config *Config) (connected bool, certificate *x509.Certificate, err error)
func CanPerformTLS(address string, config *Config) (connected bool, certificate *x509.Certificate, err error)
func GetDomainExpiration(hostname string) (domainExpiration time.Duration, err error)
func GetHTTPClient(config *Config) *http.Client
func InjectHTTPClient(httpClient *http.Client)
func Ping(address string, config *Config) (bool, time.Duration)
type Config
- func GetDefaultConfig() *Config
type DNSResolverConfig
type OAuth2Config

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrInvalidDNSResolver        = errors.New("invalid DNS resolver specified. Required format is {proto}://{ip}:{port}")
	ErrInvalidDNSResolverPort    = errors.New("invalid DNS resolver port")
	ErrInvalidClientOAuth2Config = errors.New("invalid OAuth2 configuration, all fields are required")
)

Functions ¶

func CanCreateSCTPConnection ¶ added in v4.4.0

func CanCreateSCTPConnection(address string, config *Config) bool

CanCreateSCTPConnection checks whether a connection can be established with a SCTP endpoint

func CanCreateTCPConnection ¶

func CanCreateTCPConnection(address string, config *Config) bool

CanCreateTCPConnection checks whether a connection can be established with a TCP endpoint

func CanCreateUDPConnection ¶ added in v4.4.0

func CanCreateUDPConnection(address string, config *Config) bool

CanCreateUDPConnection checks whether a connection can be established with a UDP endpoint

func CanPerformStartTLS ¶

func CanPerformStartTLS(address string, config *Config) (connected bool, certificate *x509.Certificate, err error)

CanPerformStartTLS checks whether a connection can be established to an address using the STARTTLS protocol

func CanPerformTLS ¶

func CanPerformTLS(address string, config *Config) (connected bool, certificate *x509.Certificate, err error)

CanPerformTLS checks whether a connection can be established to an address using the TLS protocol

func GetDomainExpiration ¶ added in v4.4.0

func GetDomainExpiration(hostname string) (domainExpiration time.Duration, err error)

GetDomainExpiration retrieves the duration until the domain provided expires

func GetHTTPClient ¶

func GetHTTPClient(config *Config) *http.Client

GetHTTPClient returns the shared HTTP client, or the client from the configuration passed

func InjectHTTPClient ¶

func InjectHTTPClient(httpClient *http.Client)

InjectHTTPClient is used to inject a custom HTTP client for testing purposes

func Ping ¶

func Ping(address string, config *Config) (bool, time.Duration)

Ping checks if an address can be pinged and returns the round-trip time if the address can be pinged

Note that this function takes at least 100ms, even if the address is 127.0.0.1

Types ¶

type Config ¶

type Config struct {
	// Insecure determines whether to skip verifying the server's certificate chain and host name
	Insecure bool `yaml:"insecure,omitempty"`

	// IgnoreRedirect determines whether to ignore redirects (true) or follow them (false, default)
	IgnoreRedirect bool `yaml:"ignore-redirect,omitempty"`

	// Timeout for the client
	Timeout time.Duration `yaml:"timeout"`

	// DNSResolver override for the HTTP client
	// Expected format is {protocol}://{host}:{port}, e.g. tcp://8.8.8.8:53
	DNSResolver string `yaml:"dns-resolver,omitempty"`

	// OAuth2Config is the OAuth2 configuration used for the client.
	//
	// If non-nil, the http.Client returned by getHTTPClient will automatically retrieve a token if necessary.
	// See configureOAuth2 for more details.
	OAuth2Config *OAuth2Config `yaml:"oauth2,omitempty"`
	// contains filtered or unexported fields
}

Config is the configuration for clients

func GetDefaultConfig ¶

func GetDefaultConfig() *Config

GetDefaultConfig returns a copy of the default configuration

func (*Config) HasCustomDNSResolver ¶

func (c *Config) HasCustomDNSResolver() bool

HasCustomDNSResolver returns whether a custom DNSResolver is configured

func (*Config) HasOAuth2Config ¶

func (c *Config) HasOAuth2Config() bool

HasOAuth2Config returns true if the client has OAuth2 configuration parameters

func (*Config) ValidateAndSetDefaults ¶

func (c *Config) ValidateAndSetDefaults() error

ValidateAndSetDefaults validates the client configuration and sets the default values if necessary

type DNSResolverConfig ¶

type DNSResolverConfig struct {
	Protocol string
	Host     string
	Port     string
}

DNSResolverConfig is the parsed configuration from the DNSResolver config string.

type OAuth2Config ¶

type OAuth2Config struct {
	TokenURL     string   `yaml:"token-url"` // e.g. https://dev-12345678.okta.com/token
	ClientID     string   `yaml:"client-id"`
	ClientSecret string   `yaml:"client-secret"`
	Scopes       []string `yaml:"scopes"` // e.g. ["openid"]
}

OAuth2Config is the configuration for the OAuth2 client credentials flow

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL