github.com/minio/minio@v0.0.0-20240328213742-3f72439b8a27/cmd/healthcheck-router.go (about)

     1  // Copyright (c) 2015-2021 MinIO, Inc.
     2  //
     3  // This file is part of MinIO Object Storage stack
     4  //
     5  // This program is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Affero General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // This program is distributed in the hope that it will be useful
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU Affero General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Affero General Public License
    16  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  
    18  package cmd
    19  
    20  import (
    21  	"net/http"
    22  
    23  	"github.com/minio/mux"
    24  )
    25  
    26  const (
    27  	healthCheckPath            = "/health"
    28  	healthCheckLivenessPath    = "/live"
    29  	healthCheckReadinessPath   = "/ready"
    30  	healthCheckClusterPath     = "/cluster"
    31  	healthCheckClusterReadPath = "/cluster/read"
    32  	healthCheckPathPrefix      = minioReservedBucketPath + healthCheckPath
    33  )
    34  
    35  // registerHealthCheckRouter - add handler functions for liveness and readiness routes.
    36  func registerHealthCheckRouter(router *mux.Router) {
    37  	// Healthcheck router
    38  	healthRouter := router.PathPrefix(healthCheckPathPrefix).Subrouter()
    39  
    40  	// Cluster check handler to verify cluster is active
    41  	healthRouter.Methods(http.MethodGet).Path(healthCheckClusterPath).HandlerFunc(httpTraceAll(ClusterCheckHandler))
    42  	healthRouter.Methods(http.MethodHead).Path(healthCheckClusterPath).HandlerFunc(httpTraceAll(ClusterCheckHandler))
    43  	healthRouter.Methods(http.MethodGet).Path(healthCheckClusterReadPath).HandlerFunc(httpTraceAll(ClusterReadCheckHandler))
    44  	healthRouter.Methods(http.MethodHead).Path(healthCheckClusterReadPath).HandlerFunc(httpTraceAll(ClusterReadCheckHandler))
    45  
    46  	// Liveness handler
    47  	healthRouter.Methods(http.MethodGet).Path(healthCheckLivenessPath).HandlerFunc(httpTraceAll(LivenessCheckHandler))
    48  	healthRouter.Methods(http.MethodHead).Path(healthCheckLivenessPath).HandlerFunc(httpTraceAll(LivenessCheckHandler))
    49  
    50  	// Readiness handler
    51  	healthRouter.Methods(http.MethodGet).Path(healthCheckReadinessPath).HandlerFunc(httpTraceAll(ReadinessCheckHandler))
    52  	healthRouter.Methods(http.MethodHead).Path(healthCheckReadinessPath).HandlerFunc(httpTraceAll(ReadinessCheckHandler))
    53  }