X.Extensions.Logging.Telegram 3.0.0

X.Extensions.Logging.Telegram

Telegram logging provider for Microsoft.Extensions.Logging. Receive important log messages directly on your phone or laptop.

dotnet add package X.Extensions.Logging.Telegram

Targets netstandard2.0 and net10.0.

Prepare Telegram bot and channel

1. Create a Telegram bot and copy its access token.
2. Add the bot to your channel or chat as an admin with permission to post messages.
3. Get the chat id. For a public channel you can use its name (@channel_name). For a private channel, forward any message from it to @JsonDumpBot to get the id.

Configure in code

var options = new TelegramLoggerOptions(LogLevel.Information)
{
    AccessToken = "1234567890:AAAaaAAaa_AaAAaa-AAaAAAaAAaAaAaAAAA",
    ChatId = "-0000000000000",
    FormatterConfiguration = new FormatterConfiguration
    {
        ReadableApplicationName = "Human Readable Project Name",
        UseEmoji = true,
        IncludeException = true
    }
};

builder.Logging
    .ClearProviders()
    .AddTelegram(options)
    .AddConsole();

Or with a delegate:

builder.Logging.AddTelegram(options =>
{
    options.AccessToken = "...";
    options.ChatId = "...";
    options.FormatterConfiguration.ReadableApplicationName = "My App";
});

Configure with appsettings.json

{
  "Logging": {
    "LogLevel": {
      "Default": "Information"
    },
    "Telegram": {
      "LogLevel": {
        "Default": "Error",
        "WebApp.Controllers": "Warning"
      },
      "AccessToken": "1234567890:AAAaaAAaa_AaAAaa-AAaAAAaAAaAaAaAAAA",
      "ChatId": "1234567890",
      "FormatterConfiguration": {
        "ReadableApplicationName": "Human Readable Project Name",
        "UseEmoji": true,
        "IncludeException": true
      }
    }
  }
}

and pass IConfiguration to the extension method:

builder.Logging.AddTelegram(builder.Configuration);

Formatter options

Custom log writer

Implement ILogWriter to deliver messages your own way:

builder.Logging.AddTelegram(options, new CustomLogWriter());

Custom message formatter

Implement IMessageFormatter (or derive from MessageFormatterBase) and pass a factory. The factory receives the logger category name:

builder.Logging.AddTelegram(options, category => new CustomMessageFormatter(category));

Examples

The examples folder contains a console app and a web app.

Contributing

Feel free to add any improvements you want via pull requests. All pull requests must be linked to an issue.

License

This project is licensed under the MIT License.