Class MetricsRequest

• Defined in File metrics-request.h

Class Documentation

class MetricsRequest

Public Types

typedef std::shared_ptr<MetricsRequest> Ptr

Public Functions

MetricsRequest(uint32_t groupIndex, metrics::IMetricGroup const *group, CollectionRange const *ranges, uint64_t nRanges, bool freqOverrideEnabled = false, float freqOverrideVal = 1.0f)

Note

Ranges must be sorted in increasing order, and non-overlapping; failure to comply will result in undefined behavior

~MetricsRequest()

uint32_t GroupIndex() const

metrics::IMetricGroup const *Group() const

CollectionRange const *CollectionRanges() const

uint64_t CollectionRangeCount() const

uint64_t GetRequestMetricCount() const

metrics::MetricId GetRequestMetric(uint64_t index) const

bool IsFrequencyOverrideEnabled() const

float GetFrequencyOverrideValue() const

void AddRequestMetric(metrics::MetricId metricId, bool insertAtStart = false)

Adds the specified metric to list of metrics associated with the request.

Parameters

• metricId -- [in] Composite metric index to be added to the request.

• insertAtStart -- [in] Boolean that if true will insert the metric index at the start of the list of metrics currently requested. Otherwise, the metric index will be appended to its end.

void MoveRequestMetric(metrics::MetricId metricId, uint64_t currIndex, uint64_t newIndex)