Support for persisting in-memory 128T metrics allows you historical access to longer term system measurements. The feature also provides greater control over which combinations of those in-memory metrics should be persisted and for how long.
To use In-Memory Metrics, specify the metrics intended for persistence as part of a Metrics Profile. Profiles are configured at the Authority level and referenced by the relevant routers. Each Profile specifies a number of metrics and the desired parameter filters.
An individual metric indicates one 128T metric to be part of the profile. Each profile must contain at least one metric to be valid. The metric’s ID matches the description in the REST API/Swagger documentation for the statistic.
Filters are optional, but are important in their ability to limit the resources consumed by the metrics subsystem. Filters allow you to indicate your interest in a particular interface or peer-path without the necessity to persist all of the instances of the metric. If no filters are indicated, all instances are persisted.
When using filters, the parameters and values must be relevant for all metrics in the profile. If one of the metrics does not have the specified parameter, or has none of the values, that metric will produce no data.
Example of Simple Grouping with Filtering:
When the above profile is referenced by a router, the various reachability metrics are persisted but only for the
internet service and
best-effort traffic-class. These metrics are available as time-series from the GraphQL API or in the GUI.
Once a profile is configured on the Authority, it is availble to the routers, and each router may reference any number of relevant profiles. With each reference to a profile, the router configuration must specify the retention for the profile. The Profile Retention value determines how long the profile’s metrics are retained.
Profile Retention can be configured as any of four values: in-memory, short, intermediate, and long.
Metrics cascade from one retention value to the next; the use of any one value implies all values before it are also in effect. For example, using intermediate implies that short is also used.
Retention values are not configurable. The list below indicates the configuration order.
The current implementation of the
in-memory retention value is limited.
Example Profile: Native Output
The following example configuration takes metrics specified in the
internet-reachability-metrics profile and stores them through the intermediate retention time period.
In-Memory Metrics Sample Configuration
The following example provides a sample configuration that makes use of several aspects of the Metrics Profile feature.
- Multiple metrics in the same profile
- Filtered profile (peer-metrics)
- Unfiltered profile (events)
- Multiple profiles for the same router (MyRouter)
- Different retention targets for different profiles (MyRouter)