github.com/splucs/witchcraft-go-server@v1.7.0/status/health/utils.go (about)

     1  // Copyright (c) 2018 Palantir Technologies. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package health
    16  
    17  import (
    18  	"github.com/palantir/witchcraft-go-server/conjure/witchcraft/api/health"
    19  )
    20  
    21  // UnhealthyHealthCheckResult returns an unhealthy health check result with type checkType and message message.
    22  func UnhealthyHealthCheckResult(checkType health.CheckType, message string) health.HealthCheckResult {
    23  	return health.HealthCheckResult{
    24  		Type:    checkType,
    25  		State:   health.HealthStateError,
    26  		Message: &message,
    27  	}
    28  }
    29  
    30  // HealthyHealthCheckResult returns healthy health check result with type checkType.
    31  func HealthyHealthCheckResult(checkType health.CheckType) health.HealthCheckResult {
    32  	return health.HealthCheckResult{
    33  		Type:  checkType,
    34  		State: health.HealthStateHealthy,
    35  	}
    36  }