/* * Copyright 1999-2018 Alibaba Group Holding Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package com.alibaba.nacos.console.controller; import com.alibaba.nacos.console.paramcheck.ConsoleDefaultHttpParamExtractor; import com.alibaba.nacos.core.cluster.health.ModuleHealthCheckerHolder; import com.alibaba.nacos.core.cluster.health.ReadinessResult; import com.alibaba.nacos.core.paramcheck.ExtractorManager; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import javax.servlet.http.HttpServletRequest; /** * Health Controller. * * @author hxy1991 */ @RestController("consoleHealth") @RequestMapping("/v1/console/health") @ExtractorManager.Extractor(httpExtractor = ConsoleDefaultHttpParamExtractor.class) public class HealthController { /** * Whether the Nacos is in broken states or not, and cannot recover except by being restarted. * * @return HTTP code equal to 200 indicates that Nacos is in right states. HTTP code equal to 500 indicates that * Nacos is in broken states. */ @GetMapping("/liveness") public ResponseEntity liveness() { return ResponseEntity.ok().body("OK"); } /** * Ready to receive the request or not. * * @return HTTP code equal to 200 indicates that Nacos is ready. HTTP code equal to 500 indicates that Nacos is not * ready. */ @GetMapping("/readiness") public ResponseEntity readiness(HttpServletRequest request) { ReadinessResult result = ModuleHealthCheckerHolder.getInstance().checkReadiness(); if (result.isSuccess()) { return ResponseEntity.ok().body("OK"); } return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(result.getResultMessage()); } }