Configuring a Logging Profile in JBoss EAP

30 minutes
  • 5 Learning Objectives

About this Hands-on Lab

JBoss Enterprise Application Platform allows us to do more than simply deploy applications — we can also manage and maintain them during their lifecycle. Part of this is the ability to log what we need when we need it, which is where JBoss EAP logging profiles come in. Logging profiles allow us to write customized logging rules that we then attach to our applications as desired.

Learning Objectives

Successfully complete this lab by achieving the following learning objectives:

Create the Logging Profile
  1. Access the JBoss EAP CLI:

    cd /opt/jboss-eap/
    sudo ./bin/jboss-cli.sh
    connect
  1. Create the appdebug logging profile:

    /subsystem=logging/logging-profile=appdebug:add
Create the File Handler
  1. Create the file handler:

    /subsystem=logging/logging-profile=appdebug/file-handler=appdebug-handler:add(file={path=>"debug.log", "relative-to"=>"jboss.server.log.dir"})
  1. Set the log level for the handler:

    /subsystem=logging/logging-profile=appdebug/file-handler=appdebug-handler:write-attribute(name="level", value="TRACE")
Create a Logger Category
  1. Add the logger category:

    /subsystem=logging/logging-profile=appdebug/logger=app.debug:add(level=DEBUG)
  1. Assign the handler to the category:

    /subsystem=logging/logging-profile=appdebug/logger=org.hibernate:add-handler(name="appdebug-handler")
Set Logs to Format as JSON

Ensure the logs will be formatted as JSON:

/subsystem=logging/logging-profile=appdebug/json-formatter=NAME:add(pretty-print=true, exception-output-type=formatted)
Add the Logger Profile to the Application
  1. Exit the CLI:

    exit
  1. Move into /home/cloud_user/kitchensink:

    cd ~/kitchensink
  2. Add a MANIFEST.MF file to the application:

    vim src/main/resources/META-INF/MANIFEST.MF
    
    Manifest-Version: 1.0
    Logging-Profile: appdebug
  3. Deploy the application:

    sudo mvn clean install wildfly:deploy

Additional Resources

As one of the administrators maintaining the JBoss EAP configurations for your applications, you have been tasked with ensuring that a debugging logging profile is available to apply to any troublesome applications. Using the JBoss CLI, create an appdebug logging profile, associated file handler and category, then assigned the new profile to the kitchensink application in the cloud_user's home directory.

Deploy the application to ensure debug.log log has been created.

What are Hands-on Labs

Hands-on Labs are real environments created by industry experts to help you learn. These environments help you gain knowledge and experience, practice without compromising your system, test without risk, destroy without fear, and let you learn from your mistakes. Hands-on Labs: practice your skills before delivering in the real world.

Get Started
Who’s going to be learning?

How many seats do you need?

  • $499 USD per seat per year
  • Billed Annually
  • Renews in 12 months

Ready to accelerate learning?

For over 25 licenses, a member of our sales team will walk you through a custom tailored solution for your business.


$2,495.00

Checkout
Sign In
Welcome Back!

Psst…this one if you’ve been moved to ACG!