Class MetricsEndpoint

Namespace

Steeltoe.Management.Endpoint.Metrics

Assembly

Steeltoe.Management.EndpointBase.dll

public class MetricsEndpoint : AbstractEndpoint<IMetricsResponse, MetricsRequest>, IEndpoint<IMetricsResponse, MetricsRequest>, IEndpoint

Inheritance

object

AbstractEndpoint

AbstractEndpoint<IMetricsResponse, MetricsRequest>

MetricsEndpoint

Implements

IEndpoint<IMetricsResponse, MetricsRequest>

IEndpoint

Inherited Members

AbstractEndpoint<IMetricsResponse, MetricsRequest>.Invoke(MetricsRequest)

AbstractEndpoint.options

AbstractEndpoint.Id

AbstractEndpoint.Enabled

AbstractEndpoint.Sensitive

AbstractEndpoint.Path

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EndPointExtensions.IsEnabled(IEndpoint, IManagementOptions)

EndPointExtensions.IsExposed(IEndpoint, IManagementOptions)

EndPointExtensions.RequestVerbAndPathMatch(IEndpoint, string, string, IEnumerable<HttpMethod>, IEnumerable<IManagementOptions>, bool)

Constructors

MetricsEndpoint(IMetricsOptions, IStats, ILogger<MetricsEndpoint>)

public MetricsEndpoint(IMetricsOptions options, IStats stats, ILogger<MetricsEndpoint> logger = null)

Parameters

options IMetricsOptions

stats IStats

logger ILogger<MetricsEndpoint>

Properties

Options

public IMetricsOptions Options { get; }

Property Value

IMetricsOptions

Methods

GetAvailableTags(IViewData)

protected List<MetricTag> GetAvailableTags(IViewData viewData)

Parameters

viewData IViewData

Returns

List<MetricTag>

GetAvailableTags(IList<ITagKey>, IDictionary<TagValues, IAggregationData>)

protected List<MetricTag> GetAvailableTags(IList<ITagKey> columns, IDictionary<TagValues, IAggregationData> aggMap)

Parameters

columns IList<ITagKey>

aggMap IDictionary<TagValues, IAggregationData>

Returns

List<MetricTag>

GetMetric(MetricsRequest)

protected MetricsResponse GetMetric(MetricsRequest request)

Parameters

request MetricsRequest

Returns

MetricsResponse

GetMetricMeasurements(IViewData, List<KeyValuePair<string, string>>)

protected List<MetricSample> GetMetricMeasurements(IViewData viewData, List<KeyValuePair<string, string>> tags)

Parameters

viewData IViewData

tags List<KeyValuePair<string, string>>

Returns

List<MetricSample>

GetMetricNames()

protected ISet<string> GetMetricNames()

Returns

ISet<string>

GetMetricSamples(IAggregationData, IViewData)

protected List<MetricSample> GetMetricSamples(IAggregationData agg, IViewData viewData)

Parameters

agg IAggregationData

viewData IViewData

Returns

List<MetricSample>

GetStatistic(IAggregation, IMeasure)

protected MetricStatistic GetStatistic(IAggregation agg, IMeasure measure)

Parameters

agg IAggregation

measure IMeasure

Returns

MetricStatistic

GetTagValuesInColumnOrder(IList<ITagKey>, List<KeyValuePair<string, string>>)

protected List<ITagValue> GetTagValuesInColumnOrder(IList<ITagKey> columns, List<KeyValuePair<string, string>> tags)

Parameters

columns IList<ITagKey>

tags List<KeyValuePair<string, string>>

Returns

List<ITagValue>

Invoke(MetricsRequest)

public override IMetricsResponse Invoke(MetricsRequest request)

Parameters

request MetricsRequest

Returns

IMetricsResponse