org.hibernate.engine.jdbc.spi.SqlStatementLogger.java Source code

Introduction

Here is the source code for org.hibernate.engine.jdbc.spi.SqlStatementLogger.java

Source

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.engine.jdbc.spi;

import java.sql.Statement;

import org.hibernate.engine.jdbc.internal.FormatStyle;
import org.hibernate.engine.jdbc.internal.Formatter;
import org.hibernate.internal.CoreLogging;
import org.hibernate.internal.build.AllowSysOut;

import org.jboss.logging.Logger;

/**
 * Centralize logging for SQL statements.
 *
 * @author Steve Ebersole
 */
public class SqlStatementLogger {
    private static final Logger LOG = CoreLogging.logger("org.hibernate.SQL");
    private static final Logger LOG_SLOW = CoreLogging.logger("org.hibernate.SQL_SLOW");

    private boolean logToStdout;
    private boolean format;

    /**
     * Configuration value that indicates slow query. (In milliseconds) 0 - disabled.
     */
    private final long logSlowQuery;

    /**
     * Constructs a new SqlStatementLogger instance.
     */
    public SqlStatementLogger() {
        this(false, false);
    }

    /**
     * Constructs a new SqlStatementLogger instance.
     *
     * @param logToStdout Should we log to STDOUT in addition to our internal logger.
     * @param format Should we format the statements prior to logging
     */
    public SqlStatementLogger(boolean logToStdout, boolean format) {
        this(logToStdout, format, 0);
    }

    /**
     * Constructs a new SqlStatementLogger instance.
     *
     * @param logToStdout Should we log to STDOUT in addition to our internal logger.
     * @param format Should we format the statements prior to logging
     * @param logSlowQuery Should we logs query which executed slower than specified milliseconds. 0 - disabled.
     */
    public SqlStatementLogger(boolean logToStdout, boolean format, long logSlowQuery) {
        this.logToStdout = logToStdout;
        this.format = format;
        this.logSlowQuery = logSlowQuery;
    }

    /**
     * Are we currently logging to stdout?
     *
     * @return True if we are currently logging to stdout; false otherwise.
     */
    public boolean isLogToStdout() {
        return logToStdout;
    }

    /**
     * Enable (true) or disable (false) logging to stdout.
     *
     * @param logToStdout True to enable logging to stdout; false to disable.
     *
     * @deprecated Will likely be removed:
     * Should either become immutable or threadsafe.
     */
    @Deprecated
    public void setLogToStdout(boolean logToStdout) {
        this.logToStdout = logToStdout;
    }

    public boolean isFormat() {
        return format;
    }

    /**
     * @deprecated Will likely be removed:
     * Should either become immutable or threadsafe.
     */
    @Deprecated
    public void setFormat(boolean format) {
        this.format = format;
    }

    public long getLogSlowQuery() {
        return logSlowQuery;
    }

    /**
     * Log a SQL statement string.
     *
     * @param statement The SQL statement.
     */
    public void logStatement(String statement) {
        // for now just assume a DML log for formatting
        logStatement(statement, FormatStyle.BASIC.getFormatter());
    }

    /**
     * Log a SQL statement string using the specified formatter
     *
     * @param statement The SQL statement.
     * @param formatter The formatter to use.
     */
    @AllowSysOut
    public void logStatement(String statement, Formatter formatter) {
        if (format) {
            if (logToStdout || LOG.isDebugEnabled()) {
                statement = formatter.format(statement);
            }
        }
        LOG.debug(statement);
        if (logToStdout) {
            System.out.println("Hibernate: " + statement);
        }
    }

    /**
     * Log a slow SQL query
     *
     * @param statement SQL statement.
     * @param startTime Start time in milliseconds.
     */
    public void logSlowQuery(Statement statement, long startTime) {
        if (logSlowQuery < 1) {
            return;
        }
        logSlowQuery(statement.toString(), startTime);
    }

    /**
     * Log a slow SQL query
     *
     * @param sql The SQL query.
     * @param startTime Start time in milliseconds.
     */
    @AllowSysOut
    public void logSlowQuery(String sql, long startTime) {
        if (logSlowQuery < 1) {
            return;
        }
        assert startTime > 0 : "startTime is invalid!";

        long spent = System.currentTimeMillis() - startTime;

        assert spent >= 0 : "startTime is invalid!";

        if (spent > logSlowQuery) {
            String logData = "SlowQuery: " + spent + " milliseconds. SQL: '" + sql + "'";
            LOG_SLOW.info(logData);
            if (logToStdout) {
                System.out.println(logData);
            }
        }
    }
}