Apache
/
activemq-artemis
mirror of https://github.com/apache/activemq-artemis.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

ARTEMIS-3888 make web console detection more robust 

Currently the broker detects the presence of the web console by looking
for the name of a file (i.e. console.war). This is fragile because if
the file is renamed for any reason then the broker won't print the
status of the web console when it starts.

This commit improves web console detection by inspecting the
<display-name> tag in the war file's WEB-INF/web.xml. By default it
looks for "hawtio", but this can be customized using the system property
"org.apache.activemq.artemis.webConsoleDisplayName".
This commit is contained in:
Justin Bertram 2022-07-11 11:44:51 -05:00 committed by clebertsuconic
parent ff1fe7f6b5
commit 695bc5a648
3 changed files with 52 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
artemis-web/src/main/java/org/apache/activemq/artemis/component/WebServerComponent.java
View File

@ -28,6 +28,7 @@ import java.util.List;
import java.util.stream.Collectors;
import org.apache.activemq.artemis.ActiveMQWebLogger;
import org.apache.activemq.artemis.api.core.Pair;
import org.apache.activemq.artemis.components.ExternalComponent;
import org.apache.activemq.artemis.dto.AppDTO;
import org.apache.activemq.artemis.dto.BindingDTO;
@ -59,12 +60,15 @@ public class WebServerComponent implements ExternalComponent, WebServerComponent
private static final Logger logger = Logger.getLogger(WebServerComponent.class);
public static final String DIR_ALLOWED = "org.eclipse.jetty.servlet.Default.dirAllowed";
// this should match the value of <display-name> in the console war's WEB-INF/web.xml
public static final String WEB_CONSOLE_DISPLAY_NAME = System.getProperty("org.apache.activemq.artemis.webConsoleDisplayName", "hawtio");
private Server server;
private HandlerList handlers;
private WebServerDTO webServerConfig;
private final List<String> consoleUrls = new ArrayList<>();
private final List<String> jolokiaUrls = new ArrayList<>();
private final List<WebAppContext> webContexts = new ArrayList<>();;
private final List<Pair<WebAppContext, String>> webContextData = new ArrayList<>();
private ServerConnector[] connectors;
private Path artemisHomePath;
private Path temporaryWarDir;
@ -129,11 +133,7 @@ public class WebServerComponent implements ExternalComponent, WebServerComponent
WebAppContext webContext = createWebAppContext(app.url, app.war, dirToUse, virtualHosts[i]);
handlers.addHandler(webContext);
webContext.setInitParameter(DIR_ALLOWED, "false");
webContexts.add(webContext);
if (app.war.startsWith("console")) {
consoleUrls.add(binding.uri + "/" + app.url);
jolokiaUrls.add(binding.uri + "/" + app.url + "/jolokia");
}
webContextData.add(new Pair(webContext, binding.uri));
}
}
}
@ -179,13 +179,28 @@ public class WebServerComponent implements ExternalComponent, WebServerComponent
cleanupTmp();
server.start();
printStatus(bindings);
}
private void printStatus(List<BindingDTO> bindings) {
ActiveMQWebLogger.LOGGER.webserverStarted(bindings
.stream()
.map(binding -> binding.uri)
.collect(Collectors.joining(", ")));
ActiveMQWebLogger.LOGGER.jolokiaAvailable(String.join(", ", jolokiaUrls));
ActiveMQWebLogger.LOGGER.consoleAvailable(String.join(", ", consoleUrls));
// the web server has to start before the war's web.xml will be parsed
for (Pair<WebAppContext, String> data : webContextData) {
if (WEB_CONSOLE_DISPLAY_NAME.equals(data.getA().getDisplayName())) {
consoleUrls.add(data.getB() + data.getA().getContextPath());
jolokiaUrls.add(data.getB() + data.getA().getContextPath() + "/jolokia");
}
}
if (!jolokiaUrls.isEmpty()) {
ActiveMQWebLogger.LOGGER.jolokiaAvailable(String.join(", ", jolokiaUrls));
}
if (!consoleUrls.isEmpty()) {
ActiveMQWebLogger.LOGGER.consoleAvailable(String.join(", ", consoleUrls));
}
}
private ServerConnector createServerConnector(HttpConfiguration httpConfiguration,
@ -287,7 +302,7 @@ public class WebServerComponent implements ExternalComponent, WebServerComponent
}
private void cleanupTmp() {
if (webContexts.size() == 0) {
if (webContextData.size() == 0) {
//there is no webapp to be deployed (as in some tests)
return;
}
@ -304,10 +319,10 @@ public class WebServerComponent implements ExternalComponent, WebServerComponent
}
}
public void cleanupWebTemporaryFiles(List<WebAppContext> webContexts) throws Exception {
public void cleanupWebTemporaryFiles(List<Pair<WebAppContext, String>> webContextData) throws Exception {
List<File> temporaryFiles = new ArrayList<>();
for (WebAppContext context : webContexts) {
File tmpdir = context.getTempDirectory();
for (Pair<WebAppContext, String> data : webContextData) {
File tmpdir = data.getA().getTempDirectory();
temporaryFiles.add(tmpdir);
}
@ -371,8 +386,8 @@ public class WebServerComponent implements ExternalComponent, WebServerComponent
ActiveMQWebLogger.LOGGER.stoppingEmbeddedWebServer();
server.stop();
server = null;
cleanupWebTemporaryFiles(webContexts);
webContexts.clear();
cleanupWebTemporaryFiles(webContextData);
webContextData.clear();
jolokiaUrls.clear();
consoleUrls.clear();
handlers = null;
@ -380,7 +395,7 @@ public class WebServerComponent implements ExternalComponent, WebServerComponent
}
}
public List<WebAppContext> getWebContexts() {
return this.webContexts;
public List<Pair<WebAppContext, String>> getWebContextData() {
return this.webContextData;
}
}

3
artemis-web/src/test/java/org/apache/activemq/cli/test/WebServerComponentTest.java
View File

@ -59,6 +59,7 @@ import io.netty.handler.codec.http.HttpVersion;
import io.netty.handler.codec.http.LastHttpContent;
import io.netty.handler.ssl.SslHandler;
import io.netty.util.CharsetUtil;
import org.apache.activemq.artemis.api.core.Pair;
import org.apache.activemq.artemis.cli.factory.xml.XmlBrokerFactoryHandler;
import org.apache.activemq.artemis.component.WebServerComponent;
import org.apache.activemq.artemis.component.WebServerComponentTestAccessor;
@ -419,7 +420,7 @@ public class WebServerComponentTest extends Assert {
testedComponents.add(webServerComponent);
webServerComponent.configure(webServerDTO, "./target", "./target");
WebAppContext ctxt = WebServerComponentTestAccessor.createWebAppContext(webServerComponent, url, warName, Paths.get(".").resolve("target").toAbsolutePath(), null);
webServerComponent.getWebContexts().add(ctxt);
webServerComponent.getWebContextData().add(new Pair(ctxt, null));
WebInfConfiguration cfg = new WebInfConfiguration();
List<File> garbage = new ArrayList<>();

19
docs/user-manual/en/management-console.md
View File

@ -85,3 +85,22 @@ To create a new queue click on the address you want to bind the queue to and cli
Once you have created a queue you should be able to **Send** a message to it or **Browse** it or view the **Attributes** or **Charts**. Simply click on the queue in th ejmx tree and click on the appropriate tab.
You can also see a graphical view of all brokers, addresses, queues and their consumers using the **Diagram** tab.
### Status Logging
When the broker starts it will detect the presence of the web console and log
status information, e.g.:
```
INFO [org.apache.activemq.artemis] AMQ241002: Artemis Jolokia REST API available at http://localhost:8161/console/jolokia
INFO [org.apache.activemq.artemis] AMQ241004: Artemis Console available at http://localhost:8161/console
```
The web console is detected by inspecting the value of the `<display-name>` tag
in the war file's `WEB-INF/web.xml` descriptor. By default it looks for
`hawtio`. However, if this value is changed for any reason the broker can look
for this new value by setting the following system property
```
-Dorg.apache.activemq.artemis.webConsoleDisplayName=newValue
```