Class ProcessorMetrics

java.lang.Object

io.micrometer.core.instrument.binder.system.ProcessorMetrics

All Implemented Interfaces:

MeterBinder

public class ProcessorMetrics
extends Object
implements MeterBinder

Record metrics related to the CPU, gathered by the JVM.

Supported JVM implementations:

• HotSpot
• J9

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProcessorMetrics.Builder	Builder for ProcessorMetrics.

Constructor Summary

Constructors

Constructor	Description
ProcessorMetrics()
ProcessorMetrics(Iterable<? extends Tag> extraTags, JvmCpuMeterConventions conventions)	Deprecated. use builder() to provide individual conventions
ProcessorMetrics(Iterable<Tag> extraTags)	Uses the default convention with the provided extra tags.

Method Summary

Modifier and Type	Method	Description
void	bindTo(MeterRegistry registry)
static ProcessorMetrics.Builder	builder()	Create a new builder for ProcessorMetrics.

Methods inherited from class Object

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

Constructor Details

ProcessorMetrics

public ProcessorMetrics()

ProcessorMetrics

public ProcessorMetrics(Iterable<Tag> extraTags)

Uses the default convention with the provided extra tags. If a conflict occurs between extra tags and convention tags, the convention tag takes precedence.

Parameters:

extraTags - tags to add to each meter's tags produced by this binder

ProcessorMetrics

@Deprecated
public ProcessorMetrics(Iterable<? extends Tag> extraTags,
 JvmCpuMeterConventions conventions)

Deprecated.

use builder() to provide individual conventions

The supplied extra tags are not combined with the convention. Provide a convention that applies the extra tags if that is the desired outcome. The convention only applies to some meters.

Parameters:

extraTags - extra tags to add to meters not covered by the conventions

conventions - custom conventions for applicable meters

Since:

1.16.0

Method Details

builder

public static ProcessorMetrics.Builder builder()

Create a new builder for ProcessorMetrics.

Returns:

a new builder

Since:

1.18.0

bindTo

public void bindTo(MeterRegistry registry)

Specified by:

bindTo in interface MeterBinder