QueryProfilerJMX.java
/*
** Module : QueryProfilerJMX.java
** Abstract : Direct access to the query profiling resource.
**
** Copyright (c) 2022-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description----------------------------------
** 001 AL2 20220828 Created initial version.
** 002 GBB 20230512 Logging methods replaced by CentralLogger/ConversionStatus.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.jmx;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.function.ObjLongConsumer;
import java.util.function.Supplier;
import com.goldencode.p2j.persist.PersistenceException;
import com.goldencode.p2j.util.logging.*;
/**
* Direct access to the query profiling resource.
*/
public class QueryProfilerJMX
extends AbstractCounter
{
/** Logger */
private static final CentralLogger LOG = CentralLogger.get(QueryProfilerJMX.class);
/** Publisher for the number of rows extracted from result sets */
protected final ObjLongConsumer<String> publishRowsCount;
/** Publisher for the number of cache hits */
protected final ObjLongConsumer<String> publishCacheHits;
/** Publisher for the number of cache misses */
protected final ObjLongConsumer<String> publishCacheMisses;
/** Publisher for the total time spent in hydrate */
protected final ObjLongConsumer<String> publishHydrateTotalTime;
/**
* Create and register instance
*
* @param profiler
* Query Profiler MBean
*
* @return new <code>QueryProfilerJMX</code> instance
*/
public static QueryProfilerJMX getInstance(OptionalQueryProfiler profiler)
{
QueryProfilerJMX simple = new QueryProfilerJMX(profiler::updateRowsCount,
profiler::updateCacheHits,
profiler::updateCacheMisses,
profiler::updateHydrateTotalTime);
simple.setEnabler(simple::setEnabled); //prevent GC
profiler.register(simple.getEnabler());
return simple;
}
/**
* Constructor
*
* @param publishRowsCount
* Publisher for the number of rows extracted from result sets
* @param publishCacheHits
* Publisher for the number of cache hits
* @param publishCacheMisses
* Publisher for the number of cache misses
* @param publishHydrateTotalTime
* Publisher for the total time spent in hydrate
*/
protected QueryProfilerJMX(ObjLongConsumer<String> publishRowsCount,
ObjLongConsumer<String> publishCacheHits,
ObjLongConsumer<String> publishCacheMisses,
ObjLongConsumer<String> publishHydrateTotalTime)
{
this.publishRowsCount = publishRowsCount;
this.publishCacheHits = publishCacheHits;
this.publishCacheMisses = publishCacheMisses;
this.publishHydrateTotalTime = publishHydrateTotalTime;
}
/**
* Update the number of rows extracted from result sets
*
* @param rs
* The result set used by the query. Avoid overhead for
* extracting the statement unless the profiler is enabled.
* @param value
* The value used for update.
*/
public void updateRowsCount(ResultSet rs, long value)
{
if (enabled)
{
try
{
String query = rs.getStatement().toString();
if (query != null)
{
publishRowsCount.accept(query, value);
}
}
catch (SQLException e)
{
LOG.severe("", e);
}
}
}
/**
* Update the number of cache hits
*
* @param rs
* The result set used by the query. Avoid overhead for
* extracting the statement unless the profiler is enabled.
* @param value
* The value used for update.
*/
public void updateCacheHits(ResultSet rs, long value)
{
if (enabled)
{
try
{
String query = rs.getStatement().toString();
if (query != null)
{
publishCacheHits.accept(query, value);
}
}
catch (SQLException e)
{
LOG.severe("", e);
}
}
}
/**
* Update the number of cache misses
*
* @param rs
* The result set used by the query. Avoid overhead for
* extracting the statement unless the profiler is enabled.
* @param value
* The value used for update.
*/
public void updateCacheMisses(ResultSet rs, long value)
{
if (enabled)
{
try
{
String query = rs.getStatement().toString();
if (query != null)
{
publishCacheMisses.accept(query, value);
}
}
catch (SQLException e)
{
LOG.severe("", e);
}
}
}
/**
* Update the total time spent in hydrate
*
* @param rs
* The result set used by the query. Avoid overhead for
* extracting the statement unless the profiler is enabled.
* @param code
* The code responsible for hydrate.
*/
public void hydrateTotalTimer(ResultSet rs, Operation code)
{
if (!enabled)
{
try
{
code.exec();
}
catch (RuntimeException re)
{
// unchecked exception propagate as is. otherwise, we can't process ConditionException.
throw re;
}
catch (Exception e)
{
throw new RuntimeException(e);
}
return;
}
long start = System.nanoTime();
try
{
code.exec();
}
catch (RuntimeException re)
{
// unchecked exception propagate as is. otherwise, we can't process ConditionException.
throw re;
}
catch (Exception e)
{
throw new RuntimeException(e);
}
finally
{
long finish = System.nanoTime();
try
{
String query = rs.getStatement().toString();
if (query != null)
{
publishHydrateTotalTime.accept(query, finish - start);
}
}
catch (SQLException e)
{
LOG.severe("", e);
}
}
}
}