You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by cl...@apache.org on 2024/06/12 15:26:37 UTC
(activemq-artemis) 01/02: ARTEMIS-4815 json output into ./artemis queue stat
This is an automated email from the ASF dual-hosted git repository.
clebertsuconic pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/activemq-artemis.git
commit 842a176a4e6869315955506dd683f3c1f7921a59
Author: Clebert Suconic <cl...@apache.org>
AuthorDate: Wed Jun 12 11:22:05 2024 -0400
ARTEMIS-4815 json output into ./artemis queue stat
---
.../messages/ConnectionConfigurationAbtract.java | 7 ++++-
.../artemis/cli/commands/queue/StatQueue.java | 35 ++++++++++++++++++++++
.../org/apache/activemq/cli/test/ArtemisTest.java | 23 ++++++++++++++
3 files changed, 64 insertions(+), 1 deletion(-)
diff --git a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/messages/ConnectionConfigurationAbtract.java b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/messages/ConnectionConfigurationAbtract.java
index 9d6dd1cb85..7a01edcd80 100644
--- a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/messages/ConnectionConfigurationAbtract.java
+++ b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/messages/ConnectionConfigurationAbtract.java
@@ -36,6 +36,9 @@ public class ConnectionConfigurationAbtract extends InputAbstract {
@CommandLine.Option(names = "--password", description = "Password used to connect.")
protected String password;
+ // Sub classes may choose to avoid System.out output
+ protected boolean silent = false;
+
protected static ThreadLocal<ConnectionInformation> CONNECTION_INFORMATION = new ThreadLocal<>();
static class ConnectionInformation {
@@ -105,7 +108,9 @@ public class ConnectionConfigurationAbtract extends InputAbstract {
}
}
- context.out.println("Connection brokerURL = " + brokerURL);
+ if (!silent) {
+ context.out.println("Connection brokerURL = " + brokerURL);
+ }
return null;
}
diff --git a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/queue/StatQueue.java b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/queue/StatQueue.java
index 484a9e9ed0..05ee81b018 100644
--- a/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/queue/StatQueue.java
+++ b/artemis-cli/src/main/java/org/apache/activemq/artemis/cli/commands/queue/StatQueue.java
@@ -115,6 +115,9 @@ public class StatQueue extends ConnectionAbstract {
@Option(names = "--single-line-header", description = "Use a single line on the header titles")
private boolean singleLineHeader = false;
+ @Option(names = "--json", description = "Prints the queue stat information in JSON format, useful for scripts")
+ private boolean json;
+
public boolean isSingleLineHeader() {
return singleLineHeader;
}
@@ -171,8 +174,20 @@ public class StatQueue extends ConnectionAbstract {
return this;
}
+ public boolean isJson() {
+ return json;
+ }
+
+ public StatQueue setJson(boolean json) {
+ this.json = json;
+ return this;
+ }
+
@Override
public Object execute(ActionContext context) throws Exception {
+ if (json) {
+ silent = true;
+ }
super.execute(context);
String filter = createFilter();
@@ -187,6 +202,11 @@ public class StatQueue extends ConnectionAbstract {
}
createConnectionFactory();
+ if (json) {
+ jsonExecution(context, filter);
+ return 1;
+ }
+
singleExeuction(context, filter);
// if using the hidden parameter
@@ -217,6 +237,21 @@ public class StatQueue extends ConnectionAbstract {
return statCount;
}
+ private void jsonExecution(ActionContext context, String filter) throws Exception {
+ performCoreManagement(brokerURL, user, password, message -> {
+ ManagementHelper.putOperationInvocation(message, "broker", "listQueues", filter, 1, maxRows);
+ }, reply -> {
+ // some formatting, to make it more palatable
+ String result = (String) ManagementHelper.getResult(reply, String.class);
+ result = result.replace("{\"id\"", "\n {\"id\"");
+ result = result.replace("]", "\n]");
+ context.out.println(result);
+ }, reply -> {
+ String errMsg = (String) ManagementHelper.getResult(reply, String.class);
+ getActionContext().err.println("Failed to get Stats for Queues. Reason: " + errMsg);
+ });
+ }
+
private void singleExeuction(ActionContext context, String filter) throws Exception {
try (SimpleManagement simpleManagement = new SimpleManagement(brokerURL, user, password).open()) {
String nodeID = simpleManagement.getNodeID();
diff --git a/artemis-cli/src/test/java/org/apache/activemq/cli/test/ArtemisTest.java b/artemis-cli/src/test/java/org/apache/activemq/cli/test/ArtemisTest.java
index af5f5721bd..820b770550 100644
--- a/artemis-cli/src/test/java/org/apache/activemq/cli/test/ArtemisTest.java
+++ b/artemis-cli/src/test/java/org/apache/activemq/cli/test/ArtemisTest.java
@@ -52,6 +52,7 @@ import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
+import org.apache.activemq.artemis.api.core.management.SimpleManagement;
import org.apache.activemq.artemis.json.JsonArray;
import org.apache.activemq.artemis.json.JsonObject;
import org.apache.activemq.artemis.api.config.ActiveMQDefaultConfiguration;
@@ -94,6 +95,7 @@ import org.apache.activemq.artemis.jms.client.ActiveMQDestination;
import org.apache.activemq.artemis.nativo.jlibaio.LibaioContext;
import org.apache.activemq.artemis.utils.DefaultSensitiveStringCodec;
import org.apache.activemq.artemis.utils.HashProcessor;
+import org.apache.activemq.artemis.utils.JsonLoader;
import org.apache.activemq.artemis.utils.PasswordMaskingUtil;
import org.apache.activemq.artemis.utils.RandomUtil;
import org.apache.activemq.artemis.utils.SensitiveDataCodec;
@@ -104,6 +106,7 @@ import org.apache.commons.configuration2.PropertiesConfiguration;
import org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder;
import org.apache.commons.configuration2.builder.fluent.Configurations;
import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.Timeout;
@@ -1610,6 +1613,13 @@ public class ArtemisTest extends CliTestBase {
sendMessages(session, "Test11", 1);
sendMessages(session, "Test12", 1);
sendMessages(session, "Test20", 20);
+
+ {
+ SimpleManagement simpleManagement = new SimpleManagement("tcp://localhost:61616", "admin", "admin");
+ // send can be asynchronous, this is to make sure we got all messages in the queue. Later on I check the size of this queue.
+ Wait.assertEquals(20, () -> simpleManagement.getMessageCountOnQueue("Test20"));
+ }
+
MessageConsumer consumer = session.createConsumer(ActiveMQDestination.createDestination("queue://Test1", ActiveMQDestination.TYPE.QUEUE));
MessageConsumer consumer2 = session.createConsumer(ActiveMQDestination.createDestination("queue://Test1", ActiveMQDestination.TYPE.QUEUE));
@@ -1628,6 +1638,19 @@ public class ArtemisTest extends CliTestBase {
// Header line + 3 queues
assertEquals(5, lines.size(), "rows returned using queueName=Test1");
+ //check the json output is correct, we will parse the messageCount on Queue Test20
+ context = new TestActionContext();
+ statQueue = new StatQueue();
+ statQueue.setUser("admin");
+ statQueue.setPassword("admin");
+ statQueue.setJson(true);
+ statQueue.execute(context);
+ {
+ JsonObject json = JsonLoader.readObject(new InputStreamReader(new ByteArrayInputStream(context.getStdoutBytes())));
+ JsonArray arrayQueues = json.getJsonArray("data");
+ arrayQueues.stream().filter(jsonValue -> jsonValue.asJsonObject().getString("name").equals("Test20")).forEach(jsonValue -> Assertions.assertEquals(20, Integer.parseInt(jsonValue.asJsonObject().getString("messageCount"))));
+ }
+
//check all queues are displayed when no Filter set
context = new TestActionContext();
statQueue = new StatQueue();
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@activemq.apache.org
For additional commands, e-mail: commits-help@activemq.apache.org
For further information, visit: https://activemq.apache.org/contact