com.netflix.spectator.controllers.filter

Class PrototypeMeasurementFilter

java.lang.Object

com.netflix.spectator.controllers.filter.PrototypeMeasurementFilter

All Implemented Interfaces:

java.util.function.Predicate<com.netflix.spectator.api.Measurement>

public class PrototypeMeasurementFilter
extends java.lang.Object
implements java.util.function.Predicate<com.netflix.spectator.api.Measurement>

A general filter specified using a prototype "JSON" document. The json document generally follows the structure of the response, however in addition to containing a "metrics" section of what is desired, it also contains an "excludes" section saying what is not desired. Each of the section contains regular expression rather than literals where the regular expressions are matched against the actual names (or values). Thus the excludes section can be used to restrict more general matching expressions. Each measurement is evaluated against all the entries in the filter until one is found that would cause it to be accepted and not excluded.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrototypeMeasurementFilter.IncludeExcludePatterns A collection of Include patterns and Exclude patterns for filtering.
static class	PrototypeMeasurementFilter.MeterFilterPattern Filters a meter.
static class	PrototypeMeasurementFilter.TagFilterPattern Filters based on Spectator Id tag names and/or values.
static class	PrototypeMeasurementFilter.ValueFilterPattern Filters on measurement values.

Constructor Summary

Constructors

Constructor and Description
PrototypeMeasurementFilter(PrototypeMeasurementFilterSpecification specification) Constructor.

Method Summary

Modifier and Type	Method and Description
static PrototypeMeasurementFilter	loadFromPath(java.lang.String path) Factory method building a filter from a specification file.
PrototypeMeasurementFilter.IncludeExcludePatterns	metricToPatterns(java.lang.String metric) Find the IncludeExcludePatterns for filtering a given metric.
boolean	test(com.netflix.spectator.api.Measurement measurement) Implements the MeasurementFilter interface.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

PrototypeMeasurementFilter

public PrototypeMeasurementFilter(PrototypeMeasurementFilterSpecification specification)

Constructor.

Method Detail

test

public boolean test(com.netflix.spectator.api.Measurement measurement)

Implements the MeasurementFilter interface.

Specified by:

test in interface java.util.function.Predicate<com.netflix.spectator.api.Measurement>

metricToPatterns

public PrototypeMeasurementFilter.IncludeExcludePatterns metricToPatterns(java.lang.String metric)

Find the IncludeExcludePatterns for filtering a given metric. The result is the union of all the individual pattern entries where their specified metric name patterns matches the actual metric name.

loadFromPath

public static PrototypeMeasurementFilter loadFromPath(java.lang.String path)
                                               throws java.io.IOException

Factory method building a filter from a specification file.

Throws:

java.io.IOException