Orleans 可观察性

指标

指标是一段时间内报告的数字度量值。 你最常使用它们来监视应用程序的运行状况并生成警报。 有关详细信息，请参阅 .NET 中的指标。 Orleans 使用 System.Diagnostics.Metrics API 收集指标。 这些指标将公开给 OpenTelemetry 项目，该项目将其导出到各种监视系统。

若要在不进行任何代码更改的情况下监视应用，请使用 dotnet counters .NET 诊断工具。 要监视特定<ProcessName>的OrleansActivitySource计数器，请使用如下所示的dotnet counters monitor命令：

dotnet counters monitor -n <ProcessName> --counters Microsoft.Orleans

假设你正在运行 Orleans GPS 跟踪器示例应用 ，并使用命令在单独的终端 dotnet counters monitor 中对其进行监视。 以下输出是典型的：

Press p to pause, r to resume, q to quit.
    Status: Running
[Microsoft.Orleans]
    orleans-app-requests-latency-bucket (Count / 1 sec)                    0
        duration=10000ms                                                   0
        duration=1000ms                                                    0
        duration=100ms                                                     0
        duration=10ms                                                      0
        duration=15000ms                                                   0
        duration=1500ms                                                    0
        duration=1ms                                                   2,530
        duration=2000ms                                                    0
        duration=200ms                                                     0
        duration=2ms                                                       0
        duration=400ms                                                     0
        duration=4ms                                                       0
        duration=5000ms                                                    0
        duration=50ms                                                      0
        duration=6ms                                                       0
        duration=800ms                                                     0
        duration=8ms                                                       0
        duration=9223372036854775807ms                                     0
    orleans-app-requests-latency-count (Count / 1 sec)                 2,530
    orleans-app-requests-latency-sum (Count / 1 sec)                       0
    orleans-catalog-activation-working-set                                36
    orleans-catalog-activations                                           38
    orleans-consistent-ring-range-percentage-average                     100
    orleans-consistent-ring-range-percentage-local                       100
    orleans-consistent-ring-size                                           1
    orleans-directory-cache-size                                          27
    orleans-directory-partition-size                                      26
    orleans-directory-ring-local-portion-average-percentage              100
    orleans-directory-ring-local-portion-distance                          0
    orleans-directory-ring-local-portion-percentage                        0
    orleans-directory-ring-size                                        1,295
    orleans-gateway-received (Count / 1 sec)                           1,291
    orleans-gateway-sent (Count / 1 sec)                               2,582
    orleans-messaging-processing-activation-data                           0
    orleans-messaging-processing-dispatcher-forwarded (Count / 1           0
    orleans-messaging-processing-dispatcher-processed (Count / 1       2,543
        Direction=Request,Status=Ok                                    2,582
    orleans-messaging-processing-dispatcher-received (Count / 1        1,271
        Context=Grain,Direction=Request                                1,291
        Context=None,Direction=Request                                 1,291
    orleans-messaging-processing-ima-enqueued (Count / 1 sec)          5,113

有关详细信息，请参阅调查性能计数器 (dotnet-counters)。

Orleans 米

Orleans 使用 System.Diagnostics.Metrics API 收集指标。 Orleans 将每个计量分类为以域为中心的问题，例如网络、消息传送、网关等。以下小节描述了计量 Orleans 的使用。

网络

下表显示了用于监视 Orleans 网络层的网络计量的集合。

消息传送

下表显示了用于监视 Orleans 消息层的消息计量集合。

网关

下表显示了用于监视网关层的 Orleans 网关计量集合。

运行时

下表显示了用于监视运行时层的 Orleans 运行时计量集合。

目录

下表显示了用于监视 Orleans 目录层的目录计量的集合。

目录

下表显示了用于监视 Orleans 目录层的目录计量的集合。

一致的环

下表显示了一组用于监控环状层的一致环形仪表。

看门狗

下表显示了一组用于监测 Orleans 监视层的检测仪表。

客户

下表显示了用于监视客户端层的 Orleans 客户端计量集合。

其他

下表显示了用于监视各种层的杂项计量的集合。

应用请求

下表显示了用于监视 Orleans 应用请求层的应用请求计量的集合。

提醒事项

下表显示了用于监视提醒层的 Orleans 提醒计量集合。

储存

下表显示了用于监视 Orleans 存储层的存储计量集合。

溪流

下表显示了用于监视 Orleans 流层的流计量集合。

交易

下表显示了用于监视 Orleans 事务层的事务计量集合。

普罗 米修斯

可以将各种第三方指标提供程序用于Orleans。 一个常用示例是 Prometheus，可用于使用 OpenTelemetry 从应用中收集指标。

若要将 OpenTelemetry 和 Prometheus 与 Orleans 一起使用，请调用以下 IServiceCollection 扩展方法：

builder.Services.AddOpenTelemetry()
    .WithMetrics(metrics =>
    {
        metrics
            .AddPrometheusExporter()
            .AddMeter("Microsoft.Orleans");
    });

该AddPrometheusExporter方法可确保将PrometheusExporter添加到builder中。 Orleans使用一个Meter，它名叫"Microsoft.Orleans"，来为多个Orleans特定指标创建Counter<T>实例。 使用AddMeter 方法指定要订阅的计量的名称，在本例中使用 "Microsoft.Orleans"。

配置导出程序并生成应用后，在 IEndpointRouteBuilder 上调用 MapPrometheusScrapingEndpoint（app 实例），以将指标暴露给 Prometheus。 例如：

WebApplication app = builder.Build();

app.MapPrometheusScrapingEndpoint();
app.Run();

分布式跟踪

分布式跟踪是一组用于监视和故障排除分布式应用程序的工具和做法。 它是可观测性的关键组成部分，是了解应用行为的关键工具。 Orleans 支持使用 OpenTelemetry 进行分布式跟踪。

无论选择了哪个分布式跟踪导出程序，请调用：

• AddActivityPropagation(ISiloBuilder)：启用该孤立环境的分布式追踪。
• AddActivityPropagation(IClientBuilder)：为客户端启用分布式跟踪。

引用回 Orleans GPS 跟踪器示例应用，可以使用 Zipkin 分布式跟踪系统通过更新 Program.cs来监视应用。 要将 OpenTelemetry 和 Zipkin 与 Orleans 一起使用，请调用以下 IServiceCollection 扩展方法：

builder.Services.AddOpenTelemetry()
    .WithTracing(tracing =>
    {
        // Set a service name
        tracing.SetResourceBuilder(
            ResourceBuilder.CreateDefault()
                .AddService(serviceName: "GPSTracker", serviceVersion: "1.0"));

        tracing.AddSource("Microsoft.Orleans.Runtime");
        tracing.AddSource("Microsoft.Orleans.Application");

        tracing.AddZipkinExporter(zipkin =>
        {
            zipkin.Endpoint = new Uri("http://localhost:9411/api/v2/spans");
        });
    });

Zipkin 跟踪显示在 Jaeger UI 中（Jaeger 是一个使用相同数据格式的 Zipkin 替代方案）：

有关详细信息，请参阅 分布式跟踪。

Orleans 通过 ITelemetryConsumer 接口输出其运行时统计信息和指标。 应用程序可以为其接收器和客户端注册一个或多个遥测使用者，以接收运行时定期发布的统计信息和指标 Orleans 。 这些可以是常用遥测分析解决方案的使用者，也可以是用于任何其他目标和用途的自定义解决方案。 目前，代码库中包含 Orleans 三个遥测使用者。

它们作为单独的 NuGet 包发布：

• Microsoft.Orleans.OrleansTelemetryConsumers.AI：用于发布到 Azure Application Insights。

• Microsoft.Orleans.OrleansTelemetryConsumers.Counters：用于发布到 Windows 性能计数器。 运行时 Orleans 会不断更新其中的许多。 NuGet 包中包含的 Microsoft.Orleans.CounterControlCounterControl.exe 工具有助于注册必要的性能计数器类别。 它必须使用提升的权限运行。 使用任何标准监视工具监视性能计数器。

• Microsoft.Orleans.OrleansTelemetryConsumers.NewRelic：发布到 New Relic。

若要将孤岛和客户端配置为使用遥测使用者，孤岛的配置代码如下所示：

var siloHostBuilder = new HostBuilder()
    .UseOrleans(c =>
    {
        c.AddApplicationInsightsTelemetryConsumer("INSTRUMENTATION_KEY");
    });

客户端配置代码如下所示：

var clientBuilder = new ClientBuilder();
clientBuilder.AddApplicationInsightsTelemetryConsumer("INSTRUMENTATION_KEY");

若要使用自定义的TelemetryConfiguration（例如包含TelemetryProcessors、TelemetrySinks等），silo 配置代码如下所示：

var telemetryConfiguration = TelemetryConfiguration.CreateDefault();
var siloHostBuilder = new HostBuilder()
    .UseOrleans(c =>
    {
        c.AddApplicationInsightsTelemetryConsumer(telemetryConfiguration);
    });

客户端配置代码如下所示：

var clientBuilder = new ClientBuilder();
var telemetryConfiguration = TelemetryConfiguration.CreateDefault();
clientBuilder.AddApplicationInsightsTelemetryConsumer(telemetryConfiguration);