patterntesting.runtime.monitor.db.SqlStatistic Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of patterntesting-rt Show documentation

PatternTesting Runtime (patterntesting-rt) is the runtime component for the PatternTesting framework. It provides the annotations and base classes for the PatternTesting testing framework (e.g. patterntesting-check, patterntesting-concurrent or patterntesting-exception) but can be also used standalone for classpath monitoring or profiling. It uses AOP and AspectJ to perform this feat.

There is a newer version: 2.5.0

Show newest version

/*
 * $Id: SqlStatistic.java,v 1.9 2015/12/30 21:42:54 oboehm Exp $
 *
 * Copyright (c) 2014 by Oliver Boehm
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express orimplied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * (c)reated 16.04.2014 by oliver ([email protected])
 */

package patterntesting.runtime.monitor.db;

import java.util.regex.Pattern;

import org.slf4j.*;

import patterntesting.runtime.monitor.*;
import patterntesting.runtime.monitor.db.internal.*;
import patterntesting.runtime.util.*;

/**
 * This class monitors and measures SQL statements. To be able to distinguish
 * them from methods profiling it is a separate class derived from
 * {@link ProfileStatistic}.
 *
 * @author oliver
 * @since 1.4.2 (16.04.2014)
 */
public class SqlStatistic extends ProfileStatistic implements SqlStatisticMBean {

    private static final Logger LOG = LoggerFactory.getLogger(SqlStatistic.class);
    private static final SqlStatistic SQL_INSTANCE;

    /**
     * rootMonitor *must* be initialized before isJamonAvailable() is called.
     * Otherwise you'll get a NullPointerException because in
     * JamonAvailable() rootMonitor will be accessed (so rootMonitor must
     * be initialized before!)
     */
    static {
        SQL_INSTANCE = new SqlStatistic();
    }

    /**
     * Gets the single instance of SqlStatistic.
     *
     * @return single instance of SqlStatistic
     */
    public static SqlStatistic getInstance() {
        return SQL_INSTANCE;
    }

    private SqlStatistic() {
        super("SQL");
    }

    /**
     * Normally the {@link SqlStatistic} is already registered as MBean. So
     * you don't need to register it manually. But if you want to register it
     * under your own name you can use this method here. This can be useful if
     * your application runs on an application server with several other
     * active applications.
     *
     * @param name e.g "my.company.SqlStat"
     * @since 1.6
     */
    public static void registerAsMBean(final String name) {
        SQL_INSTANCE.registerMeAsMBean(name);
    }

    /**
     * To start a new statistic call this method. In contradiction to
     * {@link ProfileStatistic#reset()} old {@link ProfileMonitor}s will be not
     * kept.
     */
    public void reset() {
        synchronized(SqlStatistic.class) {
            this.resetRootMonitor();
        }
    }

    /**
     * Start.
     *
     * @param sql the sql
     * @return the started profile monitor
     */
    public static ProfileMonitor start(final String sql) {
        return SQL_INSTANCE.startProfileMonitorFor(sql.trim());
    }

    /**
     * Stops the given 'mon' and logs the given command with the needed time if
     * debug is enabled.
     *
     * @param mon the mon
     * @param command the command
     */
    public static void stop(final ProfileMonitor mon, final String command) {
        stop(mon, command, Void.TYPE);
    }

    /**
     * Stops the given 'mon' and logs the given command with the needed time if
     * debug is enabled.
     *
     * @param mon the mon
     * @param command the command
     * @param returnValue the return value
     */
    public static void stop(final ProfileMonitor mon, final String command, final Object returnValue) {
        mon.stop();
        if (LOG.isDebugEnabled()) {
            String msg = '"' + command + "\" returned with " + Converter.toShortString(returnValue)
                    + " after " + mon.getLastTime();
            if (LOG.isTraceEnabled()) {
                StackTraceElement[] stacktrace = StackTraceScanner.getCallerStackTrace(
                        new Pattern[0], SqlStatistic.class, StasiStatement.class,
                        StasiPreparedStatement.class);
                LOG.trace("{}\n\t{}", msg, Converter.toLongString(stacktrace).trim());
            } else {
                LOG.debug("{}.", msg);
            }
        }
    }

    /**
     * You can register the instance as shutdown hook. If the VM is
     * terminated the profile values are logged and dumped to a CSV file in the
     * tmp directory.
     *
     * @see #logStatistic()
     * @see #dumpStatistic()
     */
    public static void addAsShutdownHook() {
        addAsShutdownHook(SQL_INSTANCE);
    }

}