com.netflix.spectator.atlas

Interface RollupPolicy

All Superinterfaces:

Function<List<com.netflix.spectator.api.Measurement>,List<RollupPolicy.Result>>

public interface RollupPolicy
extends Function<List<com.netflix.spectator.api.Measurement>,List<RollupPolicy.Result>>

Policy for performing a rollup on a set of measurements. This typically involves removing some dimensions from the ids and combining the results into an aggregate measurement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RollupPolicy.Result Result of applying the rollup policy.
static class	RollupPolicy.Rule Rule for matching a set of measurements and removing specified dimensions.

Method Summary

Modifier and Type	Method and Description
static RollupPolicy	fromIdMapper(Map<String,String> commonTags, Function<com.netflix.spectator.api.Id,com.netflix.spectator.api.Id> idMapper) Create a new policy that will aggregate ids based on the statistic tag.
static RollupPolicy	fromRules(Map<String,String> commonTags, List<RollupPolicy.Rule> rules) Create a new policy based on a list of rules.
static RollupPolicy	noop(Map<String,String> commonTags) Does nothing, returns the input list without modification.

Methods inherited from interface java.util.function.Function

andThen, apply, compose, identity

Method Detail

noop

static RollupPolicy noop(Map<String,String> commonTags)

Does nothing, returns the input list without modification.

fromIdMapper

static RollupPolicy fromIdMapper(Map<String,String> commonTags,
                                 Function<com.netflix.spectator.api.Id,com.netflix.spectator.api.Id> idMapper)

Create a new policy that will aggregate ids based on the statistic tag. Counter types will use a sum aggregation and gauges will use max.

Parameters:

commonTags - Common tags that are applied to all measurements.

idMapper - Map an id to a new identifier that will be used for the resulting aggregate measurement.

Returns:

A rollup policy that will apply the mapping function to the ids of input measurements and aggregate the results.

fromRules

static RollupPolicy fromRules(Map<String,String> commonTags,
                              List<RollupPolicy.Rule> rules)

Create a new policy based on a list of rules. A rule consists of an Atlas query expression and a set of dimensions that should be removed for matching measurements.

Parameters:

commonTags - Set of common tags that are applied to all measurements.

rules - List of rules for specifying what dimensions should be removed.

Returns:

A rollup policy that will apply the rules on the input measurements and aggregate the results.