Skip to content

Update the example README to the payload the target sends today #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PetrHeinz merged 1 commit into from
Sep 30, 2026
Merged

Update the example README to the payload the target sends today #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
140 changes: 87 additions & 53 deletions example-project/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ var logger = LogManager.GetCurrentClassLogger();
```

This will create a logger for the current class.
In this case, it will be created for the `Program` class and it will add `"logger_string"` with the value `"Program"` to the context of the JSON log message.
In this case, it will be created for the `Program` class and it will add `"logger"` with the value `"Program"` to the context of the JSON log message.

### Colored property values

Expand All @@ -112,15 +112,10 @@ NLog.LogManager.Setup().SetupSerialization(

### Filter logs

The name of the logger will also be present in the log message which will look something like this:

```json
"2022-01-26 10:25:06.0980|DEBUG|Program|Debugging is hard, but can be easier with Better Stack!"
```

The name of the logger is sent with every log message, in `context.logger`.
This provides an option to filter logs based on the logger that sends them. You can create a logger for each of the logical components of your application and then filter the logs based on the names of the components.

For example, if you create a logger as a field of the `ShoppingCart` class, the value of `logger_string` will be `ShoppingCart` :
For example, if you create a logger as a field of the `ShoppingCart` class, the value of `context.logger` will be `ShoppingCart`:

```csharp
public class ShoppingCart
Expand All @@ -134,28 +129,29 @@ The output will look similar to this:

```json
{
"dt":"2022-01-26 10:48:10.635 UTC",
"dt":"2026-09-30T15:14:25.854796+00:00",
"message":"Error !!!!!",
"level":"Error",
"context":{
"logger_string":"ShoppingCart",
"logger":"ShoppingCart",
"properties":{},
"runtime":{
"class_string":"ShoppingCart",
"file_string":"C:\\Users\\someuser\\source\\repos\\ExampleProject\\ExampleProject\\ShoppingCart.cs",
"line_integer":"16",
"member_string":".ctor"
"class":"ShoppingCart",
"member":".ctor",
"file":"C:\\Users\\someuser\\source\\repos\\ExampleProject\\ExampleProject\\ShoppingCart.cs",
"line":9
}
},
"level_string":"Error",
"message_string":"2022-01-26 11:48:10.6354|ERROR|ExampleProject.ShoppingCart|Error !!!!!"
}
}
```

Then it is possible to filter the logs using the following search formula:

```json
context.logger_string="ShoppingCart"
context.logger="ShoppingCart"
```

This will only show logs that were sent from to `ShoppingCart` logger.
This will only show logs that were sent by the `ShoppingCart` logger.

# Logging

Expand All @@ -175,7 +171,7 @@ To send a log message of select log level, use the corresponding method. In this

```csharp
//Send debug messages using the Debug() method
logger.Debug("Debugging is hard, but can be easier with Logtai!");
logger.Debug("Debugging is hard, but can be easier with Better Stack!");

//Send message about serious problems using the Error() method
logger.Error("Error occurred! And it's not good.");
Expand All @@ -185,33 +181,71 @@ This will create the following JSON output:

```json
{
"dt":"2022-01-26 09:25:06.098 UTC",
"dt":"2026-09-30T15:14:25.852543+00:00",
"message":"Debugging is hard, but can be easier with Better Stack!",
"level":"Debug",
"context":{
"logger_string":"Program",
"logger":"Program",
"properties":{},
"runtime":{
"class_string":"Program",
"file_string":"C:\\Users\\someuser\\source\\repos\\ExampleProject\\ExampleProject\\Program.cs",
"line_integer":"21",
"member_string":"<Main>$"
"class":"Program",
"member":"<Main>$",
"file":"C:\\Users\\someuser\\source\\repos\\ExampleProject\\ExampleProject\\Program.cs",
"line":25
}
},
"level_string":"Debug",
"message_string":"2022-01-26 10:25:06.0980|DEBUG|Program|Debugging is hard, but can be easier with Logtai!"
}
}

{
"dt":"2022-01-26 09:25:06.098 UTC",
"dt":"2026-09-30T15:14:25.854796+00:00",
"message":"Error occurred! And it's not good.",
"level":"Error",
"context":{
"logger_string":"Program",
"logger":"Program",
"properties":{},
"runtime":{
"class_string":"Program",
"file_string":"C:\\Users\\someuser\\source\\repos\\ExampleProject\\ExampleProject\\Program.cs",
"line_integer":"32",
"member_string":"<Main>$"
"class":"Program",
"member":"<Main>$",
"file":"C:\\Users\\someuser\\source\\repos\\ExampleProject\\ExampleProject\\Program.cs",
"line":36
}
},
"level_string":"Error",
"message_string":"2022-01-26 10:25:06.0980|ERROR|Program|Error occurred! And it's not good."
}
}
```

To send an exception along with the log message, pass it as the first argument:

```csharp
try
{
throw new InvalidOperationException("Payment gateway timed out");
}
catch (Exception ex)
{
logger.Error(ex, "Order {orderId} failed", 75423);
}
```

The exception, with its stack trace, is sent in the top-level `exception` field:

```json
{
"dt":"2026-09-30T15:14:25.854796+00:00",
"message":"Order 75423 failed",
"level":"Error",
"exception":"System.InvalidOperationException: Payment gateway timed out\r\n at Program.<Main>$(String[] args) in C:\\Users\\someuser\\source\\repos\\ExampleProject\\ExampleProject\\Program.cs:line 43",
"context":{
"logger":"Program",
"properties":{
"orderId":75423
},
"runtime":{
"class":"Program",
"member":"<Main>$",
"file":"C:\\Users\\someuser\\source\\repos\\ExampleProject\\ExampleProject\\Program.cs",
"line":43
}
}
}
```

Expand Down Expand Up @@ -244,27 +278,27 @@ Code above will create the following output:

```json
{
"dt":"2022-01-26 09:55:34.128 UTC",
"dt":"2026-09-30T15:14:25.852543+00:00",
"message":"User \"Josh\" - 95845 just ordered item 75423",
"level":"Info",
"context":{
"logger_string":"Program",
"runtime":{
"class_string":"Program",
"file_string":"D:\\ExampleProject\\Program.cs",
"line_integer":"25",
"member_string":"<Main>$"
},
"logger":"Program",
"properties":{
"item_integer":"75423",
"userID_integer":"95845",
"user_string":"Josh"
"user":"Josh",
"userID":95845,
"item":75423
},
"runtime":{
"class":"Program",
"member":"<Main>$",
"file":"C:\\Users\\someuser\\source\\repos\\ExampleProject\\ExampleProject\\Program.cs",
"line":30
}
},
"level_string":"Info",
"message_string":"2022-01-26 10:55:34.1285|INFO|Program|User \"Josh\" - 95845 just ordered item 75423"
}
}
```

A new field called `properties` is added into the `context` and it contains the arguments that were passed and their values.
The `properties` field of the `context` contains the arguments that were passed and their values.

## Adding context to all logs

Expand Down
Loading