io.prometheus.client.hotspot.GarbageCollectorExports Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simpleclient_hotspot Show documentation

Collectors of data from Java Hotspot.

There is a newer version: 0.6.0

package io.prometheus.client.hotspot;

import io.prometheus.client.Collector;

import java.lang.management.GarbageCollectorMXBean;
import java.lang.management.ManagementFactory;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.regex.Pattern;

/**
 * Exports metrics about JVM garbage collectors.
 * 
 * Example usage:
 * 
 * {@code
 *   new GarbageCollectorExports().register();
 * }
 * 
 * Example metrics being exported:
 *  *   jvm_gc_collection_seconds_count{gc="PS1"} 200
 *   jvm_gc_collection_seconds_sum{gc="PS1"} 6.7
 * 
 */
public class GarbageCollectorExports extends Collector {
  private final List garbageCollectors;

  public GarbageCollectorExports() {
    this(ManagementFactory.getGarbageCollectorMXBeans());
  }

  GarbageCollectorExports(List garbageCollectors) {
    this.garbageCollectors = garbageCollectors;
  }

  public List collect() {
    ArrayList samples = new ArrayList();
    for (final GarbageCollectorMXBean gc : garbageCollectors) {
      samples.add(
          new MetricFamilySamples.Sample(
              "jvm_gc_collection_seconds_sum",
              Arrays.asList("gc"),
              Arrays.asList(gc.getName()),
              gc.getCollectionTime() / MILLISECONDS_PER_SECOND));
      samples.add(
          new MetricFamilySamples.Sample(
              "jvm_gc_collection_seconds_count",
              Arrays.asList("gc"),
              Arrays.asList(gc.getName()),
              gc.getCollectionCount()));
    }
    List mfs = new ArrayList();
    mfs.add(new MetricFamilySamples(
        "jvm_gc_collection_seconds",
        Type.SUMMARY,
        "Time spent in a given JVM garbage collector in seconds.",
        samples));

    return mfs;
  }
}