com.github.marschall.hikari.jfr.JFRMetricsTracker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hikari-jfr Show documentation
A HikariCP MetricsTrackerFactory that generates JFR events.
The newest version!
package com.github.marschall.hikari.jfr;

import jdk.jfr.Timespan;

import com.zaxxer.hikari.metrics.IMetricsTracker;

import jdk.jfr.Category;
import jdk.jfr.Description;
import jdk.jfr.Event;
import jdk.jfr.Label;
import static jdk.jfr.Timespan.MILLISECONDS;
import static jdk.jfr.Timespan.NANOSECONDS;

/**
 * A {@link IMetricsTracker} that generates JFR events.
 * 
 * Events
 * The following events are supported
 * 
 * 
 * 
 * Connection Created
 * A physical connection was created. It has the following attributes
 * 
 * Pool Name
 * The name of the connection pool
 * Creation Time
 * The time it took to create a physical connection
 * 
 * 
 * 
 * Connection Acquired
 * A connection was acquired from the pool. It has the following attributes
 * 
 * Pool Name
 * The name of the connection pool
 * Acquisition Time
 * The time it took to acquire a connection from the pool
 * 
 * 
 * 
 * Connection Borrowed
 * A connection was borrowed from the pool. It has the following attributes
 * 
 * Pool Name
 * The name of the connection pool
 * Borrowed Time
 * The time the connection was borrowed from the pool
 * 
 * 
 * 
 * Connection Timeout
 * A could not be acquired in the request time from the pool. It has the following attributes
 * 
 * Pool Name
 * The name of the connection pool
 * 
 * 
 * 
 * 
 */
final class JFRMetricsTracker implements IMetricsTracker {

  private static final String CATEGORY = "HikariCP";

  private String poolName;

  JFRMetricsTracker(String poolName) {
    this.poolName = poolName;
  }

  @Override
  public void recordConnectionCreatedMillis(long connectionCreatedMillis) {
    ConnectionCreatedEvent event = new ConnectionCreatedEvent();
    event.setPoolName(this.poolName);
    event.setCreationTime(connectionCreatedMillis);
    event.commit();
  }

  @Override
  public void recordConnectionAcquiredNanos(long elapsedAcquiredNanos) {
    ConnectionAcquiredEvent event = new ConnectionAcquiredEvent();
    event.setPoolName(this.poolName);
    event.setAcquisitionTime(elapsedAcquiredNanos);
    event.commit();
  }

  @Override
  public void recordConnectionUsageMillis(long elapsedBorrowedMillis) {
    ConnectionBorrowedEvent event = new ConnectionBorrowedEvent();
    event.setPoolName(this.poolName);
    event.setBorrowedTime(elapsedBorrowedMillis);
    event.commit();
  }

  @Override
  public void recordConnectionTimeout() {
    ConnectionTimeoutEvent event = new ConnectionTimeoutEvent();
    event.setPoolName(this.poolName);
    event.commit();
  }

  @Label("Connection Created")
  @Description("A physical connection was created")
  @Category(CATEGORY)
  static final class ConnectionCreatedEvent extends Event {

    @Label("Pool Name")
    @Description("The name of the connection pool")
    private String poolName;

    @Label("Creation Time")
    @Description("The time it took to create a physical connection")
    @Timespan(MILLISECONDS)
    private long creationTime;

    void setPoolName(String poolName) {
      this.poolName = poolName;
    }

    void setCreationTime(long creationTime) {
      this.creationTime = creationTime;
    }

  }

  @Label("Connection Acquired")
  @Description("A connection was acquired from the pool")
  @Category(CATEGORY)
  static final class ConnectionAcquiredEvent extends Event {

    @Label("Pool Name")
    @Description("The name of the pool the connection was acquired from")
    private String poolName;

    @Label("Acquisition Time")
    @Description("The time it took to acquire a connection from the pool")
    @Timespan(NANOSECONDS)
    private long acquisitionTime;

    void setPoolName(String poolName) {
      this.poolName = poolName;
    }

    void setAcquisitionTime(long creationTime) {
      this.acquisitionTime = creationTime;
    }

  }

  @Label("Connection Borrowed")
  @Description("A connection was borrowed from the pool")
  @Category(CATEGORY)
  static final class ConnectionBorrowedEvent extends Event {

    @Label("Pool Name")
    @Description("The name of the pool the connection was borrowed from")
    private String poolName;

    @Label("Borrowed Time")
    @Description("The time the connection was borrowed from the pool")
    @Timespan(MILLISECONDS)
    private long borrowedTime;

    void setPoolName(String poolName) {
      this.poolName = poolName;
    }

    void setBorrowedTime(long creationTime) {
      this.borrowedTime = creationTime;
    }

  }

  @Label("Connection Timeout")
  @Description("A could not be acquired in the request time from the pool")
  @Category(CATEGORY)
  static final class ConnectionTimeoutEvent extends Event {

    @Label("Pool Name")
    @Description("The name of the pool the connection was requested from")
    private String poolName;

    void setPoolName(String poolName) {
      this.poolName = poolName;
    }

  }

}