Package io.micrometer.core.instrument.binder.jpa

Class HibernateQueryMetrics

java.lang.Object
io.micrometer.core.instrument.binder.jpa.HibernateQueryMetrics
All Implemented Interfaces:
MeterBinder
@NonNullApi
@NonNullFields
public class HibernateQueryMetrics
extends java.lang.Object
implements 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.

Since:
1.4.0

  • Constructor Summary

    Constructors
    Constructor Description
    HibernateQueryMetrics​(org.hibernate.SessionFactory sessionFactory, java.lang.String sessionFactoryName, java.lang.Iterable<Tag> tags)
    Create a HibernateQueryMetrics.

  • Method Summary

    Modifier and Type Method Description
    void bindTo​(MeterRegistry meterRegistry)  
    static void monitor​(MeterRegistry registry, org.hibernate.SessionFactory sessionFactory, java.lang.String sessionFactoryName, java.lang.Iterable<Tag> tags)
    Create HibernateQueryMetrics and bind to the specified meter registry.
    static void monitor​(MeterRegistry registry, org.hibernate.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 Details

    • HibernateQueryMetrics

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

  • Method Details

    • monitor

      public static void monitor​(MeterRegistry registry, org.hibernate.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​(MeterRegistry registry, org.hibernate.SessionFactory sessionFactory, java.lang.String sessionFactoryName, java.lang.Iterable<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​(MeterRegistry meterRegistry)
      Specified by:
      bindTo in interface MeterBinder