You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pinot.apache.org by ne...@apache.org on 2022/04/25 17:16:47 UTC
[pinot] branch master updated: Add minion health check endpoint (#8574)
This is an automated email from the ASF dual-hosted git repository.
nehapawar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pinot.git
The following commit(s) were added to refs/heads/master by this push:
new 8b5314dd97 Add minion health check endpoint (#8574)
8b5314dd97 is described below
commit 8b5314dd97f1c73096fb8512072fd08cc068e7d4
Author: Saurabh Dubey <sa...@gmail.com>
AuthorDate: Mon Apr 25 22:46:37 2022 +0530
Add minion health check endpoint (#8574)
* Add minion health check endpoint
* Add health checks
* Review comments
Co-authored-by: Saurabh Dubey <sa...@Saurabhs-MacBook-Pro.local>
---
.../pinot/controller/BaseControllerStarter.java | 4 +-
.../org/apache/pinot/minion/BaseMinionStarter.java | 23 +++++++-
.../pinot/minion/MinionAdminApiApplication.java | 4 +-
.../minion/api/resources/HealthCheckResource.java | 66 ++++++++++++++++++++++
4 files changed, 91 insertions(+), 6 deletions(-)
diff --git a/pinot-controller/src/main/java/org/apache/pinot/controller/BaseControllerStarter.java b/pinot-controller/src/main/java/org/apache/pinot/controller/BaseControllerStarter.java
index 8f9507f87b..8425db6475 100644
--- a/pinot-controller/src/main/java/org/apache/pinot/controller/BaseControllerStarter.java
+++ b/pinot-controller/src/main/java/org/apache/pinot/controller/BaseControllerStarter.java
@@ -493,8 +493,8 @@ public abstract class BaseControllerStarter implements ServiceStartable {
private ServiceStatus.ServiceStatusCallback generateServiceStatusCallback(HelixManager helixManager) {
return new ServiceStatus.ServiceStatusCallback() {
- private boolean _isStarted = false;
- private String _statusDescription = "Helix ZK Not connected as " + helixManager.getInstanceType();
+ private volatile boolean _isStarted = false;
+ private volatile String _statusDescription = "Helix ZK Not connected as " + helixManager.getInstanceType();
@Override
public ServiceStatus.Status getServiceStatus() {
diff --git a/pinot-minion/src/main/java/org/apache/pinot/minion/BaseMinionStarter.java b/pinot-minion/src/main/java/org/apache/pinot/minion/BaseMinionStarter.java
index 8f3a91919d..57bde71218 100644
--- a/pinot-minion/src/main/java/org/apache/pinot/minion/BaseMinionStarter.java
+++ b/pinot-minion/src/main/java/org/apache/pinot/minion/BaseMinionStarter.java
@@ -240,22 +240,39 @@ public abstract class BaseMinionStarter implements ServiceStartable {
minionContext.setHelixPropertyStore(_helixManager.getHelixPropertyStore());
LOGGER.info("Starting minion admin application on: {}", ListenerConfigUtil.toString(_listenerConfigs));
- _minionAdminApplication = new MinionAdminApiApplication(_config);
+ _minionAdminApplication = new MinionAdminApiApplication(_instanceId, _config);
_minionAdminApplication.start(_listenerConfigs);
// Initialize health check callback
LOGGER.info("Initializing health check callback");
ServiceStatus.setServiceStatusCallback(_instanceId, new ServiceStatus.ServiceStatusCallback() {
+ private volatile boolean _isStarted = false;
+ private volatile String _statusDescription = "Helix ZK Not connected as " + _helixManager.getInstanceType();
+
@Override
public ServiceStatus.Status getServiceStatus() {
// TODO: add health check here
minionMetrics.addMeteredGlobalValue(MinionMeter.HEALTH_CHECK_GOOD_CALLS, 1L);
- return ServiceStatus.Status.GOOD;
+ if (_isStarted) {
+ if (_helixManager.isConnected()) {
+ return ServiceStatus.Status.GOOD;
+ } else {
+ return ServiceStatus.Status.BAD;
+ }
+ }
+
+ if (!_helixManager.isConnected()) {
+ return ServiceStatus.Status.STARTING;
+ } else {
+ _isStarted = true;
+ _statusDescription = ServiceStatus.STATUS_DESCRIPTION_NONE;
+ return ServiceStatus.Status.GOOD;
+ }
}
@Override
public String getStatusDescription() {
- return ServiceStatus.STATUS_DESCRIPTION_NONE;
+ return _statusDescription;
}
});
diff --git a/pinot-minion/src/main/java/org/apache/pinot/minion/MinionAdminApiApplication.java b/pinot-minion/src/main/java/org/apache/pinot/minion/MinionAdminApiApplication.java
index 779011adaa..6164b4cebd 100644
--- a/pinot-minion/src/main/java/org/apache/pinot/minion/MinionAdminApiApplication.java
+++ b/pinot-minion/src/main/java/org/apache/pinot/minion/MinionAdminApiApplication.java
@@ -45,10 +45,11 @@ import org.glassfish.jersey.server.ResourceConfig;
public class MinionAdminApiApplication extends ResourceConfig {
private static final String RESOURCE_PACKAGE = "org.apache.pinot.minion.api.resources";
public static final String PINOT_CONFIGURATION = "pinotConfiguration";
+ public static final String MINION_INSTANCE_ID = "minionInstanceId";
private HttpServer _httpServer;
- public MinionAdminApiApplication(PinotConfiguration minionConf) {
+ public MinionAdminApiApplication(String instanceId, PinotConfiguration minionConf) {
packages(RESOURCE_PACKAGE);
property(PINOT_CONFIGURATION, minionConf);
@@ -56,6 +57,7 @@ public class MinionAdminApiApplication extends ResourceConfig {
@Override
protected void configure() {
// TODO: Add bindings as needed in future.
+ bind(instanceId).named(MINION_INSTANCE_ID);
}
});
diff --git a/pinot-minion/src/main/java/org/apache/pinot/minion/api/resources/HealthCheckResource.java b/pinot-minion/src/main/java/org/apache/pinot/minion/api/resources/HealthCheckResource.java
new file mode 100644
index 0000000000..84f88688b6
--- /dev/null
+++ b/pinot-minion/src/main/java/org/apache/pinot/minion/api/resources/HealthCheckResource.java
@@ -0,0 +1,66 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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 org.apache.pinot.minion.api.resources;
+
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+import org.apache.pinot.common.utils.ServiceStatus;
+import org.apache.pinot.common.utils.ServiceStatus.Status;
+import org.apache.pinot.minion.MinionAdminApiApplication;
+
+
+/**
+ * REST API to do health check through ServiceStatus.
+ */
+@Api(tags = "Health")
+@Path("/")
+public class HealthCheckResource {
+ @Inject
+ @Named(MinionAdminApiApplication.MINION_INSTANCE_ID)
+ private String _instanceId;
+
+ @GET
+ @Path("/health")
+ @Produces(MediaType.TEXT_PLAIN)
+ @ApiOperation(value = "Checking minion health")
+ @ApiResponses(value = {
+ @ApiResponse(code = 200, message = "Minion is healthy"),
+ @ApiResponse(code = 503, message = "Minion is not healthy")
+ })
+ public String checkHealth() {
+ Status status = ServiceStatus.getServiceStatus(_instanceId);
+ if (status == Status.GOOD) {
+ return "OK";
+ }
+ String errMessage = String.format("Pinot minion status is %s", status);
+ Response response =
+ Response.status(Response.Status.SERVICE_UNAVAILABLE).entity(errMessage).build();
+ throw new WebApplicationException(errMessage, response);
+ }
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pinot.apache.org
For additional commands, e-mail: commits-help@pinot.apache.org