io.prometheus.jmx

Class MatchedRule

java.lang.Object

io.prometheus.jmx.MatchedRule

public class MatchedRule
extends Object

MatchedRule is the result of matching a JMX bean against the rules present in the configuration file. As rules are matched using regular expressions, caching helps prevent having to match the same beans to the same list of regular expressions.

Constructor Summary

Constructors

Constructor and Description
MatchedRule(String name, String matchName, io.prometheus.client.Collector.Type type, String help, List<String> labelNames, List<String> labelValues, Double value, double valueFactor)

Method Summary

Modifier and Type	Method and Description
boolean	isMatched()
boolean	isUnmatched()
static MatchedRule	unmatched() A unmatched MatchedRule, used when no rule matching a JMX bean has been found in the configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatchedRule

public MatchedRule(String name,
                   String matchName,
                   io.prometheus.client.Collector.Type type,
                   String help,
                   List<String> labelNames,
                   List<String> labelValues,
                   Double value,
                   double valueFactor)

Method Detail

unmatched

public static MatchedRule unmatched()

A unmatched MatchedRule, used when no rule matching a JMX bean has been found in the configuration. Cached unmatched rules are still a cache hit, that will not produce any metric/value.

Returns:

the invalid rule

isUnmatched

public boolean isUnmatched()

isMatched

public boolean isMatched()