Package io.javaoperatorsdk.operator.monitoring.micrometer

Class MicrometerMetrics

java.lang.Object

io.javaoperatorsdk.operator.monitoring.micrometer.MicrometerMetrics

All Implemented Interfaces:

Metrics

public class MicrometerMetrics
extends Object
implements Metrics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MicrometerMetrics.MicrometerMetricsBuilder
static class	MicrometerMetrics.PerResourceCollectingMicrometerMetricsBuilder

Nested classes/interfaces inherited from interface io.javaoperatorsdk.operator.api.monitoring.Metrics

Metrics.ControllerExecution<T extends Object>

Field Summary

Fields inherited from interface io.javaoperatorsdk.operator.api.monitoring.Metrics

NOOP

Constructor Summary

Constructors

Constructor	Description
MicrometerMetrics(io.micrometer.core.instrument.MeterRegistry registry)	Deprecated. Use the factory methods / builders instead

Method Summary

Modifier and Type	Method	Description
void	cleanupDoneFor(ResourceID resourceID, Map<String,Object> metadata)
void	controllerRegistered(Controller<? extends io.fabric8.kubernetes.api.model.HasMetadata> controller)
void	failedReconciliation(io.fabric8.kubernetes.api.model.HasMetadata resource, Exception exception, Map<String,Object> metadata)
void	finishedReconciliation(io.fabric8.kubernetes.api.model.HasMetadata resource, Map<String,Object> metadata)
<T extends Map<?,?>> T	monitorSizeOf(T map, String name)
static MicrometerMetrics.MicrometerMetricsBuilder	newMicrometerMetricsBuilder(io.micrometer.core.instrument.MeterRegistry registry)	Creates a new builder to configure how the eventual MicrometerMetrics instance will behave.
static MicrometerMetrics.PerResourceCollectingMicrometerMetricsBuilder	newPerResourceCollectingMicrometerMetricsBuilder(io.micrometer.core.instrument.MeterRegistry registry)	Creates a new builder to configure how the eventual MicrometerMetrics instance will behave, pre-configuring it to collect metrics per resource.
void	receivedEvent(Event event, Map<String,Object> metadata)
void	reconcileCustomResource(io.fabric8.kubernetes.api.model.HasMetadata resource, RetryInfo retryInfoNullable, Map<String,Object> metadata)
void	reconciliationExecutionFinished(io.fabric8.kubernetes.api.model.HasMetadata resource, Map<String,Object> metadata)
void	reconciliationExecutionStarted(io.fabric8.kubernetes.api.model.HasMetadata resource, Map<String,Object> metadata)
protected Set<io.micrometer.core.instrument.Meter.Id>	recordedMeterIdsFor(ResourceID resourceID)
<T> T	timeControllerExecution(Metrics.ControllerExecution<T> execution)
static MicrometerMetrics	withoutPerResourceMetrics(io.micrometer.core.instrument.MeterRegistry registry)	Creates a MicrometerMetrics instance configured to not collect per-resource metrics, just aggregates per resource **type**

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.javaoperatorsdk.operator.api.monitoring.Metrics

cleanupDoneFor, failedReconciliation, finishedReconciliation, finishedReconciliation, reconcileCustomResource

Constructor Detail

MicrometerMetrics

@Deprecated
public MicrometerMetrics(io.micrometer.core.instrument.MeterRegistry registry)

Deprecated.

Use the factory methods / builders instead

Creates a default micrometer-based Metrics implementation, collecting metrics on a per resource basis and not dealing with cleaning these after these resources are deleted. Note that this probably will change in a future release. If you want more control over what the implementation actually does, please use the static factory methods instead.

Parameters:

registry - the MeterRegistry instance to use for metrics recording

Method Detail

withoutPerResourceMetrics

public static MicrometerMetrics withoutPerResourceMetrics(io.micrometer.core.instrument.MeterRegistry registry)

Creates a MicrometerMetrics instance configured to not collect per-resource metrics, just aggregates per resource **type**

Parameters:

registry - the MeterRegistry instance to use for metrics recording

Returns:

a MicrometerMetrics instance configured to not collect per-resource metrics

newMicrometerMetricsBuilder

public static MicrometerMetrics.MicrometerMetricsBuilder newMicrometerMetricsBuilder(io.micrometer.core.instrument.MeterRegistry registry)

Creates a new builder to configure how the eventual MicrometerMetrics instance will behave.

Parameters:

registry - the MeterRegistry instance to use for metrics recording

Returns:

a MicrometerMetrics instance configured to not collect per-resource metrics

See Also:

MicrometerMetrics.MicrometerMetricsBuilder

newPerResourceCollectingMicrometerMetricsBuilder

public static MicrometerMetrics.PerResourceCollectingMicrometerMetricsBuilder newPerResourceCollectingMicrometerMetricsBuilder(io.micrometer.core.instrument.MeterRegistry registry)

Creates a new builder to configure how the eventual MicrometerMetrics instance will behave, pre-configuring it to collect metrics per resource.

Parameters:

registry - the MeterRegistry instance to use for metrics recording

Returns:

a MicrometerMetrics instance configured to not collect per-resource metrics

See Also:

MicrometerMetrics.PerResourceCollectingMicrometerMetricsBuilder

controllerRegistered

public void controllerRegistered(Controller<? extends io.fabric8.kubernetes.api.model.HasMetadata> controller)

Specified by:

controllerRegistered in interface Metrics

timeControllerExecution

public <T> T timeControllerExecution(Metrics.ControllerExecution<T> execution)

Specified by:

timeControllerExecution in interface Metrics

receivedEvent

public void receivedEvent(Event event,
                          Map<String,Object> metadata)

Specified by:

receivedEvent in interface Metrics

cleanupDoneFor

public void cleanupDoneFor(ResourceID resourceID,
                           Map<String,Object> metadata)

Specified by:

cleanupDoneFor in interface Metrics

reconcileCustomResource

public void reconcileCustomResource(io.fabric8.kubernetes.api.model.HasMetadata resource,
                                    RetryInfo retryInfoNullable,
                                    Map<String,Object> metadata)

Specified by:

reconcileCustomResource in interface Metrics

finishedReconciliation

public void finishedReconciliation(io.fabric8.kubernetes.api.model.HasMetadata resource,
                                   Map<String,Object> metadata)

Specified by:

finishedReconciliation in interface Metrics

reconciliationExecutionStarted

public void reconciliationExecutionStarted(io.fabric8.kubernetes.api.model.HasMetadata resource,
                                           Map<String,Object> metadata)

Specified by:

reconciliationExecutionStarted in interface Metrics

reconciliationExecutionFinished

public void reconciliationExecutionFinished(io.fabric8.kubernetes.api.model.HasMetadata resource,
                                            Map<String,Object> metadata)

Specified by:

reconciliationExecutionFinished in interface Metrics

failedReconciliation

public void failedReconciliation(io.fabric8.kubernetes.api.model.HasMetadata resource,
                                 Exception exception,
                                 Map<String,Object> metadata)

Specified by:

failedReconciliation in interface Metrics

monitorSizeOf

public <T extends Map<?,?>> T monitorSizeOf(T map,
                                                  String name)

Specified by:

monitorSizeOf in interface Metrics

recordedMeterIdsFor

protected Set<io.micrometer.core.instrument.Meter.Id> recordedMeterIdsFor(ResourceID resourceID)