Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thiagobarradas/aspnet-serilog
AspNet Core Serilog component for help you log all request/response and exceptions.
https://github.com/thiagobarradas/aspnet-serilog
api aspnet-web-api aspnetcore easy exceptions logger nuget package request response serilog
Last synced: 3 months ago
JSON representation
AspNet Core Serilog component for help you log all request/response and exceptions.
- Host: GitHub
- URL: https://github.com/thiagobarradas/aspnet-serilog
- Owner: ThiagoBarradas
- License: mit
- Created: 2019-08-13T04:15:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-12T17:01:28.000Z (7 months ago)
- Last Synced: 2024-09-30T00:48:30.685Z (4 months ago)
- Topics: api, aspnet-web-api, aspnetcore, easy, exceptions, logger, nuget, package, request, response, serilog
- Language: C#
- Homepage: https://www.nuget.org/packages/AspNetSerilog/
- Size: 55.7 KB
- Stars: 4
- Watchers: 3
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://barradas.visualstudio.com/Contributions/_build/latest?definitionId=13&branchName=master)
[](https://www.nuget.org/packages/AspNetSerilog/)
[](https://www.nuget.org/packages/AspNetSerilog/)
[](https://sonarcloud.io/dashboard?id=ThiagoBarradas_aspnet-serilog)
# AspNetSerilog
Serilog logger for AspNet Core web applications. Handler request, response and exceptions.
## Install via NuGet
```
PM> Install-Package AspNetSerilog
```
# Sample
Configure your Startup.cs
```c#
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
var config = new SerilogConfiguration
{
Blacklist = new string[] { "password", "credit_card" }
};
services.SetupSerilog(config);
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseAspNetSerilog();
app.UseMvc();
}
```
Ready! That way all request/response will be sended to serilog.
You can custom information title / error title and Serilog Logger using SerilogConfiguration in constructor. By default, global serilog logger will be used.
You can disable logging on success using DisableSerilogExtension in your action:
```c#
[HttpGet("")]
public IActionResult Home()
{
this.DisableLogging();
...
}
```
For exception log, in your global exception handler, add exception in context items, like:
```
context.Items.Add("Exception", exception);
```
## Properties
* `RequestBody`
* `Method`
* `Path`
* `Host`
* `Port`
* `Url`
* `QueryString`
* `Query`
* `RequestHeaders`
* `Ip`
* `IsSuccessful`
* `StatusCode`
* `StatusDescription`
* `StatusCodeFamily`
* `ProtocolVersion`
* `ErrorException`
* `ErrorMessage`
* `ResponseContent`
* `ContentType`
* `ContentLength`
* `ResponseHeaders`
* `ElapsedMilliseconds`
* `RequestKey`
You can use this propeties with serilog log context to build log messages. `HTTP {Method} {Path} {...}`.
## 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/AspNetSerilog)
## 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`
