Class GarbageCollectorExports
Example usage:
new GarbageCollectorExports().register();
Example metrics being exported:
jvm_gc_collection_seconds_count{gc="PS1"} 200 jvm_gc_collection_seconds_sum{gc="PS1"} 6.7
-
Nested Class Summary
Nested classes/interfaces inherited from class io.prometheus.client.Collector
Collector.Describable, Collector.MetricFamilySamples, Collector.Type
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final List
<GarbageCollectorMXBean> private static final String
Fields inherited from class io.prometheus.client.Collector
MILLISECONDS_PER_SECOND, NANOSECONDS_PER_SECOND
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncollect()
Return all metrics of this Collector.LikeCollector.collect()
, but the result should only containMetricFamilySamples
wheresampleNameFilter.test(name)
istrue
for at least one Sample name.Methods inherited from class io.prometheus.client.Collector
checkMetricLabelName, checkMetricName, doubleToGoString, register, register, sanitizeMetricName
-
Field Details
-
JVM_GC_COLLECTION_SECONDS
- See Also:
-
garbageCollectors
-
-
Constructor Details
-
GarbageCollectorExports
public GarbageCollectorExports() -
GarbageCollectorExports
GarbageCollectorExports(List<GarbageCollectorMXBean> garbageCollectors)
-
-
Method Details
-
collect
Description copied from class:Collector
Return all metrics of this Collector. -
collect
Description copied from class:Collector
LikeCollector.collect()
, but the result should only containMetricFamilySamples
wheresampleNameFilter.test(name)
istrue
for at least one Sample name.The default implementation first collects all
MetricFamilySamples
and then discards the ones wheresampleNameFilter.test(name)
returnsfalse
for all names inCollector.MetricFamilySamples.getNames()
. To improve performance, collector implementations should override this method to preventMetricFamilySamples
from being collected if they will be discarded anyways. SeeThreadExports
for an example.Note that the resulting List may contain
MetricFamilySamples
where some Sample names returntrue
forsampleNameFilter.test(name)
but some Sample names returnfalse
. This is ok, because before we produce the output format we will callCollector.MetricFamilySamples.filter(Predicate)
to strip all Samples wheresampleNameFilter.test(name)
returnsfalse
.
-