Ведение журнала и диагностика в ASP.NET CoreSignalR

Эндрю Стэнтон-Медсестра

В этой статье приводятся рекомендации по сбору диагностика из приложения ASP.NET Core SignalR для устранения неполадок.

Ведение журнала на стороне сервера

Так как SignalR он входит в состав ASP.NET Core, он использует систему ведения журнала ASP.NET Core. В конфигурации SignalR по умолчанию журналы записывают минимальные сведения, но можно настроить уровень ведения журнала. Подробные сведения о настройке ведения журналов в ASP.NET Core см. в документации по ведению журналов в ASP.NET Core.

SignalR использует две категории средства ведения журнала:

• Microsoft.AspNetCore.SignalR: для журналов, связанных с протоколами Концентраторов, активацией центров, вызовом методов и другими действиями, связанными с Концентратором.
• Microsoft.AspNetCore.Http.Connections: для журналов, связанных с транспортами, такими как WebSockets, Long Polling, Server-Sent Events и низкоуровневая SignalR инфраструктура.

Чтобы включить подробные журналы, настройте оба предыдущих префикса SignalRна Debug уровень в appsettings.json файле, добавив следующие элементы LogLevel в подраздел в Logging:

{
    "Logging": {
        "LogLevel": {
            "Default": "Debug",
            "System": "Information",
            "Microsoft": "Information",
            "Microsoft.AspNetCore.SignalR": "Debug",
            "Microsoft.AspNetCore.Http.Connections": "Debug"
        }
    }
}

Уровни ведения журнала для SignalR категорий средства ведения журнала также можно настроить в коде в методе CreateWebHostBuilder :

public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
    WebHost.CreateDefaultBuilder(args)
        .ConfigureLogging(logging =>
        {
            logging.AddFilter("Microsoft.AspNetCore.SignalR", LogLevel.Debug);
            logging.AddFilter("Microsoft.AspNetCore.Http.Connections", LogLevel.Debug);
        })
        .UseStartup<Startup>();

Если вы не используете конфигурацию на основе JSON, задайте следующие значения конфигурации в вашей системе конфигурации:

• Logging:LogLevel:Microsoft.AspNetCore.SignalR = Debug
• Logging:LogLevel:Microsoft.AspNetCore.Http.Connections = Debug

Сведения о задании вложенных значений конфигурации см. в документации по своей системе конфигурации. Так, при использовании переменных среды вместо символа _ применяются два символа : (например, Logging__LogLevel__Microsoft.AspNetCore.SignalR).

При сборе подробных диагностических данных для приложения мы рекомендуем использовать уровень Debug. Уровень Trace создает низкоуровневую диагностику и редко требуется для диагностики проблем в приложении.

Доступ к журналам на стороне сервера

Доступ к журналам на стороне сервера зависит от среды, в которой работает приложение.

Как консольное приложение за пределами IIS

В консольном приложении по умолчанию должно быть включено средство ведения журнала консоли. SignalR журналы отображаются в консоли.

В IIS Express из Visual Studio

Visual Studio отображает выходные данные журнала в окне вывода . Выберите параметр раскрывающегося списка ASP.NET основной веб-сервер.

Служба приложений Azure

Включите параметр ведения журнала приложений (файловая система) в разделе журналов диагностики на портале службы приложение Azure и настройте уровень на Verbose. Журналы должны быть доступны из службы потоковой передачи журналов и в журналах файловой системы Служба приложений. Дополнительные сведения см. в статье "Потоковая передача журналов Azure".

Другие среды

Дополнительные сведения о настройке поставщиков ведения журналов, подходящих для различных сред развертывания, таких как Docker, Kubernetes или служба Windows, см. в разделе "Ведение журнала" в .NET и ASP.NET Core.

Ведение журнала клиента JavaScript

При использовании клиента JavaScript можно настроить параметры ведения журнала с помощью configureLogging метода в HubConnectionBuilder:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/my/hub/url")
    .configureLogging(signalR.LogLevel.Debug)
    .build();

