Package io.prometheus.client.hibernate

Class HibernateStatisticsCollector

java.lang.Object

io.prometheus.client.Collector

io.prometheus.client.hibernate.HibernateStatisticsCollector

public class HibernateStatisticsCollector
extends Collector

Collect metrics from one or more Hibernate SessionFactory instances.

Usage example for a single session factory:

 new HibernateStatisticsCollector(sessionFactory, "myapp").register();
 

Usage example for multiple session factories:

 new HibernateStatisticsCollector()
     .add(sessionFactory1, "myapp1")
     .add(sessionFactory2, "myapp2")
     .register();
 

If you are in a JPA environment, you can obtain the SessionFactory like this:

 SessionFactory sessionFactory =
     entityManagerFactory.unwrap(SessionFactory.class);
 

When enablePerQueryMetrics() has been called, certain metrics like execution time are collected per query. This may create a lot of monitoring data, so it should be used with caution.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static interface	HibernateStatisticsCollector.PerQuerySamples
private static interface	HibernateStatisticsCollector.ValueProvider
private static interface	HibernateStatisticsCollector.ValueProviderPerQuery

Nested classes/interfaces inherited from class io.prometheus.client.Collector

Collector.Describable, Collector.MetricFamilySamples, Collector.Type

Field Summary

Fields

Modifier and Type	Field	Description
private static final List<String>	LABEL_NAMES
private static final List<String>	LABEL_NAMES_PER_QUERY
private boolean	perQueryMetricsEnabled
private final Map<String,org.hibernate.SessionFactory>	sessionFactories

Fields inherited from class io.prometheus.client.Collector

MILLISECONDS_PER_SECOND, NANOSECONDS_PER_SECOND

Constructor Summary

Constructors

Constructor	Description
HibernateStatisticsCollector()	Creates an empty collector.
HibernateStatisticsCollector(org.hibernate.SessionFactory sessionFactory, String name)	Creates a new collector for the given session factory.

Method Summary

Modifier and Type	Method	Description
HibernateStatisticsCollector	add(org.hibernate.SessionFactory sessionFactory, String name)	Registers a Hibernate SessionFactory with this collector.
private void	addMetricsForQuery(HibernateStatisticsCollector.PerQuerySamples samples, HibernateStatisticsCollector.ValueProviderPerQuery provider)
List<Collector.MetricFamilySamples>	collect()	Return all metrics of this Collector.
private CounterMetricFamily	createCounter(String metric, String help, HibernateStatisticsCollector.ValueProvider provider)
private CounterMetricFamily	createCounterForQuery(String metric, String help, HibernateStatisticsCollector.ValueProviderPerQuery provider)
private GaugeMetricFamily	createGaugeForQuery(String metric, String help, HibernateStatisticsCollector.ValueProviderPerQuery provider)
HibernateStatisticsCollector	enablePerQueryMetrics()	Enables collection of per-query metrics.
private List<Collector.MetricFamilySamples>	getCacheMetrics()
private List<Collector.MetricFamilySamples>	getConnectionMetrics()
private List<Collector.MetricFamilySamples>	getEntityMetrics()
private List<Collector.MetricFamilySamples>	getPerQueryMetrics()
private List<Collector.MetricFamilySamples>	getQueryExecutionMetrics()
private List<Collector.MetricFamilySamples>	getSessionMetrics()
<T extends Collector> T	register(CollectorRegistry registry)	Register the Collector with the given registry.
private double	toSeconds(long milliseconds)

Methods inherited from class io.prometheus.client.Collector

checkMetricLabelName, checkMetricName, collect, doubleToGoString, register, sanitizeMetricName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LABEL_NAMES

private static final List<String> LABEL_NAMES

LABEL_NAMES_PER_QUERY

private static final List<String> LABEL_NAMES_PER_QUERY

sessionFactories

private final Map<String,org.hibernate.SessionFactory> sessionFactories

perQueryMetricsEnabled

private boolean perQueryMetricsEnabled

Constructor Details

HibernateStatisticsCollector

public HibernateStatisticsCollector()

Creates an empty collector. If you use this constructor, you have to add one or more session factories to the collector by calling the add(SessionFactory, String) method.

HibernateStatisticsCollector

public HibernateStatisticsCollector(org.hibernate.SessionFactory sessionFactory,
 String name)

Creates a new collector for the given session factory. Calling this constructor has the same effect as creating an empty collector and adding the session factory using add(SessionFactory, String).

Parameters:

sessionFactory - The Hibernate SessionFactory to collect metrics for

name - A unique name for this SessionFactory

Method Details

add

public HibernateStatisticsCollector add(org.hibernate.SessionFactory sessionFactory,
 String name)

Registers a Hibernate SessionFactory with this collector.

Parameters:

sessionFactory - The Hibernate SessionFactory to collect metrics for

name - A unique name for this SessionFactory

Returns:

Returns the collector

enablePerQueryMetrics

public HibernateStatisticsCollector enablePerQueryMetrics()

Enables collection of per-query metrics. Produces a lot of monitoring data, so use with caution.

Per-query metrics have a label "query" with the actual HQL query as value. The query will contain placeholders ("?") instead of the real parameter values (example: select u from User u where id=?).

Returns:

Returns the collector

collect

public List<Collector.MetricFamilySamples> collect()

Description copied from class: Collector

Return all metrics of this Collector.

Specified by:

collect in class Collector

register

public <T extends Collector> T register(CollectorRegistry registry)

Description copied from class: Collector

Register the Collector with the given registry.

Overrides:

register in class Collector

getSessionMetrics

private List<Collector.MetricFamilySamples> getSessionMetrics()

getConnectionMetrics

private List<Collector.MetricFamilySamples> getConnectionMetrics()

getCacheMetrics

private List<Collector.MetricFamilySamples> getCacheMetrics()

getEntityMetrics

private List<Collector.MetricFamilySamples> getEntityMetrics()

getQueryExecutionMetrics

private List<Collector.MetricFamilySamples> getQueryExecutionMetrics()

getPerQueryMetrics

private List<Collector.MetricFamilySamples> getPerQueryMetrics()

createCounter

private CounterMetricFamily createCounter(String metric,
 String help,
 HibernateStatisticsCollector.ValueProvider provider)

createCounterForQuery

private CounterMetricFamily createCounterForQuery(String metric,
 String help,
 HibernateStatisticsCollector.ValueProviderPerQuery provider)

createGaugeForQuery

private GaugeMetricFamily createGaugeForQuery(String metric,
 String help,
 HibernateStatisticsCollector.ValueProviderPerQuery provider)

addMetricsForQuery

private void addMetricsForQuery(HibernateStatisticsCollector.PerQuerySamples samples,
 HibernateStatisticsCollector.ValueProviderPerQuery provider)

toSeconds

private double toSeconds(long milliseconds)