hawtio / hawtio

Hawtio web console helps you manage your JVM stuff and stay cool!

Introduction

Hawtio is a lightweight and modular Web console for managing Java applications.

Hawtio has plugins such as: Apache Camel and JMX (Logs, Spring Boot, Quartz, and more will be provided soon). You can dynamically extend Hawtio with your own plugins or automatically discover plugins inside the JVM.

The only server side dependency (other than the static HTML/CSS/JS/images) is the excellent Jolokia library which has small footprint (around 300KB) and is available as a JVM agent, or comes embedded as a servlet inside the hawtio-default.war.

Get Started

• Running from CLI
• Running a Spring Boot app
• Running a Quarkus app
• Deploying on OpenShift

For more details and other containers, see Get Started Guide.

Running from CLI (JBang)

If you haven't installed JBang yet, first install it: https://www.jbang.dev/download/

You can start up Hawtio on your machine using the following jbang command.

jbang app install hawtio@hawtio/hawtio
hawtio --help

Running a Spring Boot app

Note

Hawtio v4 supports Spring Boot 3.x.

You can attach the Hawtio console to your Spring Boot app with the following steps.

1. Add io.hawt:hawtio-springboot to the dependencies in pom.xml:

   <dependency>
     <groupId>io.hawt</groupId>
     <artifactId>hawtio-springboot</artifactId>
     <version>4.0.0</version>
   </dependency>

2. Enable the Hawtio and Jolokia endpoints by adding the following line in application.properties:

   management.endpoints.web.exposure.include=hawtio,jolokia
   spring.jmx.enabled=true

Now you should be able to run Hawtio in your Spring Boot app as follows:

mvn spring-boot:run

Opening http://localhost:8080/actuator/hawtio should show the Hawtio console.

See Spring Boot example for a working example app.

Running a Quarkus app

Note

Hawtio v4 supports Quarkus 3.x.

You can attach the Hawtio console to your Quarkus app by adding io.hawt:hawtio-quarkus to the dependencies in pom.xml:

<dependency>
  <groupId>io.hawt</groupId>
  <artifactId>hawtio-quarkus</artifactId>
  <version>4.0.0</version>
</dependency>

Now you should be able to run Hawtio with your Quarkus app in development mode as follows:

mvn compile quarkus:dev

Opening http://localhost:8080/hawtio should show the Hawtio console.

See Quarkus example for a working example app.

Contributing

We love contributions! Here are the resources on how to get you involved in Hawtio development.

• FAQ
• Change Log
• How to contribute
• Community

Check out the GitHub issues for finding issues to work on.

License

Hawtio is licensed under Apache License, Version 2.0.

hawtio's Issues

support visualising OSGi services and bundle/service dependencies

visualise master/slave and networks of brokers

selecting a broker Diagram it might be nice for the diagram to show any master/slave or network of brokers plus (optionally) client connections in a diagram.

I wonder if an ActiveMQ MBean inside a broker could generate the information necessary to draw the diagram from a single method call; since it typically knows the network, master/slave and connections?

Infinite Loop between routes Chart and CharsEdit

Repeat Steps

• In Chrome
• At the top click View -> Charts
• Then click the following on the tree nodes
  • com.sun.management
    • HotSpotDiagnostic

The browser will now go into a crazy loop of switching between the Chart and ChartEdit routes

The lines of code that are causing this are presumably within charts.ts, as you can see the $location object being called with both Chart and ChartEdit in the two Controllers

allow editing of profiles

we could let folks directly edit things (e.g. making abstract, locking, changing parents, requirements etc etc) then have an Save/Apply and Cancel/Reset buttons which become enabled when you make changes. Having a way of applying all updates in a single operation would help things from a Fabric perspsective.

avoid the 404 on startup if there are no type=plugin hawtio plugins in JMX

We maybe should use the "search" rather than "list" to avoid the 404 errors? Or maybe just catch errors and gobble them up or something?

need some onSuccess / onFailure Growl like notification of operations occurring such as for create queue/topic

patch UI required for applying patches to a fabric

profile view for camel route; showing the 'profiling tree UI' like in Fuse IDE

to see the relative performance of each step of a camel route

create a jetty plugin to show a filtered view of the tomcat mbeans & a web app context view

allow send message UI to let folks choose file(s) from their file system to send to the queue/endpoint

move the images/css/js files for each module into a simpler directory structure

e.g. we should have a directory structure more like this to make things more modular...

    activemq/
      css/
      img/
      js/
      html/
    camel/
      css/
      img/
      js/
      html/

