Grails – How to Use Native Server Logging Configuration (e.g. Tomcat GlassFish JBoss)

Grails comes complete with logging out-of-the-box. However, if a Grails application is being deployed to a production servlet container, it may be advisable or even required for Grails to step aside and let the server admins do their jobs 🙂

Update: There’s a follow up that includes full source and a ready-to-deploy war. See How to Deploy a Grails Application to JBoss 5.

You need not avoid the loggers injected by Grails in order to use the native logging provided by servlet containers (e.g. Tomcat, GlassFish, JBoss). Grails loggers (always have implemented and now still) implement org.apache.commons.log.Log through jcl-over-slf4j delegating to some slf4j implementation adapter. You’re free to choose which logging system will ultimately perform the “real” logging. This is what we do:

  1. Use the slf4j Implementation adapter that delegates to the native logging supplied by the web server container, e.g. slf4j-log4j12 for JBoss or slf4j-jdk14 for GlassFish / standard Tomcat 6. One (and only one) of those must be packaged within the war.
  2. Remove any logging implementation from our war (e.g. log4j), as it will be supplied by the servlet container (e.g. Log4j with JBoss or Java-logging with GlassFish / standard Tomcat 6.x).
  3. Disable Grails logging configurator.
  4. Use whatever means the web server container offers to configure its logging.

Step 2 can be implemented within grails-app/BuildConfig.groovy similar to:

grails.war.resources = {stagingDir ->
  def toRemove = [
          "$stagingDir/WEB-INF/lib/log4j-1.2.14.jar", // Logging -> native GlassFish/Tomcat/JBoss
          "$stagingDir/WEB-INF/lib/log4j-1.2.15.jar", // "
          "$stagingDir/WEB-INF/classes/log4j.properties", // "
          "$stagingDir/WEB-INF/lib/slf4j-log4j12-1.5.6.jar", // "
          "$stagingDir/WEB-INF/lib/slf4j-log4j12-1.5.8.jar", // "
  ].each {
    delete(file: it)
  }
}

Step 3 can be achieved by altering the web.xml, either verbatim or by means of a grails-app/scripts/_Events.groovy which might looks similar to:

import groovy.xml.StreamingMarkupBuilder

eventWebXmlEnd = {String tmpfile ->

 def root = new XmlSlurper().parse(webXmlFile)

 // remove some log4j stuff
 def log4j = root.listener.findAll {node ->
   node.'listener-class'.text() == 'org.codehaus.groovy.grails.web.util.Log4jConfigListener'
 }
 log4j.replaceNode {}

 def log4jFile = root.'context-param'.findAll {node ->
   node.'param-name'.text() == 'log4jConfigLocation'
 }
 log4jFile.replaceNode {}

 webXmlFile.text = new StreamingMarkupBuilder().bind {
   mkp.declareNamespace("": "http://java.sun.com/xml/ns/j2ee")
   mkp.yield(root)
 }
}

About Reiner

Born 1954 in Ratisbon (Bavaria, Germany), in 1976 punched cards at Berlin Technical University, caught hacking one of its mainframes by Horst Zuse (son of Konrad Zuse), started studying computer science and soon was offered a job whithin their computer department doing systems programming for IBM VM/370. While studying, jobbed around Germany at various places doing all sorts of things, then returned to Berlin to work at SRZ (computer aided typesetting). Never finished my master degree, but chose to take up self-employed work (which didn't turn me rich nor famous). Now working for a mid-sized software company within a very promising department as head of server software development.
This entry was posted in English, Grails. Bookmark the permalink.

10 Responses to Grails – How to Use Native Server Logging Configuration (e.g. Tomcat GlassFish JBoss)

  1. illegal golf clubs says:

    Awesome blog! Is your theme custom made or did you download it from somewhere?
    A design like yours with a few simple tweeks would really
    make my blog stand out. Please let me know where you got your theme.
    Thanks

    Like

    • Reiner says:

      The theme is (better was) called Twistered Little, has never made it to WordPress.com and has ceased to be maintained by its author long ago. Astonishingly enough it sported a perfect user experience on mobile devices too. As I’ve now moved from my own hardware to WordPress.com it’ll only live on in our memory 😦

      Like

  2. more information says:

    At this time I am ready to do my breakfast, when having my breakfast coming yet again to read additional news.

    Like

  3. wastefulabdomen71.shutterfly.com says:

    Je suis entièrement d’accord avec toi

    Like

  4. porn suceuse de Queues says:

    Sublime article : persiste de cette façon

    Like

  5. film horor terbaru hollywood 2011 says:

    kalo mau tanya-tanya Ngehub kemana bro..?

    Like

  6. Pingback: How to Deploy a Grails Application to JBoss 5 | Reiner Saddey’s Place

  7. http://softeclipse.com says:

    Hey there outstanding website! Does running a blog
    such as this take a massive amount work? I’ve virtually no understanding of computer programming however I was hoping to
    start my own blog in the near future. Anyhow, if you have any recommendations
    or tips for new blog owners please share. I understand this is off topic nevertheless I just wanted to ask.
    Appreciate it!

    Like

  8. voirfilms says:

    Undeniably consider that that you said. Your favorite justification appeared to be on the internet the easiest factor to understand of.
    I say to you, I definitely get irked while other people consider worries
    that they plainly do not recognize about. You managed to hit the nail upon the top and outlined out the
    whole thing without having side effect , other people can take
    a signal. Will probably be back to get more.
    Thanks

    Like

  9. Pingback: Grails日志配置正在劫持外部日志配置,如何停止呢? – FIXBBS

Leave a comment