You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2018/09/05 17:37:17 UTC
[GitHub] rdhabalia closed pull request #2518: Add CLI to get function status
of a specific instance
rdhabalia closed pull request #2518: Add CLI to get function status of a specific instance
URL: https://github.com/apache/incubator-pulsar/pull/2518
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Functions.java b/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Functions.java
index 96e9cbc916..9a18460f6c 100644
--- a/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Functions.java
+++ b/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Functions.java
@@ -26,6 +26,7 @@
import org.apache.pulsar.client.admin.PulsarAdminException.PreconditionFailedException;
import org.apache.pulsar.common.io.ConnectorDefinition;
import org.apache.pulsar.functions.proto.Function.FunctionDetails;
+import org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus;
import org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatusList;
import org.apache.pulsar.functions.proto.InstanceCommunication.Metrics;
import org.apache.pulsar.functions.worker.WorkerInfo;
@@ -181,7 +182,24 @@
* Unexpected error
*/
FunctionStatusList getFunctionStatus(String tenant, String namespace, String function) throws PulsarAdminException;
-
+
+ /**
+ * Gets the current status of a function instance.
+ *
+ * @param tenant
+ * Tenant name
+ * @param namespace
+ * Namespace name
+ * @param function
+ * Function name
+ * @param id
+ * Function instance-id
+ * @return
+ * @throws PulsarAdminException
+ */
+ FunctionStatus getFunctionStatus(String tenant, String namespace, String function, int id)
+ throws PulsarAdminException;
+
/**
* Restart function instance
*
diff --git a/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/internal/FunctionsImpl.java b/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/internal/FunctionsImpl.java
index 4552ebae9a..7dc7050ac5 100644
--- a/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/internal/FunctionsImpl.java
+++ b/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/internal/FunctionsImpl.java
@@ -46,6 +46,7 @@
import org.apache.pulsar.common.io.ConnectorDefinition;
import org.apache.pulsar.common.policies.data.ErrorData;
import org.apache.pulsar.functions.proto.Function.FunctionDetails;
+import org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatus;
import org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatusList;
import org.apache.pulsar.functions.worker.WorkerInfo;
import org.glassfish.jersey.media.multipart.FormDataBodyPart;
@@ -109,6 +110,25 @@ public FunctionStatusList getFunctionStatus(
}
}
+ @Override
+ public FunctionStatus getFunctionStatus(String tenant, String namespace, String function, int id)
+ throws PulsarAdminException {
+ try {
+ Response response = request(
+ functions.path(tenant).path(namespace).path(function).path(Integer.toString(id)).path("status"))
+ .get();
+ if (!response.getStatusInfo().equals(Response.Status.OK)) {
+ throw new ClientErrorException(response);
+ }
+ String jsonResponse = response.readEntity(String.class);
+ FunctionStatus.Builder functionStatusBuilder = FunctionStatus.newBuilder();
+ mergeJson(jsonResponse, functionStatusBuilder);
+ return functionStatusBuilder.build();
+ } catch (Exception e) {
+ throw getApiException(e);
+ }
+ }
+
@Override
public void createFunction(FunctionDetails functionDetails, String fileName) throws PulsarAdminException {
try {
diff --git a/pulsar-client-tools-test/src/test/java/org/apache/pulsar/admin/cli/CmdFunctionsTest.java b/pulsar-client-tools-test/src/test/java/org/apache/pulsar/admin/cli/CmdFunctionsTest.java
index fe0a3f48b7..de5a9e0d77 100644
--- a/pulsar-client-tools-test/src/test/java/org/apache/pulsar/admin/cli/CmdFunctionsTest.java
+++ b/pulsar-client-tools-test/src/test/java/org/apache/pulsar/admin/cli/CmdFunctionsTest.java
@@ -30,6 +30,7 @@
import org.apache.pulsar.admin.cli.CmdFunctions.CreateFunction;
import org.apache.pulsar.admin.cli.CmdFunctions.DeleteFunction;
import org.apache.pulsar.admin.cli.CmdFunctions.GetFunction;
+import org.apache.pulsar.admin.cli.CmdFunctions.GetFunctionStatus;
import org.apache.pulsar.admin.cli.CmdFunctions.ListFunctions;
import org.apache.pulsar.admin.cli.CmdFunctions.RestartFunction;
import org.apache.pulsar.admin.cli.CmdFunctions.StopFunction;
@@ -304,6 +305,21 @@ public void testCreateFunctionWithHttpUrl() throws Exception {
assertEquals(outputTopicName, creater.getOutput());
}
+ @Test
+ public void testGetFunctionStatus() throws Exception {
+ String fnName = TEST_NAME + "-function";
+ String tenant = "sample";
+ String namespace = "ns1";
+ int instanceId = 0;
+ cmd.run(new String[] { "getstatus", "--tenant", tenant, "--namespace", namespace, "--name", fnName,
+ "--instance-id", Integer.toString(instanceId)});
+
+ GetFunctionStatus status = cmd.getStatuser();
+ assertEquals(fnName, status.getFunctionName());
+
+ verify(functions, times(1)).getFunctionStatus(tenant, namespace, fnName, instanceId);
+ }
+
@Test
public void testCreateFunctionWithFileUrl() throws Exception {
String fnName = TEST_NAME + "-function";
diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java
index 7f2f52122e..99ef4ddbae 100644
--- a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java
+++ b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdFunctions.java
@@ -872,9 +872,16 @@ void runCmd() throws Exception {
@Parameters(commandDescription = "Check the current status of a Pulsar Function")
class GetFunctionStatus extends FunctionCommand {
+
+ @Parameter(names = "--instance-id", description = "The function instanceId (Get-status of all instances if instance-id is not provided")
+ protected String instanceId;
+
@Override
void runCmd() throws Exception {
- String json = Utils.printJson(admin.functions().getFunctionStatus(tenant, namespace, functionName));
+ String json = Utils.printJson(
+ isBlank(instanceId) ? admin.functions().getFunctionStatus(tenant, namespace, functionName)
+ : admin.functions().getFunctionStatus(tenant, namespace, functionName,
+ Integer.parseInt(instanceId)));
Gson gson = new GsonBuilder().setPrettyPrinting().create();
System.out.println(gson.toJson(new JsonParser().parse(json)));
}
diff --git a/site2/docs/reference-pulsar-admin.md b/site2/docs/reference-pulsar-admin.md
index 03e1472daf..5b1fb41d8b 100644
--- a/site2/docs/reference-pulsar-admin.md
+++ b/site2/docs/reference-pulsar-admin.md
@@ -501,7 +501,7 @@ Options
|`--name`|The name of the function||
|`--namespace`|The namespace of the function||
|`--tenant`|The tenant of the function||
-
+|`--instance-id`|The function instanceId; get status of all instances if instance-id is not provided||
### `list`
List all Pulsar Functions for a specific tenant and namespace
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services