package core import ( "bytes" "crypto/x509" "encoding/json" "errors" "io/ioutil" "net" "net/http" "net/url" "strings" "time" "github.com/TwinProduction/gatus/alerting/alert" "github.com/TwinProduction/gatus/client" "github.com/TwinProduction/gatus/core/ui" "github.com/TwinProduction/gatus/util" ) const ( // HostHeader is the name of the header used to specify the host HostHeader = "Host" // ContentTypeHeader is the name of the header used to specify the content type ContentTypeHeader = "Content-Type" // UserAgentHeader is the name of the header used to specify the request's user agent UserAgentHeader = "User-Agent" // GatusUserAgent is the default user agent that Gatus uses to send requests. GatusUserAgent = "Gatus/1.0" ) var ( // ErrServiceWithNoCondition is the error with which Gatus will panic if a service is configured with no conditions ErrServiceWithNoCondition = errors.New("you must specify at least one condition per service") // ErrServiceWithNoURL is the error with which Gatus will panic if a service is configured with no url ErrServiceWithNoURL = errors.New("you must specify an url for each service") // ErrServiceWithNoName is the error with which Gatus will panic if a service is configured with no name ErrServiceWithNoName = errors.New("you must specify a name for each service") ) // Service is the configuration of a monitored endpoint type Service struct { // Name of the service. Can be anything. Name string `yaml:"name"` // Group the service is a part of. Used for grouping multiple services together on the front end. Group string `yaml:"group,omitempty"` // URL to send the request to URL string `yaml:"url"` // DNS is the configuration of DNS monitoring DNS *DNS `yaml:"dns,omitempty"` // Method of the request made to the url of the service Method string `yaml:"method,omitempty"` // Body of the request Body string `yaml:"body,omitempty"` // GraphQL is whether to wrap the body in a query param ({"query":"$body"}) GraphQL bool `yaml:"graphql,omitempty"` // Headers of the request Headers map[string]string `yaml:"headers,omitempty"` // Interval is the duration to wait between every status check Interval time.Duration `yaml:"interval,omitempty"` // Conditions used to determine the health of the service Conditions []*Condition `yaml:"conditions"` // Alerts is the alerting configuration for the service in case of failure Alerts []*alert.Alert `yaml:"alerts"` // ClientConfig is the configuration of the client used to communicate with the service's target ClientConfig *client.Config `yaml:"client"` // UIConfig is the configuration for the UI UIConfig *ui.Config `yaml:"ui"` // NumberOfFailuresInARow is the number of unsuccessful evaluations in a row NumberOfFailuresInARow int // NumberOfSuccessesInARow is the number of successful evaluations in a row NumberOfSuccessesInARow int } // ValidateAndSetDefaults validates the service's configuration and sets the default value of fields that have one func (service *Service) ValidateAndSetDefaults() error { // Set default values if service.ClientConfig == nil { service.ClientConfig = client.GetDefaultConfig() } else { service.ClientConfig.ValidateAndSetDefaults() } if service.UIConfig == nil { service.UIConfig = ui.GetDefaultConfig() } if service.Interval == 0 { service.Interval = 1 * time.Minute } if len(service.Method) == 0 { service.Method = http.MethodGet } if len(service.Headers) == 0 { service.Headers = make(map[string]string) } // Automatically add user agent header if there isn't one specified in the service configuration if _, userAgentHeaderExists := service.Headers[UserAgentHeader]; !userAgentHeaderExists { service.Headers[UserAgentHeader] = GatusUserAgent } // Automatically add "Content-Type: application/json" header if there's no Content-Type set // and service.GraphQL is set to true if _, contentTypeHeaderExists := service.Headers[ContentTypeHeader]; !contentTypeHeaderExists && service.GraphQL { service.Headers[ContentTypeHeader] = "application/json" } for _, serviceAlert := range service.Alerts { if serviceAlert.FailureThreshold <= 0 { serviceAlert.FailureThreshold = 3 } if serviceAlert.SuccessThreshold <= 0 { serviceAlert.SuccessThreshold = 2 } } if len(service.Name) == 0 { return ErrServiceWithNoName } if len(service.URL) == 0 { return ErrServiceWithNoURL } if len(service.Conditions) == 0 { return ErrServiceWithNoCondition } if service.DNS != nil { return service.DNS.validateAndSetDefault() } // Make sure that the request can be created _, err := http.NewRequest(service.Method, service.URL, bytes.NewBuffer([]byte(service.Body))) if err != nil { return err } return nil } // Key returns the unique key for the Service func (service Service) Key() string { return util.ConvertGroupAndServiceToKey(service.Group, service.Name) } // EvaluateHealth sends a request to the service's URL and evaluates the conditions of the service. func (service *Service) EvaluateHealth() *Result { result := &Result{Success: true, Errors: []string{}} service.getIP(result) if len(result.Errors) == 0 { service.call(result) } else { result.Success = false } for _, condition := range service.Conditions { success := condition.evaluate(result, service.UIConfig.DontResolveFailedConditions) if !success { result.Success = false } } result.Timestamp = time.Now() // No need to keep the body after the service has been evaluated result.body = nil // Clean up parameters that we don't need to keep in the results if service.UIConfig.HideHostname { result.Hostname = "" } return result } func (service *Service) getIP(result *Result) { if service.DNS != nil { result.Hostname = strings.TrimSuffix(service.URL, ":53") } else { urlObject, err := url.Parse(service.URL) if err != nil { result.AddError(err.Error()) return } result.Hostname = urlObject.Hostname() } ips, err := net.LookupIP(result.Hostname) if err != nil { result.AddError(err.Error()) return } result.IP = ips[0].String() } func (service *Service) call(result *Result) { var request *http.Request var response *http.Response var err error var certificate *x509.Certificate isServiceDNS := service.DNS != nil isServiceTCP := strings.HasPrefix(service.URL, "tcp://") isServiceICMP := strings.HasPrefix(service.URL, "icmp://") isServiceStartTLS := strings.HasPrefix(service.URL, "starttls://") isServiceHTTP := !isServiceDNS && !isServiceTCP && !isServiceICMP && !isServiceStartTLS if isServiceHTTP { request = service.buildHTTPRequest() } startTime := time.Now() if isServiceDNS { service.DNS.query(service.URL, result) result.Duration = time.Since(startTime) } else if isServiceStartTLS { result.Connected, certificate, err = client.CanPerformStartTLS(strings.TrimPrefix(service.URL, "starttls://"), service.ClientConfig) if err != nil { result.AddError(err.Error()) return } result.Duration = time.Since(startTime) result.CertificateExpiration = time.Until(certificate.NotAfter) } else if isServiceTCP { result.Connected = client.CanCreateTCPConnection(strings.TrimPrefix(service.URL, "tcp://"), service.ClientConfig) result.Duration = time.Since(startTime) } else if isServiceICMP { result.Connected, result.Duration = client.Ping(strings.TrimPrefix(service.URL, "icmp://"), service.ClientConfig) } else { response, err = client.GetHTTPClient(service.ClientConfig).Do(request) result.Duration = time.Since(startTime) if err != nil { result.AddError(err.Error()) return } defer response.Body.Close() if response.TLS != nil && len(response.TLS.PeerCertificates) > 0 { certificate = response.TLS.PeerCertificates[0] result.CertificateExpiration = time.Until(certificate.NotAfter) } result.HTTPStatus = response.StatusCode result.Connected = response.StatusCode > 0 // Only read the body if there's a condition that uses the BodyPlaceholder if service.needsToReadBody() { result.body, err = ioutil.ReadAll(response.Body) if err != nil { result.AddError(err.Error()) } } } } func (service *Service) buildHTTPRequest() *http.Request { var bodyBuffer *bytes.Buffer if service.GraphQL { graphQlBody := map[string]string{ "query": service.Body, } body, _ := json.Marshal(graphQlBody) bodyBuffer = bytes.NewBuffer(body) } else { bodyBuffer = bytes.NewBuffer([]byte(service.Body)) } request, _ := http.NewRequest(service.Method, service.URL, bodyBuffer) for k, v := range service.Headers { request.Header.Set(k, v) if k == HostHeader { request.Host = v } } return request } // needsToReadBody checks if there's any conditions that requires the response body to be read func (service *Service) needsToReadBody() bool { for _, condition := range service.Conditions { if condition.hasBodyPlaceholder() { return true } } return false }