Отключите ведение журнала платформы, указав signalR.LogLevel.None в методе configureLogging . Обратите внимание, что некоторые журналы создаются непосредственно браузером и не могут быть отключены с помощью настройки уровня журнала.

В следующей таблице показаны уровни журналов, доступные клиенту JavaScript. Установка уровня журнала на один из этих значений включает ведение журнала на этом уровне и все уровни над ней в таблице.

После настройки детализации журналы будут записаны в консоль браузера (или стандартные выходные данные в приложении NodeJS).

Если вы хотите отправить журналы в настраиваемую систему ведения журнала, можно предоставить объект JavaScript, реализующий ILogger интерфейс. Единственным методом, который необходимо реализовать, является logто, что принимает уровень события и сообщение, связанное с событием. Рассмотрим пример.

import { ILogger, LogLevel, HubConnectionBuilder } from "@microsoft/signalr";

export class MyLogger implements ILogger {
    log(logLevel: LogLevel, message: string) {
        // Use `message` and `logLevel` to record the log message to your own system
    }
}

// later on, when configuring your connection...

let connection = new HubConnectionBuilder()
    .withUrl("/my/hub/url")
    .configureLogging(new MyLogger())
    .build();

import { ILogger, LogLevel, HubConnectionBuilder } from "@aspnet/signalr";

export class MyLogger implements ILogger {
    log(logLevel: LogLevel, message: string) {
        // Use `message` and `logLevel` to record the log message to your own system
    }
}

// later on, when configuring your connection...

let connection = new HubConnectionBuilder()
    .withUrl("/my/hub/url")
    .configureLogging(new MyLogger())
    .build();

Ведение журнала клиента .NET

Чтобы получить журналы из клиента .NET, можно использовать ConfigureLogging метод HubConnectionBuilderв . Это работает так же, как ConfigureLogging метод в WebHostBuilder и HostBuilder. Вы можете настроить те же поставщики ведения журналов, которые используются в ASP.NET Core. Однако необходимо вручную установить и включить пакеты NuGet для отдельных поставщиков ведения журнала.

Сведения о добавлении Blazor WebAssembly ведения журнала клиентов .NET в приложение см. в разделе Blazor Core.

Логирование консоли

Чтобы включить ведение журнала консоли, добавьте пакет Microsoft.Extensions.Logging.Console . Затем используйте AddConsole метод для настройки средства ведения журнала консоли:

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/my/hub/url")
    .ConfigureLogging(logging =>
    {
        // Log to the Console
        logging.AddConsole();

        // This will set ALL logging to Debug level
        logging.SetMinimumLevel(LogLevel.Debug);
    })
    .Build();

Ведение журнала выходных данных отладки

Журналы можно настроить для перехода в окно вывода в Visual Studio. Установите пакет Microsoft.Extensions.Logging.Debug и используйте AddDebug этот метод:

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/my/hub/url")
    .ConfigureLogging(logging =>
    {
        // Log to the Output Window
        logging.AddDebug();

        // This will set ALL logging to Debug level
        logging.SetMinimumLevel(LogLevel.Debug)
    })
    .Build();

Другие поставщики ведения журнала

SignalR поддерживает другие поставщики ведения журналов, такие как Serilog, Seq, NLog или любая другая система ведения журнала, которая интегрируется с Microsoft.Extensions.Logging. Если система ведения журнала предоставляет эту ILoggerProviderсистему, ее можно зарегистрировать с помощью AddProvider:

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/my/hub/url")
    .ConfigureLogging(logging =>
    {
        // Log to your custom provider
        logging.AddProvider(new MyCustomLoggingProvider());

        // This will set ALL logging to Debug level
        logging.SetMinimumLevel(LogLevel.Debug)
    })
    .Build();

Управление уровнем детализации

