.NET Core 实时监控工具——DotNetify-Pulse 使用教程

1. 项目介绍

DotNetify-Pulse 是一个开源项目，它为 .NET Core 服务添加了一个端点，用于打开一个可定制的 Web 视图，以实时监控服务的日志活动和资源使用情况。它利用 SignalR 进行服务端到浏览器的数据推送，使用 DotNetify 进行 MVVM + 响应式编程，并通过 DotNetify-Elements 提供的 HTML5 Web 组件来展示数据。

2. 项目快速启动

以下是快速启动 DotNetify-Pulse 的步骤：

首先，在您的 .NET Core 项目中安装 NuGet 包：

dotnet add package DotNetify.Pulse

接着，在 Startup.cs 文件中配置服务和管道：

public void ConfigureServices(IServiceCollection services)
{
    services.AddSignalR();
    services.AddDotNetify();
    services.AddDotNetifyPulse();
}

public void Configure(IApplicationBuilder app)
{
    app.UseWebSockets();
    app.UseDotNetify();
    app.UseDotNetifyPulse();

    // 根据您的 .NET Core 版本，使用以下配置
    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapHub.DotNetifyHub("/dotnetify");
    });
}

构建项目后，在浏览器中打开 <service-base-url>/pulse，您应该能看到监控页面。

如果您计划使用 dotnet publish 发布项目，请将 pulse-ui 文件夹从构建输出复制到您的项目中，并将文件夹内的文件设置为“内容”并“复制如果较新”。

3. 应用案例和最佳实践

定制数据提供者

创建一个实现 IPulseDataProvider 接口的类，为监控视图添加自定义数据。

public class ClockProvider : IPulseDataProvider
{
    public IDisposable Configure(PulseVM pulseVM, out OnPushUpdate onPushUpdate)
    {
        var clockProperty = pulseVM.AddProperty<string>("Clock", DateTime.Now.ToString("hh:mm:ss"));
        onPushUpdate = _ => { };
        
        return Observable.Interval(TimeSpan.FromSeconds(1))
            .Subscribe(_ => clockProperty.OnNext(DateTime.Now.ToString("hh:mm:ss")));
    }
}

在 Startup.cs 的 ConfigureServices 方法中注册这个提供者：

services.TryAddEnumerable(ServiceDescriptor.Singleton<IPulseDataProvider, ClockProvider>());

定制 UI

创建自定义的 HTML 页面，并在其中添加 Web 组件来展示数据。

1. 复制 pulse-ui 文件夹并重命名为 custom-pulse-ui。
2. 将 section_template.html 重命名为 section.html，并设置其“复制到输出目录”属性为“复制如果较新”。
3. 编辑 section.html 文件，加入以下内容：

<d-frame>
    <div class="card" style="width: 200px; font-size: 40px">
        <d-element id="Clock"></d-element>
    </div>
</d-frame>

在 Startup.cs 的 Configure 方法中设置自定义 UI 文件夹的位置：

app.UseDotNetifyPulse(config => config.UIPath = Directory.GetCurrentDirectory() + "\\custom-pulse-ui");

4. 典型生态项目

DotNetify-Pulse 作为 .NET Core 服务的监控工具，可以与以下典型生态项目结合使用：

• SignalR：用于实现实时通信。
• DotNetify：用于构建响应式的客户端 UI。
• DotNetify-Elements：提供 Web 组件以构建复杂的用户界面。

通过上述教程，您应该能够快速上手 DotNetify-Pulse，并根据自己的需求进行定制和扩展。