https://github.com/holomodular/servicebricks-logging
ServiceBricks Logging Microservice - Centralized application and web request logging
https://github.com/holomodular/servicebricks-logging
logging servicebricks
Last synced: 4 months ago
JSON representation
ServiceBricks Logging Microservice - Centralized application and web request logging
- Host: GitHub
- URL: https://github.com/holomodular/servicebricks-logging
- Owner: holomodular
- License: mit
- Created: 2024-04-28T00:12:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-14T14:35:55.000Z (7 months ago)
- Last Synced: 2025-12-15T16:18:38.758Z (7 months ago)
- Topics: logging, servicebricks
- Language: C#
- Homepage:
- Size: 1.34 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://badge.fury.io/nu/ServiceBricks.Logging.Microservice)
[](https://opensource.org/licenses/MIT)
# ServiceBricks Logging Microservice
## Overview
This repository contains a logging microservice built using the ServiceBricks foundation.
The logging microservice provides logging support for any hosted application using the Microsoft.Extensions.Logging library.
It also provides web request logging functionality, so you can audit all url-based web requests and their properties coming into the application.
## Data Transfer Objects
### LogMessageDto - Admin Policy
Logging message storage object.
```csharp
public class LogMessageDto : DataTransferObject
{
public virtual DateTimeOffset CreateDate { get; set; }
public virtual string Application { get; set; }
public virtual string Server { get; set; }
public virtual string Category { get; set; }
public virtual string UserStorageKey { get; set; }
public virtual string Path { get; set; }
public virtual string Level { get; set; }
public virtual string Message { get; set; }
public virtual string Exception { get; set; }
public virtual string Properties { get; set; }
}
```
#### Business Rules
* DomainCreateDateRule - CreateDate property
### WebRequestMessageDto - Admin Policy
Used to store web request logging messages.
```csharp
public class WebRequestMessageDto : DataTransferObject
{
public DateTimeOffset CreateDate { get; set; }
public string RequestIPAddress { get; set; }
public string RequestProtocol { get; set; }
public string RequestScheme { get; set; }
public string RequestMethod { get; set; }
public string RequestBody { get; set; }
public string RequestPath { get; set; }
public string RequestPathBase { get; set; }
public string RequestQueryString { get; set; }
public string RequestQuery { get; set; }
public string RequestRouteValues { get; set; }
public string RequestHost { get; set; }
public bool? RequestHasFormContentType { get; set; }
public string RequestCookies { get; set; }
public string RequestContentType { get; set; }
public long? RequestContentLength { get; set; }
public string RequestHeaders { get; set; }
public bool? RequestIsHttps { get; set; }
public string RequestUserId { get; set; }
public int? ResponseStatusCode { get; set; }
public string ResponseHeaders { get; set; }
public string ResponseCookies { get; set; }
public string ResponseContentType { get; set; }
public long? ResponseContentLength { get; set; }
public long? ResponseTotalMilliseconds { get; set; }
public string ResponseBody { get; set; }
}
```
#### Business Rules
* DomainCreateDateRule - CreateDate property
## Background Tasks and Timers
### LoggingWriteMessageTimer class
This background timer runs by default every 1 second, with an initial delay of 1 second. Executes the LoggingWriteMessageTask.
[View Source](https://github.com/holomodular/ServiceBricks-Logging/blob/main/src/V1/ServiceBricks.Logging/BackgroundTask/LoggingWriteMessageTimer.cs)
### LoggingWriteMessageTask class
This background task pulls records off of custom logger inmemory queue and writes them to the ILogMessageAPIService.
[View Source](https://github.com/holomodular/ServiceBricks-Logging/blob/main/src/V1/ServiceBricks.Logging/BackgroundTask/LoggingWriteMessageTask.cs)
## Events
None
## Middleware
### CustomLoggerMiddleware
This middleware is responsible for plugging into the pipeline and storing minimal HttpRequest information (such as user, request path, etc) to store along with log messages.
In your program.cs file, add the custom logger with **AddServiceBricksLogging()** in the ConfigureLogging section.
```csharp
.ConfigureLogging((hostingContext, logging) =>
{
logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
logging.AddConsole();
logging.AddDebug();
logging.AddServiceBricksLogging();
})
```
The following code should be added to your web application's startup. This middleware should be added to the pipeline after UseAuth(), so that any authenticated user is available.
```csharp
app.UseMiddleware();
```
[View Source](https://github.com/holomodular/ServiceBricks-Logging/blob/main/src/V1/ServiceBricks.Logging/Middleware/CustomLoggerMiddleware.cs)
### WebRequestMessageMiddleware class
This middleware is responsible for plugging into the pipeline and pulling the HttpRequest and HttpResponse properties of the current web request and storing them for auditing purposes.
The following code should be added to your web application's startup.
This middleware should be added to the pipeline after UseAuth(), so that any authenticated user is available.
```csharp
app.UseMiddleware();
```
[View Source](https://github.com/holomodular/ServiceBricks-Logging/blob/main/src/V1/ServiceBricks.Logging/Middleware/WebRequestMessageMiddleware.cs)
## Processes
None
## Service Bus
### CreateApplicationLogBroadcast
This microservice subscribes to the CreateApplicationLogBroadcast message.
It is associated to the [CreateApplicationLogRule](https://github.com/holomodular/ServiceBricks-Logging/blob/main/src/V1/ServiceBricks.Logging/Rule/CreateApplicationLogRule.cs) Business Rule.
When receiving the message, it will simply create a record in storage.
```csharp
public class CreateApplicationLogBroadcast : DomainBroadcast
{
public CreateApplicationLogBroadcast(ApplicationLogDto obj)
{
DomainObject = obj;
}
}
```
## Additional
None
## Application Settings
```json
{
"Logging": {
"LogLevel": {
// Specify custom logging levels for components here
"Default": "Information",
"Microsoft": "Warning",
"Microsoft.AspNetCore": "Warning",
"Microsoft.Hosting.Lifetime": "Warning"
}
},
// ServiceBricks Root Configuration
"ServiceBricks": {
// Logging Microservice Settings
"Logging": {
// WebRequestMessageMiddleware options
"WebRequestMessage": {
"EnableLogging": true,
"EnableLocalIpRequests": true,
"EnableRequestIPAddress": true,
"EnableRequestBody": false,
"EnableRequestBodyOnError": true,
"EnableRequestProtocol": true,
"EnableRequestScheme": true,
"EnableRequestMethod": true,
"EnableRequestPath": true,
"EnableRequestPathBase": true,
"EnableRequestQueryString": true,
"EnableRequestQuery": false,
"EnableRequestRouteValues": false,
"EnableRequestHost": false,
"EnableRequestHasFormContentType": true,
"EnableRequestCookies": false,
"EnableRequestContentType": true,
"EnableRequestContentLength": true,
"EnableRequestHeaders": false,
"EnableRequestIsHttps": true,
"EnableRequestUserId": true,
"EnableResponseStatusCode": true,
"EnableResponseHeaders": false,
"EnableResponseCookies": false,
"EnableResponseContentType": true,
"EnableResponseContentLength": true,
"EnableResponseTotalMilliseconds": true,
"EnableResponseBody": false,
"EnableExcludeRequestPaths": true,
"ExcludeRequestPaths": [
"/css/",
"/img/",
"/js/",
"/lib/",
"/webfonts/"
]
}
}
}
}
```
# About ServiceBricks
ServiceBricks is the cornerstone for building a microservices foundation.
Visit http://ServiceBricks.com to learn more.