ai.foremast.metrics.k8s.starter

Class CommonMetricsFilter

java.lang.Object

ai.foremast.metrics.k8s.starter.CommonMetricsFilter

All Implemented Interfaces:

io.micrometer.core.instrument.config.MeterFilter

public class CommonMetricsFilter
extends Object
implements io.micrometer.core.instrument.config.MeterFilter

Common Metrics Filter is to hide the metrics by default, and show the metrics what are in the whitelist. If the metric is enabled in properties, keep it enabled. If the metric is disabled in properties, keep it disabled. If the metric starts with "PREFIX", enable it. otherwise disable the metric

Version:

1.0

Author:

Sheldon Shao

Constructor Summary

Constructors

Constructor and Description
CommonMetricsFilter(K8sMetricsProperties k8sMetricsProperties, org.springframework.boot.actuate.autoconfigure.metrics.MetricsProperties properties)

Method Summary

Modifier and Type	Method and Description
io.micrometer.core.instrument.config.MeterFilterReply	accept(io.micrometer.core.instrument.Meter.Id id) Filter for "[PREFIX]_*"
void	disableMetric(String metricName)
void	enableMetric(String metricName)
protected String	filter(String metricName)
String[]	getPrefixes()
void	setPrefixes(String[] prefixes)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micrometer.core.instrument.config.MeterFilter

accept, accept, commonTags, configure, deny, deny, denyNameStartsWith, denyUnless, ignoreTags, map, maxExpected, maxExpected, maximumAllowableMetrics, maximumAllowableTags, minExpected, minExpected, renameTag, replaceTagValues

Constructor Detail

CommonMetricsFilter

public CommonMetricsFilter(K8sMetricsProperties k8sMetricsProperties,
                           org.springframework.boot.actuate.autoconfigure.metrics.MetricsProperties properties)

Method Detail

accept

public io.micrometer.core.instrument.config.MeterFilterReply accept(io.micrometer.core.instrument.Meter.Id id)

Filter for "[PREFIX]_*"

Specified by:

accept in interface io.micrometer.core.instrument.config.MeterFilter

Parameters:

id -

Returns:

MeterFilterReply

filter

protected String filter(String metricName)

enableMetric

public void enableMetric(String metricName)

disableMetric

public void disableMetric(String metricName)

getPrefixes

public String[] getPrefixes()

setPrefixes

public void setPrefixes(String[] prefixes)