https://github.com/yavorfingarov/simplerequestlogger
A simple and customizable ASP.NET Core middleware for structured logging of requests.
https://github.com/yavorfingarov/simplerequestlogger
aspnetcore logging middleware
Last synced: 3 months ago
JSON representation
A simple and customizable ASP.NET Core middleware for structured logging of requests.
- Host: GitHub
- URL: https://github.com/yavorfingarov/simplerequestlogger
- Owner: yavorfingarov
- License: mit
- Created: 2021-12-28T20:35:31.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-09T00:39:03.000Z (almost 2 years ago)
- Last Synced: 2025-03-08T21:45:43.939Z (3 months ago)
- Topics: aspnetcore, logging, middleware
- Language: C#
- Homepage:
- Size: 99.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# SimpleRequestLogger
[](https://www.nuget.org/packages/SimpleRequestLogger)
[](https://www.nuget.org/stats/packages/SimpleRequestLogger?groupby=Version)
[](https://github.com/yavorfingarov/SimpleRequestLogger/actions/workflows/cd.yml?query=branch%3Amaster)
[](https://github.com/yavorfingarov/SimpleRequestLogger/actions/workflows/codeql.yml?query=branch%3Amaster)
[](https://github.com/yavorfingarov/SimpleRequestLogger/actions/workflows/cd.yml?query=branch%3Amaster)
[](https://github.com/yavorfingarov/SimpleRequestLogger/actions/workflows/cd.yml?query=branch%3Amaster)
[](https://github.com/yavorfingarov/SimpleRequestLogger/actions/workflows/cd.yml?query=branch%3Amaster)
SimpleRequestLogger is a small and customizable ASP.NET Core middleware for structured logging
of requests using `Microsoft.Extensions.Logging`. The built-in request logging is a bit noisy
and emits multiple events per request. With SimpleRequestLogger you can fit all the information
you need in a single log entry:
```
// Plaintext
21:51:46.5705 [INF] GET / responded 200 in 31 ms.
// JSON
{
"Time": "21:51:46.5705",
"Level": "INF",
"Message": "GET / responded 200 in 31 ms.",
"Properties": {
"Method": "GET",
"Path": "/",
"QueryString": "",
"StatusCode": 200,
"ElapsedMs": 31
}
}
```
## Getting started
Install the [NuGet package](https://www.nuget.org/packages/SimpleRequestLogger) and
add the middleware at the beginning of your request pipeline:
```csharp
app.UseRequestLogging();
```
## Configuration
By default, SimpleRequestLogger logs all requests at information log level with message
template `"{Method} {Path}{QueryString} responded {StatusCode} in {ElapsedMs} ms."`.
It is possible to customize the message template, to change the log level based on
status code and to disable logging for specific paths. SimpleRequestLogger uses
`Microsoft.Extensions.Configuration` and would by default expect a section `RequestLogging`.
```json
"RequestLogging": {
"MessageTemplate": "{Scheme} {Method} {Path} => {StatusCode}",
"IgnorePaths": [ "/health", "/static/*" ]
}
```
It is also possible to pass a custom configuration section:
```csharp
app.UseRequestLogging("YourCustomSection:CustomSubsectionRequestLogging");
```
To change the log level based on status code, you should pass a delegate to the middleware:
```csharp
app.UseRequestLogging(statusCode => (statusCode < 400) ? LogLevel.Information : LogLevel.Error);
```
You might as well have both custom configuration section and a log level selector.
```csharp
app.UseRequestLogging("YourCustomSection:CustomSubsectionRequestLoging",
statusCode => (statusCode < 400) ? LogLevel.Information : LogLevel.Error);
```
### Properties
- Method
- Path
- QueryString
- Header* - A Pascal case field name will be transformed to Kebab case. Example: HeaderFooBar => foo-bar
- Protocol
- Scheme
- RemoteIpAddress - If you log this property you might want to consider adding `UseForwardedHeaders()` to your pipeline.
- Claim* - A Pascal case claim type will be transformed to Kebab case. Example: ClaimFooBar => foo-bar
- StatusCode
- ElapsedMs
## Pipeline placement
You might want to consider placing SimpleRequestLogger after request-heavy middleware like `UseStaticFiles()`
if those requests are not interesting for you. Alternatively, you might ignore those via the configuration.
If SimpleRequestLogger catches an exception, the request will be logged with a status code 500
and the exception will be rethrown. If you have an error handling middleware that alters the response
status code based on exception type, you should consider adding SimpleRequestLogger before it.
## Self-checks
On startup, when the middleware is instantiated, the configuration is verified. `MessageTemplate`
and `IgnorePaths` are checked for validity. Additionally, it is also ensured that the log level selector
delegate will not throw for the standard response status codes. In case of a problem with the configuration,
an `InvalidOperationException` is thrown.
## Additional resources
* [Changelog](https://github.com/yavorfingarov/SimpleRequestLogger/blob/master/CHANGELOG.md)
* [License](https://github.com/yavorfingarov/SimpleRequestLogger/blob/master/LICENSE)
## Help and support
For bug reports and feature requests, please use the [issue tracker](https://github.com/yavorfingarov/SimpleRequestLogger/issues).
For questions, ideas and other topics, please check the [discussions](https://github.com/yavorfingarov/SimpleRequestLogger/discussions).