also it'd be nice if each module added its own routes to app.ts and tabs to index.html (so we probably need some kind of registry & directive of tabs)

Global Configuration service

It would be nice to have a hawtio service for registering configuration. This service would save/load state, and would abstract the need for converting objects to stringified JSON and parsing it back (which we'd have to do if we interacted directly with the localStorage service)

I imagine plugins which add themselves to hawtio will make use of this too. We could also make use of it in the preferences page. IE, plugins can expose what settings are configurable to the user

Hopefully I'll get time to work on this :)

create container wizard required

provide a stand alone console that can find all JVMs on the local machine and allow easy browse of them (like jconsole)

we could reuse the java code that does JMX discovery from Fuse IDE; then expose it as an MBean so folks can browse all the procesess on the local machine via hawtio.

e.g. here's the code to find the active JVMs:

https://github.com/fusesource/fuseide/blob/master/plugins/org.fusesource.ide.jmx.local/src/org/fusesource/ide/jmx/ui/internal/localjmx/JvmConnectionsNode.java#L67

would be nice to exclude the non *min.js *min.css files and the *.ts files and only include the minified files to reduce the WAR size

minify and combine the CSS files to a single CSS file for smaller/simpler/faster deployment

start/stop container UI on the containers view

Improve Type Information

It would be nice to add some more static typing information to the codebase to help beginners step through code :)

have a Diagram tab for OSGi bundle dependencies

kinda like either the ActiveMQ force-layout one or the more graphviz style camel one, so folks can see a dependency tree of bundles/packages/services

Add the ability to filter logs by logging level

It would be nice to filter the console logs by a specified logging level

In the future it would be nice to filter the logs by a specific logger name too

support drag and drop of messages from a queue/endpoint to file system/desktop/OS

minify the generated app.js file (with knowledge of angularjs controllers...)

we're only about 133K so far so its not a huge biggie, but would be nice one day...

not all profile information seems to be displayed correctly

its worth checking the plugin and the underlying FabricManagerMBean for these properties

• configProperties
• systemProperties
• configFiles

to check they are working OK

Added package.json to hawtio-web

Hi,

Just letting you know I added a package.json to the hawtio/hawtio-web directory, so you'll probably want to run npm install from that directory - I've updated the building instructions for this too

And just a quick note, I left some of the following fields blank to be filled in - as I don't know how you guys are wanting to run your project :)

    "keywords": [
    ]

    "author": "...",
    "contributors": [
    ]

    "licenses": [
        {
            "type": "Apache?",
            "url": "..."
        }
    ]

You could always just delete the fields too though, as they're optional :)

Cheers

have better UI for start/stop Camel context and routes

wonder if this could be generic so it could be reused for anything thats startable/stoppable? (e.g. bundles / broker)

default to 1 second polling for cubism charts

allow folks to edit the Camel route XML directly?

Camel message tracing - Highlighting choice + predicate

When running the sample with the Camel application. And you have message tracing enabled.
Then when using cursor up/down to highlight in the camel route where the message is. Then when you highlight the choice, then it also highlight the 1st predicate. This is wrong as it should only highlight the choice. (eg only 1 box should be blue).

make it easy for the tree and even nav bar to be hidden so that the tab can be come 'full screen' to so speak & be easier to embed in other iframes etc

would be nice to use a query URI argument BTW, so things are then bookmarkable and can then be reused as an iframe in other dashboards / consoles / UIs

Invoking JMX operation has reset button after result is shown - a bit confusing

Hi

See the screenshot. I invoked the JMX operation getCamelId, and there is now a Reset button.
I guess it should be a different label - maybe OK. Or something instead.

create a tomcat plugin to show a filtered view of the tomcat mbeans & a web app context view

have a packages view that shows all packages (searchable table) with the versions with links to the bundles / services using them

we could link the packages views from the bundle / service views?

create a plugin mechanism so folks can add new features easily

folks on different OSS projects might want to plugin different plugins for working with various server side components and middleware. Right now we've kinda hard coded activemq, camel, jmx & osgi and so forth in there which is fine and all, but ideally having a way for folks to create & release their own plugins independently of hawt.io would be nice.

Though for common Java stuff for example, it'd be good to get most components in the core hawt.io project too though; so its tested and released together.

I wonder if Bower might be a good way to do the plugins?
http://twitter.github.com/bower/

then folks can compose the JS/HTML/CSS as a bower bundle?

add / remove profile on the profiles view

Windows Building Support

I am following the build steps from here on windows

I am able to successfully run

