AppMetrics简单理解

基本内容

官方文档：https://www.app-metrics.io/

一、配置

App Metrics提供MetricsBuilder进行配置，这些配置项为：

属性	说明
DefaultContextLabel	通过IMetrics接口度量内容被分组记录在“上下文”中，例如一个数据库上下文或程序上下文。度量名称在每一个下下文中应该是唯一的。如果记录度量内容时没有提供一个上下文标签。这个值可以通过DefaultContextLabel配置进行修改, 默认是“Application”。这里建议采用项目的简写名称，保证项目之间不存在冲突即可。
GlobalTags	所有的度量类型都能被标记, 例如当我们记录度量数据的时候，就能标记所有度量的环境为“测试”或“生产”，这样我们就知道数据的来源。
Enabled	允许所有度量记录被启用/禁用, 默认是true。
ReportingEnabled	允许所有已配置的记录器被启用/禁用, 默认是true。

1.1 代码实现

var metrics = new MetricsBuilder()
    .Configuration.Configure(
        options =>
        {
            options.DefaultContextLabel = "MyContext";
            options.GlobalTags.Add("myTagKey", "myTagValue");
            options.Enabled = true;
            options.ReportingEnabled = true;
        })
     ... //其它配置项
    .Build();

二、度量类型

2.1 度量单位

在讲度量定义之前，先了解MeasurementUnit（度量单位），既测量的内容的描述，这个是输出结果的辅助信息。

枚举	说明
Unit.Bits
Unit.Warnings
Unit.Threads
Unit.Results
Unit.Percent
Unit.None
Unit.PetaBytes
Unit.TeraBytes
Unit.GigaBytes
Unit.Requests
Unit.KiloBytes
Unit.Items
Unit.Events
Unit.Errors
Unit.Connections
Unit.MegaBytes
Unit.Commands
Unit.Calls
Unit.Bytes

2.2 度量定义

App Metrics提供默认的度量配置和度量类型。

2.2.1 GaugeOptions（仪表盘）

主要用于直接反应当前的度量情况，例如CPU和内存的使用情况，直观看到当前实际的状况。如：

//定义一个表示当前发生错误次数的度量
public static class MyMetricsRegistry
{
    ... //其它定义
    public static GaugeOptions Errors => new GaugeOptions
    {
        Name = "Errors"
    };
}
//在需要使用的地方进行度量数据的修改，如将错误数量设置为1：
metrics.Measure.Gauge.SetValue(MyMetricsRegistry.Errors, 1);
//如果想区分具体在哪个层面发生的Error，则需要使用Tag。在设置值的同时，给度量打上指定标记
var tags = new MetricTags(“fromt”, “db”);
metrics.Measure.Gauge.SetValue(MyMetricsRegistry.Errors, tags, 1);

2.2.2 CounterOptions（计数器）

对于一些需要观察某些特别数据数量统计的时候，比如api的请求量等，可以通过CounterOptions来实现用途。如：

//定义一个表示当前发生错误次数的度量
public static class MyMetricsRegistry
{
    ... //其它定义
    public static CounterOptions SampleCounter => new CounterOptions
    {
        Name = "Sample Counter",
        MeasurementUnit = Unit.Calls
    };
}
//累加
metrics.Measure.Counter.Increment(MyMetricsRegistry.SampleCounter);

2.2.3 MeterOptions（计量器）

对于一些需要观察某些特别数据增长率的时候，例如每隔一段时间用户的增长率等，可以通过MeterOptions来实现用途。如：

