Package org.hibernate.stat

Class HibernateQueryMetrics

  • All Implemented Interfaces:
    io.micrometer.core.instrument.binder.MeterBinder
    @NonNullApi
@NonNullFields
public class HibernateQueryMetrics
extends java.lang.Object
implements io.micrometer.core.instrument.binder.MeterBinder
    A MeterBinder implementation that provides Hibernate query metrics. It exposes the same statistics as would be exposed when calling Statistics.getQueryStatistics(String). Note that only SELECT queries are recorded in QueryStatistics.

    Be aware of the potential for high cardinality of unique Hibernate queries executed by your application when considering using this MeterBinder.

    • Constructor Summary

      Constructors 
      Constructor Description
      HibernateQueryMetrics​(SessionFactory sessionFactory, java.lang.String sessionFactoryName, java.lang.Iterable<io.micrometer.core.instrument.Tag> tags)
      Create a HibernateQueryMetrics.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void bindTo​(io.micrometer.core.instrument.MeterRegistry meterRegistry)  
      static void monitor​(io.micrometer.core.instrument.MeterRegistry registry, SessionFactory sessionFactory, java.lang.String sessionFactoryName, java.lang.Iterable<io.micrometer.core.instrument.Tag> tags)
      Create HibernateQueryMetrics and bind to the specified meter registry.
      static void monitor​(io.micrometer.core.instrument.MeterRegistry registry, SessionFactory sessionFactory, java.lang.String sessionFactoryName, java.lang.String... tags)
      Create HibernateQueryMetrics and bind to the specified meter registry.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HibernateQueryMetrics

        public HibernateQueryMetrics​(SessionFactory sessionFactory,
                             java.lang.String sessionFactoryName,
                             java.lang.Iterable<io.micrometer.core.instrument.Tag> tags)
        Create a HibernateQueryMetrics.
        Parameters:
        sessionFactory - session factory to use
        sessionFactoryName - session factory name as a tag value
        tags - additional tags

    • Method Detail

      • monitor

        public static void monitor​(io.micrometer.core.instrument.MeterRegistry registry,
                           SessionFactory sessionFactory,
                           java.lang.String sessionFactoryName,
                           java.lang.String... tags)
        Create HibernateQueryMetrics and bind to the specified meter registry.
        Parameters:
        registry - meter registry to use
        sessionFactory - session factory to use
        sessionFactoryName - session factory name as a tag value
        tags - additional tags

      • monitor

        public static void monitor​(io.micrometer.core.instrument.MeterRegistry registry,
                           SessionFactory sessionFactory,
                           java.lang.String sessionFactoryName,
                           java.lang.Iterable<io.micrometer.core.instrument.Tag> tags)
        Create HibernateQueryMetrics and bind to the specified meter registry.
        Parameters:
        registry - meter registry to use
        sessionFactory - session factory to use
        sessionFactoryName - session factory name as a tag value
        tags - additional tags

      • bindTo

        public void bindTo​(io.micrometer.core.instrument.MeterRegistry meterRegistry)
        Specified by:
        bindTo in interface io.micrometer.core.instrument.binder.MeterBinder