https://github.com/thiagobarradas/restsharp-serilog-auto

Automatic log request and response from RestSharp using Serilog
https://github.com/thiagobarradas/restsharp-serilog-auto

auto automatic dotnet dotnet-core log logger logging request response rest restsharp seq serilog serilog-enricher serilog-extension splunk

Last synced: 7 days ago
JSON representation

Automatic log request and response from RestSharp using Serilog

• Host: GitHub
• URL: https://github.com/thiagobarradas/restsharp-serilog-auto
• Owner: ThiagoBarradas
• License: mit
• Created: 2018-07-19T01:52:44.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-12T20:45:41.000Z (4 months ago)
• Last Synced: 2024-08-10T11:07:56.927Z (3 months ago)
• Topics: auto, automatic, dotnet, dotnet-core, log, logger, logging, request, response, rest, restsharp, seq, serilog, serilog-enricher, serilog-extension, splunk
• Language: C#
• Homepage: https://www.nuget.org/packages/RestSharp.Serilog.Auto/
• Size: 102 KB
• Stars: 22
• Watchers: 5
• Forks: 14
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://barradas.visualstudio.com/Contributions/_apis/build/status/NugetPackage/RestSharp%20Serilog%20Auto?branchName=develop)](https://barradas.visualstudio.com/Contributions/_build/latest?definitionId=14&branchName=master)

[![NuGet Downloads](https://img.shields.io/nuget/dt/RestSharp.Serilog.Auto.svg)](https://www.nuget.org/packages/RestSharp.Serilog.Auto/)

[![NuGet Version](https://img.shields.io/nuget/v/RestSharp.Serilog.Auto.svg)](https://www.nuget.org/packages/RestSharp.Serilog.Auto/)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ThiagoBarradas_restsharp-serilog-auto&metric=alert_status)](https://sonarcloud.io/dashboard?id=ThiagoBarradas_restsharp-serilog-auto)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ThiagoBarradas_restsharp-serilog-auto&metric=coverage)](https://sonarcloud.io/dashboard?id=ThiagoBarradas_restsharp-serilog-auto)

# RestSharp.Serilog.Auto

Do you need log all communication made with RestSharp using your serilog configuration? Just install this package and register our client proxy for `IRestClient`.

```c#

IRestClient client = new RestClientAutolog("http://www.github.com");

```

## Install via NuGet

```

PM> Install-Package RestSharp.Serilog.Auto

```

## How to use

You can change error message, success message and logger configuration. 

```c#

var loggerConfiguration = new LoggerConfiguration()

                .MinimumLevel.Debug()

                .Enrich.WithMachineName()

                .Enrich.WithProperty("Domain", "MyDomain")

                .Enrich.WithProperty("Application", "MyProject")

                .Enrich.FromLogContext()

                .WriteTo.Seq("http://localhost:5341")

                .WriteTo.Console();

var restClientAutologConfiguration = new RestClientAutologConfiguration()

{

    MessageTemplateForSuccess = "{Method} {Url} responded {StatusCode}", 

    MessageTemplateForError = "{Method} {Url} is not good! {ErrorMessage}", 

    LoggerConfiguration = loggerConfiguration

};

IRestClient client = new RestClientAutolog("http://www.github.com", restClientAutologConfiguration);

```

Serilog uses `Log.Logger` as global. If you setup this on your application Startup/Bootstrap, it's not needed change logger configuration.

## Variables to use in message templates

Properties created like `(...).Enrich.WithProperty("Application", "MyProject")` can be used in templates.

Default variables:

* `Agent`

* `ElapsedMilliseconds`

* `Method`

* `Url`

* `Host`

* `Path`

* `Port`

* `QueryString`

* `Query`

* `RequestBody`

* `RequestHeaders`

* `StatusCode`

* `StatusCodeFamily`

* `StatusDescription`

* `ResponseStatus`

* `IsSuccessful`

* `ErrorMessage`

* `ErrorException`

* `ResponseContent`

* `ContentLength`

* `ContentType`

* `ContentEncoding`

* `ResponseHeaders`

* `ProtocolVersion`

## Setup global max length for exception properties

Use env var to change default value

- `SERILOG_ERROR_MESSAGE_MAX_LENGTH` default value 256;

- `SERILOG_ERROR_EXCEPTION_MAX_LENGTH` default value 1024;

## How can I contribute?

Please, refer to [CONTRIBUTING](.github/CONTRIBUTING.md)

## Found something strange or need a new feature?

Open a new Issue following our issue template [ISSUE_TEMPLATE](.github/ISSUE_TEMPLATE.md)

## Changelog

See in [nuget version history](https://www.nuget.org/packages/RestSharp.Serilog.Auto)

## Did you like it? Please, make a donate :)

if you liked this project, please make a contribution and help to keep this and other initiatives, send me some Satochis.

BTC Wallet: `1G535x1rYdMo9CNdTGK3eG6XJddBHdaqfX`

![1G535x1rYdMo9CNdTGK3eG6XJddBHdaqfX](https://i.imgur.com/mN7ueoE.png)