При ведении журнала из других мест приложения изменение уровня Debug по умолчанию может быть слишком подробным. Фильтр можно использовать для настройки уровня ведения журнала для SignalR журналов. Это можно сделать в коде так же, как на сервере:

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/my/hub/url")
    .ConfigureLogging(logging =>
    {
        // Register your providers

        // Set the default log level to Information, but to Debug for SignalR-related loggers.
        logging.SetMinimumLevel(LogLevel.Information);
        logging.AddFilter("Microsoft.AspNetCore.SignalR", LogLevel.Debug);
        logging.AddFilter("Microsoft.AspNetCore.Http.Connections", LogLevel.Debug);
    })
    .Build();

Трассировка в SignalR

SignalR узловой сервер и SignalR клиент предоставляют сведения о SignalR подключениях и сообщениях с помощью DiagnosticSource и Activity. SignalR Имеет ActivitySource для центрального сервера и клиента, доступный начиная с .NET 9.

ActivitySource — это компонент, используемый в распределенной трассировке для создания действий (или диапазонов), представляющих операции в приложении. Эти действия можно использовать для следующих действий:

• Отслеживайте поток запросов и операций между различными компонентами и службами.
• Укажите ценные сведения о производительности и поведении приложения.

.NET SignalR сервер ActivitySource

SignalR ActivitySource с именем Microsoft.AspNetCore.SignalR.Server выпускает события для вызовов методов хаба:

• Каждый метод является собственной активностью, поэтому все, что выдает активность во время вызова метода концентратора, находится в рамках активности метода концентратора.
• Действия метода Hub не имеют родительского элемента. Это означает, что они не объединяются в длительное SignalR соединение.

В следующем примере используются Aspire панели мониторинга и пакеты OpenTelemetry :

<PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.9.0" />

Добавьте следующий код запуска в Program.cs файл:

using OpenTelemetry.Trace;
using SignalRChat.Hubs;

// Set OTEL_EXPORTER_OTLP_ENDPOINT environment variable depending on where your OTEL endpoint is.
var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();
builder.Services.AddSignalR();

builder.Services.AddOpenTelemetry()
    .WithTracing(tracing =>
    {
        if (builder.Environment.IsDevelopment())
        {
            // View all traces only in development environment.
            tracing.SetSampler(new AlwaysOnSampler());
        }

        tracing.AddAspNetCoreInstrumentation();
        tracing.AddSource("Microsoft.AspNetCore.SignalR.Server");
    });

builder.Services.ConfigureOpenTelemetryTracerProvider(tracing => tracing.AddOtlpExporter());

var app = builder.Build();

Следующий пример выходных данных взят с панели мониторинга Aspire.

SignalR Hub method call events

ASP.NET Core также предоставляет собственные метрики в Microsoft.AspNetCore.Hosting источнике событий.

.NET SignalR клиент ActivitySource

Элемент SignalRActivitySource, названный Microsoft.AspNetCore.SignalR.Client, испускает события для клиента SignalR.

• Вызовы концентратора создают диапазон клиента. Другие SignalR клиенты, такие как клиент JavaScript, не поддерживают трассировку. Эта функция будет добавлена для большего числа клиентов в будущих версиях.
• Вызовы концентратора на клиенте и сервере поддерживают распространение контекста. Распространение контекста трассировки обеспечивает истинную распределенную трассировку. Теперь можно увидеть поток вызовов от клиента к серверу и обратно.

Вот как эти новые действия выглядят в Aspire панели мониторинга:

Сетевые трассировки

При возникновении проблемы трассировка сети иногда может предоставить ценную информацию. Это особенно полезно при отправке проблемы на наш трекер проблем.

Сбор трассировки сети с помощью Fiddler (предпочтительный вариант)

Этот метод применим для всех приложений.

Fiddler — это мощный инструмент для сбора трассировок HTTP. Установите его из telerik.com/fiddler, запустите его, а затем откройте приложение и воспроизведите ошибку. Fiddler доступен для Windows и существует бета-версия для macOS и Linux.

