Package org.javasimon.jdbc.logging

Logging feature of Simon JDBC Proxy driver.

See:
Description

Class Summary

CallbackLogParams	CallbackLogParams is data object and contains parameters from callback that are interesting for logging.
LoggingCallback	LoggingCallback implements JDBC logging logic.
LoggingCallback.CsvFormatter	CsvFormatter formats log messages to comma separated value form.
LoggingCallback.HumanFormatter	HumanFormatter formats log messages to human readable form.
SimonFormatter	SimonFormatter is abstract root for custom log formatters for logging feature of Simon JDBC driver.

Package org.javasimon.jdbc.logging Description

Logging feature of Simon JDBC Proxy driver.

This logging feature is based on Callback feature of Javasimon core library, see Callback. In short, Callback feature allow intercept event from Simon (like start, stop, etc.) and perform custom action, in this case log message with details into file or to console.

By default, start and stop event from all JDBC stopwatch Simons are logged. Jdbc stopwatches are determined by provided JDBC prefix. This means that logged events are connections starts and stops, statements starts and stops and sql executions.

Java standard logging feature (java.util.logging) is used for logging from Simon JDBC Proxy driver. There are three targets where to log and also three ways how to setup logging. Where to log:

• to console - log messages are routed through standard ConsoleHandler so messages are printed to error output (or somewhere where an output is redirected)
• to logger< - logger is provided by name, all messages are then logged by obtained Logger
• to file - filename is provided, log messages are routed through standard FileHandler

Log messages are by default formated to human readable form by build in human formatter (identificator: HUMAN). There is also other build-in csv formatter (identifier CSV). There is also possibility to provide custom formatter. Only requriment is that custom formatter extends from SimonFormatter.
How to setup JDBC logging:

• via JDBC URL - Simon JDBC URL can by enhanced with Simon specific parameters to setup logging to file, logger or console and format of log messages. For details about Simon URL specific parameters see Driver.
• via Simon configuration file - Callback configuration can be added into the configuration file:

  <simon-configuration>
  <callback class="org.javasimon.jdbc.logging.LoggingCallback"> <!-- don't mix it with org.javasimon.utils.LoggingCallback! -->
  <set property="prefix" value="org.javasimon.testdb"/>
  <set property="loggerName" value="myapp.testdb"/>
  <set property="logFilename" value="log/myapp.log"/>
  <set property="logToConsole"/> <!-- without value! -->
  <set property="logFormat" value="csv"/> <!-- can be also human -->
  </callback>
  ...
  </simon-configuration>

  If logToConsole or logFilename is omitted respective handler will not be used.
• by jmx - jmx package offers jmx.JdbcMXBean that provides methods for starting logging to file, logger or console and for stopping too. Each method has its parameters to setup specific details.