Mds.Libraries.CSharp.Server

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

Обработчики ошибок (IBugReporter)

Пакет содержит в себе инструменты для удобной обработки ошибок на основе интерфейса IBugReporter из пакета Mds.Libraries.CSharp.Abstractions.

Основные классы:

• SlackBugReporter - отправка отчетов об ошибках в слак.
• ConsoleBugReporter - вывод отчета об ошибках в консоль.
• CompositeBugReporter - отправка отчета об ошибках во все каналы.

При добавлении SlackBugReporter и ConsoleBugReporter используются флаги ReporterTypeFlags. Они отвечают за то, в каком виде тот или иной репортер будет зарегистрирован.

ReporterTypeFlags

• None - Не регистрировать ни в каком виде.
• Independent - Регистрировать в качестве самостоятельного обработчика ошибок.
• Channel - Регистрировать в качестве канала для отправки отчетов об ошибках.

Composite

Для доставки отчета об ошибках в несколько каналов используется CompositeBugReporter.

Добавление через Autofac:

public void Add(ContainerBuilder builder)
{
    builder.AddCompositeReporter();
}

Или через IServiceCollection:

public void Add(IServiceCollection services)
{
    services.AddCompositeReporter();
}

Логика его работы подразумевает, что он запрашивает все реализации IExceptionReportChannel в scope и в каждый отправляет уведомление об ошибке.

IExceptionReportChannel

Для реализации функционала, когда каналов доставки отчетом об ошибках много, добавлен интерфейс IExceptionReportChannel. Он аналогичен IBugReporter. Добавлен он для разделения самостоятельных обработчиков и каналов для отправки уведомлений.

Для того, чтобы стандартные репортеры были зарегистрированы в качестве канала для доставки уведомлений, при регистрации необходимо указывать флаг ReporterTypeFlags.Channel.

Slack

Для регистрации обработчика ошибок с отправкой данных в Slack, нужно.

Через Autofac:

public void Add(ContainerBuilder builder)
{
    var hook = "";
    var appName = "";

    builder.AddSlackReporter(hook, appName);
}

Или через IServiceCollection:

public void Add(IServiceCollection services)
{
    var hook = "";
    var appName = "";

    services.AddSlackReporter(hook, appName);
}

Так же можно добавить репортер через SlackBugReporterConfiguration или через реализацию одного из интерфейсов: ISlackBugReporterConfiguration или IExtendedSlackBugReporterConfiguration.

SlackBugReporterConfiguration:

public void Add(ContainerBuilder builder)
{
    var hook = "";
    var appName = "";
    var configuration = new SlackBugReporterConfiguration(hook)
    {
        AppName = appName
    };

    builder.AddSlackReporter(configuration);
}

ISlackBugReporterConfiguration:

public void Add(ContainerBuilder builder)
{
    ISlackBugReporterConfiguration configuration = ...;

    builder.AddSlackReporter(configuration);
}

IExtendedSlackBugReporterConfiguration аналогичный интефейс, только с возможностью расширенной настройки доставки и форматирования сообщений. Таких как канал, имя бота и прочее.

Аналогично через IServiceCollection.

Так же при добавлении репортера есть возможность указать в качестве кого будет добавлен репортер. По умолчанию - Independent:

public void Add(ContainerBuilder builder)
{
    var hook = "";
    var appName = "";

    services.AddSlackReporter(hook, appName, ReporterTypeFlags.Independent | ReporterTypeFlags.Channel);
}

Аналогично через IServiceCollection.

Console

Для вывода в консоль информации об ошибках используется ConsoleBugReporter. Он сделан скорее для разработки, чем для реального применения.

Через Autofac:

public void Add(ContainerBuilder builder)
{
    services.AddConsoleReporter();
}

Аналогично через IServiceCollection.

Так же при добавлении репортера есть возможность указать в качестве кого будет добавлен репортер. По умолчанию - Independent:

public void Add(ContainerBuilder builder)
{
    services.AddConsoleReporter(ReporterTypeFlags.Independent | ReporterTypeFlags.Channel);
}

Аналогично через IServiceCollection.

Sentry

Если в системе подключен Sentry, то его можно подружить с IBugReporter. Для этого надо добавить SentryBugReporter.

Добавление через Autofac:

public void Add(ContainerBuilder builder)
{
    builder.AddSentryReporter();
}

Или через IServiceCollection:

public void Add(IServiceCollection services)
{
    services.AddSentryReporter();
}

Аналогично есть механизм с ReporterTypeFlags:

public void Add(ContainerBuilder builder)
{
    services.AddSentryReporter(ReporterTypeFlags.Independent | ReporterTypeFlags.Channel);
}

Подключение

Подключение репортера подразумевает, что в системе уже настроена интеграция с Sentry.

Обычно для этого надо сделать

Program.cs

public static void Main(string[] args)
{
    return WebHost.CreateDefaultBuilder(args)

                  // Подключение Sentry
                  .UseSentry() // или .UseSentry(option => {})

                  .UseStartup<Startup>();
                  .Build()
}

и

В Mds шаблонах это Configurations.cs, у вас может быть другой файл

public void Configure(IApplicationBuilder app)
{
    app.UseSentryTracing();

    app.UseRouting();
    app.UseEndpoints(endpoints => {});
}

После этого уже можно добавлять SentryBugReporter стандартным способом.