Chapter 2. Monitoring and managing Red Hat Fuse applications on Spring Boot standalone

Procedure

1. Add the following dependency to your Fuse application’s pom.xml file:

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

   Note that you do not need to specify the exact version because it is provided by the Maven BOM.

2. Edit the src/main/resources/application.properties file:

   1. Set the following properties:

      • management.endpoints.web.exposure.include=hawtio,jolokia
      • hawtio.authenticationEnabled=false
      • management.endpoint.hawtio.enabled=true
      • management.endpoint.jolokia.enabled=true

   2. Optionally, set the management.endpoints.web.base-path property.

      By default for Spring Boot 2.x, the Fuse Console’s URL includes the context path (/actuator) of the management endpoints. For example:

      http://localhost:10001/actuator/hawtio/index.html

      To change this default URL, for example to specify http://localhost:10001/hawtio, set the management.endpoints.web.base-path property as shown here:

      management.endpoints.web.base-path=/

      Your application.properties settings should look similar to the following example:

      # ports
      
      server.port=8080
      
      management.server.port=10001
      
      # enable management endpoints for healthchecks and hawtio
      
      management.endpoints.enabled-by-default = false
      
      management.endpoint.hawtio.enabled = true
      
      management.endpoint.jolokia.enabled = true
      
      management.endpoints.health.enabled = true
      
      management.health.defaults.enabled=false
      
      camel.health.enabled=false
      
      camel.health.indicator.enabled=true
      
      management.endpoints.web.exposure.include=hawtio,jolokia
      
      hawtio.authenticationEnabled=false
      
      # change the URL so that it does not include the actuator folder
      
      management.endpoints.web.base-path=/

      Note

      By default, authentication for the Fuse Console on Spring Boot is disabled. Optionally, you can enable authentication by writing code specific to your Fuse Console distribution. Here is an example that you can use for guidance:

      https://github.com/hawtio/hawtio/tree/master/examples/springboot-authentication

3. Run the Fuse application:

   mvn spring-boot:run

4. To determine the port number for the Fuse Console URL, obtain the management.server.port value by looking at the value set in the src/main/resources/application.properties file. For example:

   management.server.port   = 10001

5. To open the Fuse Console in a browser, use the following URL syntax where nnnnn is the value of the management.server.port property:

   http://localhost:nnnnn/actuator/hawtio

   For example, if the management.server.port property value is 10001 and you have not set the management.endpoints.web.base-path property then the URL is:

   http://localhost:10001/actuator/hawtio/index.html

Procedure

1. Create a JSON file named hawtconfig.json in your local Fuse on Spring Boot standalone application’s src/main/webapp directory.

2. Open the src/main/webapp/hawtconfig.json in an editor of your choice, and then add the following content:

   {
     "branding": {
       "appName": "Red Hat Fuse Console",
       "appLogoUrl": "img/Logo-Red_Hat-Fuse-A-Reverse-RGB.png",
       "companyLogoUrl": "img/Logo-RedHat-A-Reverse-RGB.png"
     },
     "login": {
       "description": "",
       "links": []
     },
     "about": {
       "title": "Red Hat Fuse Console",
       "productInfo": [],
       "additionalInfo": "",
       "copyright": "",
       "imgSrc": "img/Logo-RedHat-A-Reverse-RGB.png"
     },
     "disabledRoutes": [
       "/camel/source",
       "/diagnostics",
       "/jvm/discover",
       "/jvm/local"
     ]
   }

3. Change the values of the configuration properties listed in Table A.1, “Fuse Console Configuration Properties”.
4. Save your changes.

5. Run Fuse on Spring Boot by using the following command:

   mvn spring-boot:run

6. In a web browser, open the Fuse Console by using this URL: http://localhost:10001/actuator/hawtio/index.html

Procedure

1. Set the hawtio.http.strictTransportSecurity and hawtio.http.publicKeyPins properties as shown in the following example:

   public static void main(String[] args) {
       System.setProperty("hawtio.http.strictTransportSecurity", "max-age=31536000; includeSubDomains; preload");
       System.setProperty("hawtio.http.publicKeyPins", "pin-sha256=cUPcTAZWKaASuYWhhneDttWpY3oBAkE3h2+soZS7sWs"; max-age=5184000; includeSubDomains");
       SpringApplication.run(YourSpringBootApplication.class, args);
   }

2. (For deploying on AWS only) To disable the Fuse Console’s proxy servlet, set the hawtio.disableProxy property as shown in the following example:

   public static void main(String[] args) {
       System.setProperty("hawtio.disableProxy", "true");
   }

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 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.