Chapter 3. Monitoring and managing Red Hat Fuse applications on Karaf standalone

Procedure

1. In the command line, navigate to the directory in which you installed Red Hat Fuse and run the following command to start Fuse standalone:

   ./bin/fuse

   The Karaf console starts and shows version information, the default Fuse Console URL, and a list of common commands.

2. In a browser, type the URL to connect to the Fuse Console. For example: http://localhost:8181/hawtio
3. In the login page, type your user name and password and then click Log In.

Procedure

1. To set HTTPS as the required protocol, set the hawtio.http.strictTransportSecurity property in the $KARAF_HOME/etc/system.properties file as shown in the following example:

   hawtio.http.strictTransportSecurity = max-age=31536000; includeSubDomains; preload

2. To use public keys to secure responses, set the hawtio.http.publicKeyPins property in the $KARAF_HOME/etc/system.properties file as shown in the following example:

   hawtio.http.publicKeyPins = pin-sha256="cUPcTAZWKaASuYWhhneDttWpY3oBAkE3h2+soZS7sWs"; max-age=5184000; includeSubDomains

3. (For deploying on AWS only) To disable the Fuse Console’s proxy servlet, set the hawtio.disableProxy property to true in the $KARAF_HOME/etc/system.properties file as shown in the following example:

   hawtio.disableProxy = true;

4. For detailed instructions on how to enable SSL/TLS security, see the "Enabling SSL/TLS for Undertow in an Apache Karaf container" section in the Apache Karaf Security Guide.
5. For information on how to secure the Fuse Console with Red Hat Single Sign-On, see the section on securing the Hawtio administration console in the Red Hat Single Sign-on Securing Applications and Services Guide.

6. To ensure that a user has the necessary user role authorization to perform the Fuse Console operations that the user needs to perform, follow these steps to set a user role:

   1. Open the Red Hat Fuse etc/users.properties file in an editor.

   2. Add an entry for the user name, password, and role.

      For example, the following entry in the etc/users.properties file defines the admin user and grants the admin role.

      admin = secretpass,admin

   3. Save the file.

Procedure

1. Download the branding plugin example from https://github.com/hawtio/hawtio/tree/master/examples/branding-plugin to a local directory of your choice.

2. In an editor of your choice, open the Fuse Console branding plugin’s src/main/webapp/plugin/brandingPlugin.js file to customize the Fuse Console branding.

   You can change the values of the configuration properties listed in Table A.1, “Fuse Console Configuration Properties”.

3. Save your changes.

4. In an editor of your choice, open the Fuse Console branding plugin’s pom.xml file to its <parent> section:

   <parent>
       <groupId>io.hawt</groupId>
       <artifactId>project</artifactId>
       <version>2.9-SNAPSHOT</version>
       <relativePath>../..</relativePath>
     </parent>

5. Edit the <parent> section as follows:

   1. Change the value of the <version> property to match the version of your Fuse on Karaf installation. For example, if your Fuse on Karaf installation directory name is 2.0.0.fuse-760015, set the version to 2.0.0.fuse-760015.

   2. Remove the <relativePath>../..</relativePath> line.

      For example:

      <parent>
          <groupId>io.hawt</groupId>
          <artifactId>project</artifactId>
          <version> 2.0.0.fuse-760015</version>
            </parent>

6. In a Terminal window, build the branding-plugin project by running the following command:

   mvn clean install

7. If Fuse is not already running, start it by running the following command:

   Linux/Unix: bin/fuse

   Windows: bin\fuse.bat`

8. At the Karaf CLI prompt, type the following command to install the Fuse Console branding plugin (where <version> is the version of your Fuse on Karaf installation):

   Linux/Unix: install -s mvn:io.hawt/branding-plugin/<version>/war

   Windows: install -s mvn:io.hawt\branding-plugin\<version>\war

9. In a web browser, open the Fuse Console by using the URL that the start command returned in Step 7 (the default URL is http://localhost:8181/hawtio/).

Procedure

1. In the upper right corner of the Fuse Console, click the user icon and then click Preferences.

   

2. Increase the value of the Maximum collection size option (the default is 50,000).
3. Click Close.

Procedure

1. To determine the hawtio-web bundle ID, use the following command to list the Fuse bundles that the Fuse Console uses:

   osgi:list | grep hawtio

2. To stop the bundle, use the osgi:stop command. For example, if the hawtio :: Web console bundle has an ID of 246, type this command:

   osgi:stop 246

Procedure

1. To view and edit MBean attributes:

   1. In the tree view, select an MBean.
   2. Click the Attributes tab.
   3. Click an attribute to see its details.

2. To perform operations:

   1. In the tree view, select an MBean.
   2. Click the Operations tab, expand one of the listed operations.
   3. Click Execute to run the operation.

3. To view charts:

   1. In the tree view, select an item.
   2. Click the Chart tab.

Procedure

1. To retrieve the number of instances of loaded classes and the amount of bytes they take up, click Class Histogram. If the operation is repeated, the tab shows the difference since last run.
2. To view the JVM diagnostic flag setting, click the JVM flags.
3. For a running JVM, you can also modify the flag settings.

Procedure

1. Click the Runtime tab and then the Threads subtab. The Threads page lists active threads and stack trace details for each thread. By default, the thread list shows all threads in descending ID order.
2. To sort the list by increasing ID, click the ID column label.
3. Optionally, filter the list by thread state (for example, Blocked) or by thread name.
4. To drill down to detailed information for a specific thread, such as the lock class name and full stack trace for that thread, in the Actions column, click More.

Procedure

1. To view a list of the log entries, click the Log Entries tab.

   By default, the list shows log entries in ascending order.

   You can drill down to each log entry to view detailed information about the log entry.

2. To filter the list of logs to show specific log types, click the Action Bar. You can filter the log entries section according to a text string or the logging level.

3. To change the Fuse Console default settings:

   1. In the upper right corner of the Fuse Console, click the user icon and then click Preferences from the drop-down menu.

      

   2. To change the default sorting order, select Server Logs and then click the log entry link to drill down to details about the log entry, such as the bundle name, thread, and the full message text.

   3. Optionally, you can customize these settings for storing log messages:

      • The number of log statements to keep in the Fuse Console (the default is 100).
      • The global log level: INFO (the default), OFF, ERROR, WARN, and DEBUG.
      • The child-level messages to include, such as hawtio-oauth and hawtio-core-utils.
   4. To reset the Fuse Console Logs settings to the default values, click Reset Reset settings.