.NET 7应用代码中如何获取指标值？调试时查看计数器当前值

问题描述 #

我创建了如下计数器：

meter = new Meter("MyApp");
subsCounter = meter.CreateUpDownCounter<int>("ObjectsSubscriptions");

希望在调试时打印subsCounter的当前值，该如何实现？

解决方案 #

.NET 中的UpDownCounter本身并未直接提供读取当前值的API，因为它的设计定位是遥测统计组件，而非用于实时数值读取的调试工具。但调试场景下可以通过以下几种方式实现需求：

方式一：自定义可调试的包装类 #

自己封装一个计数器类，内部维护当前数值，同时同步更新UpDownCounter，调试时直接读取封装的数值即可：

public class DebuggableUpDownCounter<T> where T : struct
{
    private readonly UpDownCounter<T> _innerCounter;
    private T _currentValue;

    public DebuggableUpDownCounter(UpDownCounter<T> innerCounter)
    {
        _innerCounter = innerCounter;
        _currentValue = default;
    }

    public void Add(T value)
    {
        _currentValue = (dynamic)_currentValue + (dynamic)value;
        _innerCounter.Add(value);
    }

    public void Decrement(T value = default)
    {
        var decrementValue = value.Equals(default) ? (dynamic)1 : value;
        _currentValue = (dynamic)_currentValue - decrementValue;
        _innerCounter.Decrement(decrementValue);
    }

    public T CurrentValue => _currentValue;
}

使用示例：

var meter = new Meter("MyApp");
var subsCounter = meter.CreateUpDownCounter<int>("ObjectsSubscriptions");
var debugCounter = new DebuggableUpDownCounter<int>(subsCounter);

// 操作计数器
debugCounter.Add(5);
debugCounter.Decrement(2);

// 调试时打印当前值
Console.WriteLine($"当前订阅数：{debugCounter.CurrentValue}");

方式二：通过诊断源监听数值变化 #

利用.NET的诊断机制，订阅计数器的更新事件，实时记录并打印数值：

using System.Diagnostics;
using System.Diagnostics.Metrics;

var meter = new Meter("MyApp");
var subsCounter = meter.CreateUpDownCounter<int>("ObjectsSubscriptions");

// 订阅Metrics诊断事件
DiagnosticListener.AllListeners.Subscribe(listener =>
{
    if (listener.Name == "System.Diagnostics.Metrics")
    {
        listener.Subscribe((key, payload) =>
        {
            if (payload is Metric metric && metric.Name == "ObjectsSubscriptions")
            {
                // 提取第一个数据点的数值（若有多个维度可按需筛选）
                var measurement = metric.GetMeasurementPoints().FirstOrDefault();
                if (measurement.HasValue)
                {
                    Console.WriteLine($"ObjectsSubscriptions 当前值：{measurement.Value}");
                }
            }
        });
    }
});

// 测试计数器更新
subsCounter.Add(3);
subsCounter.Decrement(1);

方式三：使用调试工具查看（无需编码） #

如果只是临时调试，不需要编写额外代码，可以通过Visual Studio的诊断工具（Diagnostic Tools）查看：

• 启动调试后打开诊断工具面板
• 在「Metrics」或「Events」标签下，找到归属为MyApp的ObjectsSubscriptions计数器，即可实时查看其数值变化

内容的提问来源于stack exchange，提问作者Boppity Bop