Class ThreadExports

java.lang.Object

io.prometheus.client.Collector

io.prometheus.client.hotspot.ThreadExports

public class ThreadExports
extends Collector

Exports metrics about JVM thread areas.

Example usage:

  new ThreadExports().register();

Example metrics being exported:

  jvm_threads_current{} 300
  jvm_threads_daemon{} 200
  jvm_threads_peak{} 410
  jvm_threads_started_total{} 1200

Nested Class Summary

Nested classes/interfaces inherited from class Collector

Collector.Describable, Collector.MetricFamilySamples, Collector.Type

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	JVM_THREADS_CURRENT
private static final String	JVM_THREADS_DAEMON
private static final String	JVM_THREADS_DEADLOCKED
private static final String	JVM_THREADS_DEADLOCKED_MONITOR
private static final String	JVM_THREADS_PEAK
private static final String	JVM_THREADS_STARTED_TOTAL
static final String	JVM_THREADS_STATE
private final ThreadMXBean	threadBean
static final String	UNKNOWN

Fields inherited from class Collector

MILLISECONDS_PER_SECOND, NANOSECONDS_PER_SECOND

Constructor Summary

Constructors

Constructor	Description
ThreadExports()
ThreadExports(ThreadMXBean threadBean)

Method Summary

Modifier and Type	Method	Description
(package private) void	addThreadMetrics(List<Collector.MetricFamilySamples> sampleFamilies, Predicate<String> nameFilter)
List<Collector.MetricFamilySamples>	collect()	Return all metrics of this Collector.
List<Collector.MetricFamilySamples>	collect(Predicate<String> nameFilter)	Like Collector.collect(), but the result should only contain MetricFamilySamples where sampleNameFilter.test(name) is true for at least one Sample name.
private Map<String,Integer>	getThreadStateCountMap()
private static double	nullSafeArrayLength(long[] array)

Methods inherited from class Collector

checkMetricLabelName, checkMetricName, doubleToGoString, register, register, sanitizeMetricName

Methods inherited from class Object

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

Field Details

UNKNOWN

public static final String UNKNOWN

See Also:

• Constant Field Values

JVM_THREADS_STATE

public static final String JVM_THREADS_STATE

See Also:

• Constant Field Values

JVM_THREADS_CURRENT

private static final String JVM_THREADS_CURRENT

See Also:

• Constant Field Values

JVM_THREADS_DAEMON

private static final String JVM_THREADS_DAEMON

See Also:

• Constant Field Values

JVM_THREADS_PEAK

private static final String JVM_THREADS_PEAK

See Also:

• Constant Field Values

JVM_THREADS_STARTED_TOTAL

private static final String JVM_THREADS_STARTED_TOTAL

See Also:

• Constant Field Values

JVM_THREADS_DEADLOCKED

private static final String JVM_THREADS_DEADLOCKED

See Also:

• Constant Field Values

JVM_THREADS_DEADLOCKED_MONITOR

private static final String JVM_THREADS_DEADLOCKED_MONITOR

See Also:

• Constant Field Values

threadBean

private final ThreadMXBean threadBean

Constructor Details

ThreadExports

public ThreadExports()

ThreadExports

public ThreadExports(ThreadMXBean threadBean)

Method Details

addThreadMetrics

void addThreadMetrics(List<Collector.MetricFamilySamples> sampleFamilies,
 Predicate<String> nameFilter)

getThreadStateCountMap

private Map<String,Integer> getThreadStateCountMap()

nullSafeArrayLength

private static double nullSafeArrayLength(long[] array)

collect

public List<Collector.MetricFamilySamples> collect()

Description copied from class: Collector

Return all metrics of this Collector.

Specified by:

collect in class Collector

collect

public List<Collector.MetricFamilySamples> collect(Predicate<String> nameFilter)

Description copied from class: Collector

Like Collector.collect(), but the result should only contain MetricFamilySamples where sampleNameFilter.test(name) is true for at least one Sample name.

The default implementation first collects all MetricFamilySamples and then discards the ones where sampleNameFilter.test(name) returns false for all names in Collector.MetricFamilySamples.getNames(). To improve performance, collector implementations should override this method to prevent MetricFamilySamples from being collected if they will be discarded anyways. See ThreadExports for an example.

Note that the resulting List may contain MetricFamilySamples where some Sample names return true for sampleNameFilter.test(name) but some Sample names return false. This is ok, because before we produce the output format we will call Collector.MetricFamilySamples.filter(Predicate) to strip all Samples where sampleNameFilter.test(name) returns false.

Overrides:

collect in class Collector

Parameters:

nameFilter - may be null, indicating that all metrics should be collected.