Interface IFilterMetrics

Namespace:App.Metrics.Abstractions.Filtering
Assembly:cs.temp.dll.dll
Syntax
public interface IFilterMetrics

Properties

ReportEnvironment

Gets a value indicating whether [report environment].

Declaration
bool ReportEnvironment { get; }
Property Value
Type Description
System.Boolean

true if [report environment]; otherwise, false.
Remarks

If false when metrics data is retrieved the environment information will not be populated

ReportHealthChecks

Gets a value indicating whether [report health checks].

Declaration
bool ReportHealthChecks { get; }
Property Value
Type Description
System.Boolean

true if [report health checks]; otherwise, false.
Remarks

If false when metrics data is retrieved the health information will not be populated

Methods

IsApdexMatch(ApdexValueSource)

Determines whether the specified apdex is match.

Declaration
bool IsApdexMatch(ApdexValueSource apdex)
Parameters
Type Name Description
ApdexValueSource apdex

The apdex.
Returns
Type Description
System.Boolean

True if the metric type is an apdex, the name matches and tags match

IsContextMatch(String)

Determines whether the specified context is match.

Declaration
bool IsContextMatch(string context)
Parameters
Type Name Description
System.String context

The context.
Returns
Type Description
System.Boolean

true if the context matches

IsCounterMatch(CounterValueSource)

Determines whether the specified counter is match.

Declaration
bool IsCounterMatch(CounterValueSource counter)
Parameters
Type Name Description
CounterValueSource counter

The counter.
Returns
Type Description
System.Boolean

True if the metric type is a counter, the name matches and tags match

IsGaugeMatch(GaugeValueSource)

Determines whether the specified gauge is match.

Declaration
bool IsGaugeMatch(GaugeValueSource gauge)
Parameters
Type Name Description
GaugeValueSource gauge

The gauge.
Returns
Type Description
System.Boolean

True if the metric type is a gauge, the name matches and tags match

IsHistogramMatch(HistogramValueSource)

Determines whether the specified histogram is match.

Declaration
bool IsHistogramMatch(HistogramValueSource histogram)
Parameters
Type Name Description
HistogramValueSource histogram

The histogram.
Returns
Type Description
System.Boolean

True if the metric type is a histogram, the name matches and tags match

IsMeterMatch(MeterValueSource)

Determines whether the specified meter is match.

Declaration
bool IsMeterMatch(MeterValueSource meter)
Parameters
Type Name Description
MeterValueSource meter

The meter.
Returns
Type Description
System.Boolean

True if the metric type is a meter, the name matches and tags match

IsTimerMatch(TimerValueSource)

Determines whether the specified timer is match.

Declaration
bool IsTimerMatch(TimerValueSource timer)
Parameters
Type Name Description
TimerValueSource timer

The timer.
Returns
Type Description
System.Boolean

True if the metric type is a timer, the name matches and tags match

WhereContext(Predicate<String>)

Filters metrics where the specified predicate on the metrics context is true

Declaration
IFilterMetrics WhereContext(Predicate<string> condition)
Parameters
Type Name Description
System.Predicate<System.String> condition

The predicate on the context to filter on.
Returns
Type Description
IFilterMetrics

A filter where the metric context should match

WhereContext(String)

Filters metrics where the specified context matches

Declaration
IFilterMetrics WhereContext(string context)
Parameters
Type Name Description
System.String context

The metrics context to filter on.
Returns
Type Description
IFilterMetrics

A filter where the metric context should match

WhereMetricName(Predicate<String>)

Filters metrics where the specified predicate on the metric name is true

Declaration
IFilterMetrics WhereMetricName(Predicate<string> condition)
Parameters
Type Name Description
System.Predicate<System.String> condition

The predicate on the metric name to filter on.
Returns
Type Description
IFilterMetrics

A filter where the metric name should match

WhereMetricNameStartsWith(String)

Filters metrics where the metric name starts with the specified name

Declaration
IFilterMetrics WhereMetricNameStartsWith(string name)
Parameters
Type Name Description
System.String name

The metrics name to filter on.
Returns
Type Description
IFilterMetrics

A filter where the metric name starts with the specified name

WhereMetricTaggedWithKey(String[])

Filters metrics where the metrics contain the specified tags keys

Declaration
IFilterMetrics WhereMetricTaggedWithKey(params string[] tagKeys)
Parameters
Type Name Description
System.String[] tagKeys

The metrics tag keys to filter on.
Returns
Type Description
IFilterMetrics

A filter where the metric tags keys should match

WhereMetricTaggedWithKeyValue(TagKeyValueFilter)

Filters metrics where the metrics contain the specified tags key/value pair

Declaration
IFilterMetrics WhereMetricTaggedWithKeyValue(TagKeyValueFilter tags)
Parameters
Type Name Description
TagKeyValueFilter tags

The metrics tag key/values to filter on.
Returns
Type Description
IFilterMetrics

A filter where the metric tags key and value should match

WhereType(MetricType[])

Fitlers metrics by matching types

Declaration
IFilterMetrics WhereType(params MetricType[] types)
Parameters
Type Name Description
MetricType[] types

The metric types to filter on.
Returns
Type Description
IFilterMetrics

A filter where metrics types should match

WithEnvironmentInfo(Boolean)

Declaration
IFilterMetrics WithEnvironmentInfo(bool report)
Parameters
Type Name Description
System.Boolean report
Returns
Type Description
IFilterMetrics

WithHealthChecks(Boolean)

Declaration
IFilterMetrics WithHealthChecks(bool report)
Parameters
Type Name Description
System.Boolean report
Returns
Type Description
IFilterMetrics