При подключении по протоколу HTTPS необходимо выполнить некоторые дополнительные действия, чтобы убедиться, что Fiddler сможет расшифровать трафик HTTPS. Дополнительные сведения см. в документации по Fiddler.

После сбора трассировки экспортируйте сеансы, выбрав Файл>Сохранить>Все сеансы в строке меню.

Получение трассировки сети с помощью tcpdump (только для macOS и Linux)

Этот метод применим для всех приложений.

Необработанные трассировки TCP можно собирать с помощью tcpdump, выполнив следующую команду из командной оболочки. Возможно, вам потребуются права привилегированного пользователя root или же будет необходимо ввести префикс команды с помощью sudo, если вы получите ошибку разрешений:

tcpdump -i [interface] -w trace.pcap

Замените на [interface] сетевой интерфейс, который вы хотите использовать. Как правило, это что-то подобное /dev/eth0 (для стандартного интерфейса Ethernet) или /dev/lo0 (для трафика localhost). Дополнительные сведения см. на tcpdump странице руководства в вашей хост-системе.

Сбор трассировки сети в браузере

Этот метод работает только для приложений на основе браузера.

Большинство консоли средств разработчика браузера имеют вкладку "Сеть", которая позволяет записывать сетевые действия между браузером и сервером. Однако эти трассировки не включают сообщения о событиях WebSocket и server-Sent. При работе с этими транспортами рекомендуется использовать такие инструменты, как Fiddler или TcpDump, как описано далее в этой статье.

Microsoft Edge и Internet Explorer

(Инструкции одинаковы для Microsoft Edge и Internet Explorer)

1. Откройте средства разработки, нажав клавишу F12
2. Выберите вкладку "Сеть"
3. Обновите страницу (при необходимости) и воспроизведите проблему
4. Щелкните значок "Сохранить" на панели инструментов, чтобы экспортировать трассировку в виде ФАЙЛА HAR:

Google Chrome

1. Откройте средства разработки, нажав клавишу F12
2. Выберите вкладку "Сеть"
3. Обновите страницу (при необходимости) и воспроизведите проблему
4. Щелкните правой кнопкой мыши в любом месте списка запросов и нажмите кнопку "Сохранить как HAR с содержимым":

Mozilla Firefox

1. Откройте средства разработки, нажав клавишу F12
2. Выберите вкладку "Сеть"
3. Обновите страницу (при необходимости) и воспроизведите проблему
4. Щелкните правой кнопкой мыши в любом месте списка запросов и нажмите кнопку "Сохранить все как HAR"

Присоединение диагностика файлов к проблемам GitHub

Файлы диагностики можно прикрепить к задачам GitHub, переименовав их, чтобы у них было расширение .txt, а затем перетащив их в задачу.

Metrics

Метрики представляют собой представление мер данных через интервалы времени. Например, запросы в секунду. Метрики позволяют отслеживать общее состояние приложения. Метрики .NET gRPC создаются с помощью EventCounter.

SignalR метрики сервера

SignalR Метрики сервера передаются в Microsoft.AspNetCore.Http.Connections источнике событий.

Наблюдение за метриками

dotnet-counters — это средство мониторинга производительности и первого уровня анализа производительности. Отслеживайте приложение .NET в Microsoft.AspNetCore.Http.Connections качестве имени поставщика. Рассмотрим пример.

> dotnet-counters monitor --process-id 37016 --counters Microsoft.AspNetCore.Http.Connections

Press p to pause, r to resume, q to quit.
    Status: Running
[Microsoft.AspNetCore.Http.Connections]
    Average Connection Duration (ms)       16,040.56
    Current Connections                         1
    Total Connections Started                   8
    Total Connections Stopped                   7
    Total Connections Timed Out                 0

Дополнительные ресурсы

• Конфигурация SignalR в ASP.NET Core
• Клиент JavaScript SignalR ASP.NET Core
• клиент ASP.NET Core SignalR .NET