github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/cdc/api/v2/health.go (about)

     1  // Copyright 2023 PingCAP, Inc.
     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  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package v2
    15  
    16  import (
    17  	"net/http"
    18  
    19  	"github.com/gin-gonic/gin"
    20  	"github.com/pingcap/tiflow/cdc/api/middleware"
    21  	cerror "github.com/pingcap/tiflow/pkg/errors"
    22  )
    23  
    24  // @Summary Check the health status of a TiCDC cluster
    25  // @Description Check the health status of a TiCDC cluster
    26  // @Tags common,v2
    27  // @Produce json
    28  // @Success 200 {object} EmptyResponse
    29  // @Failure 500,400 {object} model.HTTPError
    30  // @Router	/api/v2/health [get]
    31  func (h *OpenAPIV2) health(c *gin.Context) {
    32  	if !h.capture.IsController() {
    33  		middleware.ForwardToControllerMiddleware(h.capture)(c)
    34  		return
    35  	}
    36  
    37  	ctx := c.Request.Context()
    38  	health, err := h.capture.StatusProvider().IsHealthy(ctx)
    39  	if err != nil {
    40  		_ = c.Error(err)
    41  		return
    42  	}
    43  	if !health {
    44  		err = cerror.ErrClusterIsUnhealthy.FastGenByArgs()
    45  		_ = c.Error(err)
    46  		return
    47  	}
    48  	c.JSON(http.StatusOK, &EmptyResponse{})
    49  }