diff --git a/README.md b/README.md index bbd4f3a6..446af954 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,41 @@ Serilog.ILogger log = new LoggerConfiguration() .CreateLogger(); ``` +The sink is batching multiple events into a single request, and the following hypothetical payload is sent as JSON. + +```json +{ + "events": [ + { + "Timestamp": "2016-11-03T00:09:11.4899425+01:00", + "Level": "Debug", + "MessageTemplate": "Logging {@Heartbeat} from {Computer}", + "RenderedMessage": "Logging { UserName: \"Mike\", UserDomainName: \"Home\" } from \"Workstation\"", + "Properties": { + "Heartbeat": { + "UserName": "Mike", + "UserDomainName": "Home" + }, + "Computer": "Workstation" + } + }, + { + "Timestamp": "2016-11-03T00:09:12.4905685+01:00", + "Level": "Debug", + "MessageTemplate": "Logging {@Heartbeat} from {Computer}", + "RenderedMessage": "Logging { UserName: \"Mike\", UserDomainName: \"Home\" } from \"Workstation\"", + "Properties": { + "Heartbeat": { + "UserName": "Mike", + "UserDomainName": "Home" + }, + "Computer": "Workstation" + } + } + ] +} +``` + ### Install via NuGet If you want to include the HTTP POST sink in your project, you can [install it directly from NuGet](https://www.nuget.org/packages/Serilog.Sinks.Http/).