Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apache/activemq-artemis-console
Apache ActiveMQ Artemis Console
https://github.com/apache/activemq-artemis-console
activemq activemq-artemis apache broker console hawtio messaging ui
Last synced: 4 days ago
JSON representation
Apache ActiveMQ Artemis Console
- Host: GitHub
- URL: https://github.com/apache/activemq-artemis-console
- Owner: apache
- License: apache-2.0
- Created: 2024-04-22T14:42:43.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-23T09:57:03.000Z (10 days ago)
- Last Synced: 2024-09-25T15:46:58.991Z (8 days ago)
- Topics: activemq, activemq-artemis, apache, broker, console, hawtio, messaging, ui
- Language: TypeScript
- Homepage: https://activemq.apache.org/components/artemis
- Size: 3.05 MB
- Stars: 2
- Watchers: 13
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Apache ActiveMQ Artemis Console
The [Apache ActiveMQ Artemis](https://activemq.apache.org/components/artemis/) Console Plugin is written using [Hawtio v4](https://github.com/hawtio/hawtio).
The plugin is written in TypeScript. Since a Hawtio plugin is based on React and [Webpack Module Federation](https://module-federation.github.io/),
this project uses Yarn v3 and [CRACO](https://craco.js.org/) as the build tools.
The WAR file created by this project is consumed by ActiveMQ Artemis but can be developed and run standalone.
### Build
The following command first builds the `artemis-console-extension` frontend project and then compiles and packages
the main Java project Web Archive in `artemis-console-war`.
```console
mvn clean install
```
Building the frontend project 'artemis-console-extension' can take time, so if you build it once and make no changes on the project afterwards, you
can speed up the whole build by skipping the frontend part next time.
```console
mvn install -Dskip.yarn
```
### Test run
You can quickly run and test the console by using `jetty-maven-plugin` configured in `pom.xml`. It launches an embedded
Jetty server and deploys the plugin WAR application. From the 'artemis-console-war' directory run:
```console
cd artemis-console-war
mvn jetty:run -Dskip.yarn
```
You can access the Artemis console with the sample plugin at: . To connect to a running
Artemis instance click on the 'connect' menu item and click on the 'Add Connection' button. This will open up a dialog where
you can enter the Artemis Jolokia endpoint details, for a default Artemis installation this would be:
| Key | Value |
|--------|------------------|
| Name | Artemis |
| Schema | HTTP |
| Host | 127.0.0.1 |
| Port | 8161 |
| Path | /console/jolokia |
You can test the connection and then once saved connect to Artemis, This will open a new tab in the browser.
Note: If you use localhost for the 'Host' setting and you find the connection doesn't work this could be beacuse localhost
is being translated to your local ipv6 address rather than the ipv4 address. If that occurs use the IP address instead.
## Faster plugin development
You could run `mvn install` or `mvn jetty:run` every time to incrementally develop the `activemq-artemis-extension`
frontend project while checking its behaviour in the browser. But this is not suitable for running the fast development feedback cycle.
As shown below, a faster development cycle can be achieved by directly running the `artemis-console-extension`
frontend project itself in development mode with `yarn start`,
### Development
Start the plugin project in development mode:
```console
cd artemis-console-extension/artemis-extension
yarn start
```
Now you should be able to preview the plugins under development at . However, since it still
hasn't been connected to a backend JVM, you can then connect to a running Artemis instance using the connect tab using for
instance http://localhost:8161/console/jolokia.
You can now edit the artemis console web application and see changes loaded live.