Skip to content
/ X.Extensions.Logging.Telegram Public

Commit 1839068

Browse files
a-gubskiya-gubskiy
committedOct 27, 2024
Update documentation
1 parent 69a3cdc commit 1839068

File tree

4 files changed

+141
-140
lines changed

4 files changed

+141
-140
lines changed
 

‎README.md

+10-139
Original file line numberDiff line numberDiff line change
@@ -9,156 +9,27 @@ Telegram logging providers for Serilog and standard .NET logging.
99
What is Telegram? What do I do here?
1010
Telegram is a messaging app with a focus on speed and security, it’s super-fast, simple and free. You can use Telegram on all your devices at the same time — your messages sync seamlessly across any number of your phones, tablets or computers. Telegram has over 500 million monthly active users and is one of the 10 most downloaded apps in the world.
1111

12-
## Why you need write logs to Telegram?
13-
Because it very comfortable - you can receive important messages directly to your smartphone or laptop.
12+
## Why do you need to write logs to Telegram?
13+
Because it is very comfortable - you can receive important messages directly to your smartphone or laptop.
1414

1515
## Prepare Telegram bot
16-
For sending log messages into telegram channel or chat you need create telegram bot before. [Here](https://core.telegram.org/bots#3-how-do-i-create-a-bot) you can find how to do it.
17-
After you created bot add it to channel with admin role and allow bot to post messages.
16+
For sending log messages into telegram channel or chat, you need to create telegram bot before. [Here](https://core.telegram.org/bots#3-how-do-i-create-a-bot) you can find how to do it.
17+
After you create bot, add it to a channel with admin role and allow bot to post messages.
1818

1919
## Prepare Telegram channel
20-
In telegram there are two types of channels: public and private. For public channel you can use channel name as *ChatId* in configuration.
20+
In the telegram, there are two types of channels: public and private. For public channel you can use channel name as *ChatId* in configuration.
2121

2222
For private channel you can use [@JsonDumpBot](https://t.me/jsondumpbot) to get private channel id. Just forward any message from private channelto this bot. Additional information you can find [here](https://botostore.com/c/jsondumpbot/).
2323

2424
**Do not forget** to add your bot as admin with _write messages_ permission to channel.
2525

26+
## Logger implementations
2627

27-
## X.Extensions.Logging.Telegram
28-
[![NuGet](https://img.shields.io/nuget/v/X.Extensions.Logging.Telegram)](https://www.nuget.org/packages/X.Extensions.Logging.Telegram)
29-
[![NuGet Downloads](https://img.shields.io/nuget/dt/X.Extensions.Logging.Telegram)](https://www.nuget.org/packages/X.Extensions.Logging.Telegram)
28+
### X.Extensions.Logging.Telegram
29+
Read library documentation [here](./src/X.Extensions.Logging.Telegram/README.md).
3030

31-
X.Extensions.Logging.Telegram is logging provider for standard .NET logging.
32-
33-
### Getting Started
34-
35-
You can configure Telegram logging provider by code or by config file:
36-
37-
```csharp
38-
var options = new TelegramLoggerOptions(LogLevel.Information)
39-
{
40-
AccessToken = "1234567890:AAAaaAAaa_AaAAaa-AAaAAAaAAaAaAaAAAA",
41-
ChatId = "-0000000000000",
42-
Source = "Human Readable Project Name"
43-
};
44-
45-
...
46-
47-
builder
48-
.ClearProviders()
49-
.AddTelegram(options)
50-
.AddConsole();
51-
52-
```
53-
54-
### appconfig.json
55-
56-
```
57-
{
58-
"Logging": {
59-
"LogLevel": {
60-
"Default": "Information",
61-
"Microsoft": "Warning",
62-
"Microsoft.Hosting.Lifetime": "Information"
63-
},
64-
"Telegram": {
65-
"LogLevel": {
66-
"Default": "Error",
67-
"WebApp.Controllers": "Warning"
68-
},
69-
"AccessToken": "1234567890:AAAaaAAaa_AaAAaa-AAaAAAaAAaAaAaAAAA",
70-
"ChatId": "1234567890",
71-
"Source": "Human Readable Project Name"
72-
}
73-
},
74-
"AllowedHosts": "*"
75-
}
76-
```
77-
78-
and pass IConfiguration object to extensions method
79-
80-
```
81-
public static IHostBuilder CreateHostBuilder(string[] args) =>
82-
Host.CreateDefaultBuilder(args)
83-
.ConfigureLogging((context, builder) =>
84-
{
85-
if (context.Configuration != null)
86-
builder
87-
.AddTelegram(context.Configuration)
88-
.AddConsole();
89-
})
90-
.ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); });
91-
````
92-
93-
### Use custom log writer
94-
Now developers can use their own implementation for writing data to Telegram. Custom writer should implement _ILogWriter_ interface:
95-
96-
``` cs
97-
var customLogWriter = new CustomLogWriter();
98-
logBuilder.AddTelegram(options, customLogWriter);
99-
```
100-
101-
### Use custom message formatter
102-
For implement custom message formatting _ITelegramMessageFormatter_ can be used now.
103-
104-
``` cs
105-
private ITelegramMessageFormatter CreateFormatter(string name)
106-
{
107-
return new CustomTelegramMessageFormatter(name);
108-
}
109-
110-
logBuilder.AddTelegram(options, CreateFormatter);
111-
```
112-
113-
For using custom message formatter delegate Func<string, ITelegramMessageFormatter> should be passed to extensions method AddTelegram. Delegate should be used because formatter needs to know which category is used for rendering the message.
114-
115-
116-
117-
118-
# X.Extensions.Serilog.Sinks.Telegram
119-
120-
[![NuGet](https://img.shields.io/nuget/v/X.Extensions.Serilog.Sinks.Telegram)](https://www.nuget.org/packages/X.Extensions.Serilog.Sinks.Telegram)
121-
[![NuGet Downloads](https://img.shields.io/nuget/dt/X.Extensions.Serilog.Sinks.Telegram)](https://www.nuget.org/packages/X.Extensions.Serilog.Sinks.Telegram)
122-
123-
124-
X.Serilog.Sinks.Telegram is an open-source Serilog sink that allows you to send log events to Telegram. It's a convenient way to integrate Telegram as a logging output, enabling you to receive important log information directly in your chat.
125-
126-
## Features
127-
128-
- **Real-time Logging**: The sink offers the ability to send log events to a Telegram channel in real-time, ensuring that you can stay up-to-date with your application's behavior and any issues as they arise.
129-
130-
- **Customizable Formatting**: You can configure the format of log messages sent to the Telegram channel, allowing you to tailor them to your preferences and specific requirements.
131-
132-
- **Filtering**: The sink supports filtering log events before they are dispatched to the Telegram channel, ensuring that only pertinent information is shared.
133-
134-
- **Asynchronous Sending**: Log events are sent asynchronously to the Telegram channel, minimizing potential impact on your application's performance.
135-
136-
- **Easy Configuration**: Configuring the sink to work with your Telegram channel is straightforward, and you can find comprehensive information in the [Configuration Wiki](https://github.com/Bardin08/X.Serilog.Sinks.Telegram/wiki/Configuration).
137-
138-
## Getting Started
139-
140-
To begin using the X.Serilog.Sinks.Telegram sink, follow these steps:
141-
142-
1. **Install the Package**: You can install the sink package from NuGet using the following command:
143-
```shell
144-
dotnet add package X.Serilog.Sinks.Telegram
145-
```
146-
147-
2. **Configure the Sink**: Set up the Telegram sink with the appropriate settings in your application's configuration. Here's an example configuration in C#:
148-
149-
```c#
150-
Log.Logger = new LoggerConfiguration()
151-
.WriteTo.TelegramCore(
152-
token: botToken,
153-
chatId: loggingChatId,
154-
logLevel: LogEventLevel.Verbose)
155-
.WriteTo.Console()
156-
.CreateLogger();
157-
```
158-
159-
3. **Start Logging**: Once the sink is configured, you can log in using Serilog as usual. Log events will be sent to your Telegram channel.
160-
161-
For more detailed configuration options, please refer to the [Configuration Wiki](https://github.com/Bardin08/X.Serilog.Sinks.Telegram/wiki/Configuration).
31+
### X.Extensions.Serilog.Sinks.Telegram
32+
Read library documentation [here](./src/X.Extensions.Serilog.Sinks.Telegram/README.md).
16233

16334
# Examples
16435

‎src/X.Extensions.Logging.Telegram/README.md

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
## X.Extensions.Logging.Telegram
2+
[![NuGet](https://img.shields.io/nuget/v/X.Extensions.Logging.Telegram)](https://www.nuget.org/packages/X.Extensions.Logging.Telegram)
3+
[![NuGet Downloads](https://img.shields.io/nuget/dt/X.Extensions.Logging.Telegram)](https://www.nuget.org/packages/X.Extensions.Logging.Telegram)
4+
5+
X.Extensions.Logging.Telegram is logging provider for standard .NET logging.
6+
7+
### Getting Started
8+
9+
You can configure Telegram logging provider by code or by config file:
10+
11+
```csharp
12+
var options = new TelegramLoggerOptions(LogLevel.Information)
13+
{
14+
AccessToken = "1234567890:AAAaaAAaa_AaAAaa-AAaAAAaAAaAaAaAAAA",
15+
ChatId = "-0000000000000",
16+
Source = "Human Readable Project Name"
17+
};
18+
19+
...
20+
21+
builder
22+
.ClearProviders()
23+
.AddTelegram(options)
24+
.AddConsole();
25+
26+
```
27+
28+
### appconfig.json
29+
30+
```
31+
{
32+
"Logging": {
33+
"LogLevel": {
34+
"Default": "Information",
35+
"Microsoft": "Warning",
36+
"Microsoft.Hosting.Lifetime": "Information"
37+
},
38+
"Telegram": {
39+
"LogLevel": {
40+
"Default": "Error",
41+
"WebApp.Controllers": "Warning"
42+
},
43+
"AccessToken": "1234567890:AAAaaAAaa_AaAAaa-AAaAAAaAAaAaAaAAAA",
44+
"ChatId": "1234567890",
45+
"Source": "Human Readable Project Name"
46+
}
47+
},
48+
"AllowedHosts": "*"
49+
}
50+
```
51+
52+
and pass IConfiguration object to extensions method
53+
54+
```
55+
public static IHostBuilder CreateHostBuilder(string[] args) =>
56+
Host.CreateDefaultBuilder(args)
57+
.ConfigureLogging((context, builder) =>
58+
{
59+
if (context.Configuration != null)
60+
builder
61+
.AddTelegram(context.Configuration)
62+
.AddConsole();
63+
})
64+
.ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); });
65+
````
66+
67+
### Use a custom log writer
68+
Now developers can use their own implementation for writing data to Telegram. Custom writer should implement _ILogWriter_ interface:
69+
70+
``` cs
71+
var customLogWriter = new CustomLogWriter();
72+
logBuilder.AddTelegram(options, customLogWriter);
73+
```
74+
75+
### Use custom message formatter
76+
For implement custom message formatting _ITelegramMessageFormatter_ can be used now.
77+
78+
``` cs
79+
private ITelegramMessageFormatter CreateFormatter(string name)
80+
{
81+
return new CustomTelegramMessageFormatter(name);
82+
}
83+
84+
logBuilder.AddTelegram(options, CreateFormatter);
85+
```
86+
87+
For using custom message formatter delegate Func<string, ITelegramMessageFormatter> should be passed to extensions method AddTelegram. Delegate should be used because formatter needs to know which category is used for rendering the message.

‎src/X.Extensions.Logging.Telegram/X.Extensions.Logging.Telegram.csproj

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
</PropertyGroup>
1515

1616
<ItemGroup>
17-
<None Include="../../README.md" Pack="true" PackagePath=""/>
1817
<None Include="../../LICENSE.md" Pack="true" PackagePath=""/>
1918
<None Include="../../x-extensions.png" Pack="True" PackagePath=""/>
2019
</ItemGroup>

‎src/X.Extensions.Serilog.Sinks.Telegram/README.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# X.Extensions.Serilog.Sinks.Telegram
2+
3+
[![NuGet](https://img.shields.io/nuget/v/X.Extensions.Serilog.Sinks.Telegram)](https://www.nuget.org/packages/X.Extensions.Serilog.Sinks.Telegram)
4+
[![NuGet Downloads](https://img.shields.io/nuget/dt/X.Extensions.Serilog.Sinks.Telegram)](https://www.nuget.org/packages/X.Extensions.Serilog.Sinks.Telegram)
5+
6+
7+
X.Serilog.Sinks.Telegram is an open-source Serilog sink that allows you to send log events to Telegram. It's a convenient way to integrate Telegram as a logging output, enabling you to receive important log information directly in your chat.
8+
9+
## Features
10+
11+
- **Real-time Logging**: The sink offers the ability to send log events to a Telegram channel in real-time, ensuring that you can stay up-to-date with your application's behavior and any issues as they arise.
12+
13+
- **Customizable Formatting**: You can configure the format of log messages sent to the Telegram channel, allowing you to tailor them to your preferences and specific requirements.
14+
15+
- **Filtering**: The sink supports filtering log events before they are dispatched to the Telegram channel, ensuring that only pertinent information is shared.
16+
17+
- **Asynchronous Sending**: Log events are sent asynchronously to the Telegram channel, minimizing potential impact on your application's performance.
18+
19+
- **Easy Configuration**: Configuring the sink to work with your Telegram channel is straightforward, and you can find comprehensive information in the [Configuration Wiki](https://github.com/Bardin08/X.Serilog.Sinks.Telegram/wiki/Configuration).
20+
21+
## Getting Started
22+
23+
To begin using the X.Serilog.Sinks.Telegram sink, follow these steps:
24+
25+
1. **Install the Package**: You can install the sink package from NuGet using the following command:
26+
```shell
27+
dotnet add package X.Serilog.Sinks.Telegram
28+
```
29+
30+
2. **Configure the Sink**: Set up the Telegram sink with the appropriate settings in your application's configuration. Here's an example configuration in C#:
31+
32+
```c#
33+
Log.Logger = new LoggerConfiguration()
34+
.WriteTo.TelegramCore(
35+
token: botToken,
36+
chatId: loggingChatId,
37+
logLevel: LogEventLevel.Verbose)
38+
.WriteTo.Console()
39+
.CreateLogger();
40+
```
41+
42+
3. **Start Logging**: Once the sink is configured, you can log in using Serilog as usual. Log events will be sent to your Telegram channel.
43+
44+
For more detailed configuration options, please refer to the [Configuration Wiki](https://github.com/Bardin08/X.Serilog.Sinks.Telegram/wiki/Configuration).

0 commit comments

Comments
 (0)
Please sign in to comment.