//定义一个表示当前不同状态码发生情况的度量
public static class MyMetricsRegistry
{
    ... //其它定义
    public static MeterOptions SampleMeter => new MeterOptions
    {
        Name = "Sample Meter",
        MeasurementUnit = Unit.Calls
    };
}
//定义不同状态发生的情况
metrics.Measure.Meter.Mark(MyMetricsRegistry.SampleMeter, 1);
metrics.Measure.Meter.Mark(MyMetricsRegistry.SampleMeter, 2;
metrics.Measure.Meter.Mark(MyMetricsRegistry.SampleMeter, 3);

2.2.4 HistogramOptions（柱状图）

主要反应数据的分布情况，例如Post和Put请求的数据尺寸。如：

//定义一个表示当前数据分布情况的度量
public static class MyMetricsRegistry
{
    ... //其它定义
    public static HistogramOptions SampleHistogram => new HistogramOptions
    {
        Name = "Sample Histogram",
        Reservoir = () => new DefaultAlgorithmRReservoir(),
        MeasurementUnit = Unit.MegaBytes
    };
}
//利用随机数模拟数据填充
var rnd = new Random();
foreach (var i in Enumerable.Range(0, 50))
{
    var t = rnd.Next(0, 10);
    metrics.Measure.Histogram.Update(MyMetricsRegistry.SampleHistogram, t);
}

2.2.5 TimerOptions（时间线）

主要以响应时间的情况作为度量进行监控。如：

//定义一个表示当前数据分布情况的度量
public static class MyMetricsRegistry
{
    ... //其它定义
    public static TimerOptions SampleTimer => new TimerOptions
    {
        Name = "Sample Timer",
        MeasurementUnit = Unit.Items,
        DurationUnit = TimeUnit.Milliseconds,
        RateUnit = TimeUnit.Milliseconds,
        Reservoir = () => new DefaultForwardDecayingReservoir(sampleSize: 1028, alpha: 0.015)
    };
}
//使用using进行涵括，并将需要记录耗时的请求操作放入其中
using (metrics.Measure.Timer.Time(MyMetricsRegistry.SampleTimer))
{
    // Do something
}

2.2.6 ApdexOptions（性能度量）

主要以标准的性能度量计算方。如：

//定义一个表示当前数据分布情况的度量
public static class MyMetricsRegistry
{
    ... //其它定义
    public static ApdexOptions SampleApdex => new ApdexOptions
    {
        Name = "Sample Apdex"
    };
}
//使用using进行涵括，并将需要记录耗时的请求操作放入其中
using (metrics.Measure.Apdex.Track(MyMetricsRegistry.SampleApdex))
{
    // Do something
}

三、格式化度量

App Metrics支持格式化为Plain Text（纯文本）和JSON，以及格式化为如：InfluxDB, Prometheus, Elasticsearch 和 Graphite 这类时序数据的储存格式。

3.1 基本

MetricsBuilder可以配置一到多个格式化器，如使用Plain Text 和 Json

安装App.Metrics Nuget包

nuget install App.Metrics

var builder = new MetricsBuilder()
    .OutputMetrics.AsPlainText()
    .OutputMetrics.AsJson();

通过获取快照，将格式化后的内容打印出来

var metrics = builder.Build();
// TODO: Record some metrics
var snapshot = metrics.Snapshot.Get();
foreach(var formatter in metrics.OutputMetricsFormatters)
{
    using (var stream = new MemoryStream())
    {
        await formatter.WriteAsync(stream, snapshot);
        var result = Encoding.UTF8.GetString(stream.ToArray());
        System.Console.WriteLine(result);
    }
}

3.2 自定义格式器

实现自定义格式器

安装App.Metrics.Abstractions Nuget包

nuget install App.Metrics.Abstractions

继承IMetricsOutputFormatter接口，实现自定义格式器

public class CustomOutputFormatter : IMetricsOutputFormatter
{
    public MetricsMediaTypeValue MediaType => new MetricsMediaTypeValue("text", "vnd.custom.metrics", "v1", "plain");

    public Task WriteAsync(Stream output,
        MetricsDataValueSource snapshot,
        CancellationToken cancellationToken = default)
    {
        // TODO: Serialize the snapshot
        return Task.CompletedTask;
    }
}

var metrics = new MetricsBuilder()
    .OutputMetrics.Using()
    // OR
    // .OutputMetrics.Using(new CustomOutputFormatter())
    .Builder();

四、过滤器

4.1 全局过滤器

可以在IMetricsBuilder上使用过滤器，在检索快照时，默认使用该过滤器。

4.1.1 字段过滤

度量类型

var metrics = new MetricsBuilder()
    .MetricFields.Configure(
        fields =>
        {
            fields.Counter.Exclude(CounterFields.Total, CounterFields.SetItem, CounterFields.SetItemPercent);
            fields.Meter.OnlyInclude(MeterFields.Rate1M);
            fields.Histogram.OnlyInclude(HistogramFields.P95, HistogramFields.P99);
        })
    .Build();

未完待续