cd hawtio-web
mvn test-compile exec:java

But running the maven profile 'watch' doesn't work

mvn -Pwatch

It results in the following error

[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 4.265s
[INFO] Finished at: Thu Dec 27 17:33:38 GMT 2012
[INFO] Final Memory: 13M/146M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.2.1:exec (typescript-compile) on project hawtio-web: Command execution failed. Cannot run program "grunt" (in directory "C:\Users\foo\Desktop\hawtio\hawtio-web"): CreateProcess error=2, The system cannot find the file specified -> [Help 1]

add better security so that only folks with actual read / write / execute karma can view the UI to read/write/execute

consider adding Ace editor suppport?

for message composition when sending messages, or editing Camel XML routes directly, or editing fabric profile configuration files etc...

https://github.com/ajaxorg/ace

support drag and drop of file system files to endpoints/queues/topics

Camel diagram - Should draws pipes and filters in a straight line style

In the sample there is a Camel app with 2 routes. The 1st route has from -> to -> to. But its drawn as a multicast kind of style with from going to both to. Instead it should be a straight line.

See the screenshot

Tests don't run when deployed via FuseMC

Hey all,

I was just trying to run the testacular tests after deploying hawtio to fabric using Fuse MC.
When using fabric:create -p fmc I was asked to put in a user+password, but because of this when I try to testacular tests chrome asks for the user/pass causing the tests to fail

Screenshot of Testacular asking for user/pass

Screenshot of test subsequently failing

I haven't got any Fuse MC/Fabric experience so I'm not sure of the best way to fix this :(
Help is much appreciated!

Cheers

support show/hide/reorder columns using ColVis plugin...

http://datatables.net/extras/colvis/

provide a command line shell to karaf or server

there are quite a few javascript based command shells / terminal emulators around:

• jQuery Terminal: http://terminal.jcubic.pl/
• jQuery Console: https://github.com/chrisdone/jquery-console
• https://github.com/joewalker/gcli/blob/master/docs/index.md demo here: http://mozilla.github.com/gcli/
• https://github.com/hbbio/webshell
• http://webshell.io/

I wonder how hard it would be to reuse the karaf/gogo shell back end, but use the JavaScript shell on the client side (using maybe an MBean over Jolokia)?

I guess whatever we go with, we'll need an MBean that talks to the GoGo shell inside (say) Karaf to do completion and execution; unless we go for something RESTy or websockety (for async output of commands).

This looks awesome too: http://acko.net/blog/on-termkit/
https://github.com/unconed/TermKit

wonder if that could be reused (or at least the concepts) with possibly different back end executors of the shell commands (bash v karaf v JBoss AS etc)

add header name/value (along with defaults for camel / JMS / AMQP) to UI for send message

Add screenshots to project home page for eye candy

I think we should add a screenshot to the front page.

And have a tab named Screenshots and have more screenshots.
This may catch peoples attention quicker if they can see a good looking screenshot as well.

Add configurable preferences for CodeMirror

There's a TODO in the code to allow for some of CodeMirror's core features to be configurable. Just creating a new issue for this to give some visibility that i'm toying around with this atm :)

Cheers

Need a registery for plugins that handle JMX domains

Ideally we'd want a service that plugins can register with to state that they handle a particular JMX domain so that domain can be hidden from the JMX tree. Also we need to ensure that when the app is loaded we show plugins that are applicable to what functionality is installed in the JVM.

default the charts to use 2 colours and no mirroring to avoid folks getting confused...

... then enable 4 colour & mirroring of horizon charts once folks get used to it

Can't compile hawtio-web (typescript error)

Hi,

I can't compile hawtio-web maven module even if typescript is well installed on my mac

https://gist.github.com/695b2c5f8e75b07c7b43

What could be the issue (access rights, permissions, ...)

Regards,

Charles

Community Information Issues

Hi,

Just letting you know the Community Information page has a deadlink under the 'Issue Tracker' section - when you click the start issues link it links to a tinyurl page (http://tinyurl.com/hawtio-starter-issues) that doesn't work

Also, the Issue Tracker section mentions that you should use the Github Issues page, but beneath it mentions that you need to raise issues on Jira? But I can't seem to find a link to the Jira, just the one for registering with JBoss. I checked the JBoss website, and I can't find hawtio here or here either. Does anyone have any idea where it is please?

Cheers

unit tests required for common operations (send to queue, browse queue, trace route etc)

A few things break now and again (e.g. expanding a message detail currently) - we kinda need integration tests that test out the web app ASAP so we can tell when we break stuff