Skip to content

Commit

Permalink
Updated the generated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jonsagara
jonsagara committed Oct 23, 2023
1 parent 76c7a89 commit 95c0180
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 12 deletions.
12 changes: 12 additions & 0 deletions src/Sagara.Core.Caching/docs/Sagara.Core.Caching.RedisCacheLogger.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#### [Sagara.Core.Caching](index.md 'index')
### [Sagara.Core.Caching](index.md#Sagara.Core.Caching 'Sagara.Core.Caching')

## RedisCacheLogger Class

High-performance logging for ASP.NET Core. See: https://learn.microsoft.com/en-us/dotnet/core/extensions/logger-message-generator

```csharp
internal static class RedisCacheLogger
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 RedisCacheLogger
3 changes: 2 additions & 1 deletion src/Sagara.Core.Caching/docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,5 @@
any guarantee of ordered handling.
- **[RedisCacheExtensions](Sagara.Core.Caching.RedisCacheExtensions.md 'Sagara.Core.Caching.RedisCacheExtensions')** `Class`
- **[AddRedisAdminCacheSingleton(this IServiceCollection, string)](Sagara.Core.Caching.RedisCacheExtensions.md#Sagara.Core.Caching.RedisCacheExtensions.AddRedisAdminCacheSingleton(thisMicrosoft.Extensions.DependencyInjection.IServiceCollection,string) 'Sagara.Core.Caching.RedisCacheExtensions.AddRedisAdminCacheSingleton(this Microsoft.Extensions.DependencyInjection.IServiceCollection, string)')** `Method` Add a [RedisAdminCache](Sagara.Core.Caching.RedisAdminCache.md 'Sagara.Core.Caching.RedisAdminCache') instance as a singleton.
- **[AddRedisCacheSingleton(this IServiceCollection, string)](Sagara.Core.Caching.RedisCacheExtensions.md#Sagara.Core.Caching.RedisCacheExtensions.AddRedisCacheSingleton(thisMicrosoft.Extensions.DependencyInjection.IServiceCollection,string) 'Sagara.Core.Caching.RedisCacheExtensions.AddRedisCacheSingleton(this Microsoft.Extensions.DependencyInjection.IServiceCollection, string)')** `Method` Add a [RedisCache](Sagara.Core.Caching.RedisCache.md 'Sagara.Core.Caching.RedisCache') instance as a singleton.
- **[AddRedisCacheSingleton(this IServiceCollection, string)](Sagara.Core.Caching.RedisCacheExtensions.md#Sagara.Core.Caching.RedisCacheExtensions.AddRedisCacheSingleton(thisMicrosoft.Extensions.DependencyInjection.IServiceCollection,string) 'Sagara.Core.Caching.RedisCacheExtensions.AddRedisCacheSingleton(this Microsoft.Extensions.DependencyInjection.IServiceCollection, string)')** `Method` Add a [RedisCache](Sagara.Core.Caching.RedisCache.md 'Sagara.Core.Caching.RedisCache') instance as a singleton.
- **[RedisCacheLogger](Sagara.Core.Caching.RedisCacheLogger.md 'Sagara.Core.Caching.RedisCacheLogger')** `Class` High-performance logging for ASP.NET Core. See: https://learn.microsoft.com/en-us/dotnet/core/extensions/logger-message-generator
20 changes: 10 additions & 10 deletions ...gara.Core.Logging.Serilog/docs/Sagara.Core.Logging.Serilog.SerilogExtensions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,37 @@ public static class SerilogExtensions
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 SerilogExtensions
### Methods

<a name='Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.HostApplicationBuilder,System.Action_Microsoft.Extensions.Configuration.IConfiguration,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool)'></a>
<a name='Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.IHostApplicationBuilder,System.Action_Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool)'></a>

## SerilogExtensions.UseSerilog(this HostApplicationBuilder, Action<IConfiguration,IServiceProvider,LoggerConfiguration>, bool, bool) Method
## SerilogExtensions.UseSerilog(this IHostApplicationBuilder, Action<IHostApplicationBuilder,IServiceProvider,LoggerConfiguration>, bool, bool) Method

Sets Serilog as the logging provider.

```csharp
public static Microsoft.Extensions.Hosting.HostApplicationBuilder UseSerilog(this Microsoft.Extensions.Hosting.HostApplicationBuilder builder, System.Action<Microsoft.Extensions.Configuration.IConfiguration,System.IServiceProvider,Serilog.LoggerConfiguration> configureLogger, bool preserveStaticLogger=false, bool writeToProviders=false);
public static Microsoft.Extensions.Hosting.IHostApplicationBuilder UseSerilog(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, System.Action<Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.IServiceProvider,Serilog.LoggerConfiguration> configureLogger, bool preserveStaticLogger=false, bool writeToProviders=false);
```
#### Parameters

<a name='Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.HostApplicationBuilder,System.Action_Microsoft.Extensions.Configuration.IConfiguration,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool).builder'></a>
<a name='Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.IHostApplicationBuilder,System.Action_Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool).builder'></a>

`builder` [Microsoft.Extensions.Hosting.HostApplicationBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Hosting.HostApplicationBuilder 'Microsoft.Extensions.Hosting.HostApplicationBuilder')
`builder` [Microsoft.Extensions.Hosting.IHostApplicationBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Hosting.IHostApplicationBuilder 'Microsoft.Extensions.Hosting.IHostApplicationBuilder')
The [Microsoft.Extensions.Hosting.HostApplicationBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Hosting.HostApplicationBuilder 'Microsoft.Extensions.Hosting.HostApplicationBuilder') to configure.
<a name='Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.HostApplicationBuilder,System.Action_Microsoft.Extensions.Configuration.IConfiguration,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool).configureLogger'></a>
<a name='Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.IHostApplicationBuilder,System.Action_Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool).configureLogger'></a>

`configureLogger` [System.Action&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')[Microsoft.Extensions.Configuration.IConfiguration](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Configuration.IConfiguration 'Microsoft.Extensions.Configuration.IConfiguration')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')[System.IServiceProvider](https://docs.microsoft.com/en-us/dotnet/api/System.IServiceProvider 'System.IServiceProvider')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')[Serilog.LoggerConfiguration](https://docs.microsoft.com/en-us/dotnet/api/Serilog.LoggerConfiguration 'Serilog.LoggerConfiguration')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')
`configureLogger` [System.Action&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')[Microsoft.Extensions.Hosting.IHostApplicationBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Hosting.IHostApplicationBuilder 'Microsoft.Extensions.Hosting.IHostApplicationBuilder')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')[System.IServiceProvider](https://docs.microsoft.com/en-us/dotnet/api/System.IServiceProvider 'System.IServiceProvider')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')[Serilog.LoggerConfiguration](https://docs.microsoft.com/en-us/dotnet/api/Serilog.LoggerConfiguration 'Serilog.LoggerConfiguration')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')
The delegate for configuring the Serilog.LoggerConfiguration that will be used
to construct a Serilog.Core.Logger.

<a name='Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.HostApplicationBuilder,System.Action_Microsoft.Extensions.Configuration.IConfiguration,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool).preserveStaticLogger'></a>
<a name='Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.IHostApplicationBuilder,System.Action_Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool).preserveStaticLogger'></a>

`preserveStaticLogger` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')
Indicates whether to preserve the value of Serilog.Log.Logger.

<a name='Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.HostApplicationBuilder,System.Action_Microsoft.Extensions.Configuration.IConfiguration,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool).writeToProviders'></a>
<a name='Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.IHostApplicationBuilder,System.Action_Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool).writeToProviders'></a>

`writeToProviders` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')
Expand All @@ -49,7 +49,7 @@ By default, Serilog does not write events to Microsoft.Extensions.Logging.ILogge
Specify true to write events to all providers.

#### Returns
[Microsoft.Extensions.Hosting.HostApplicationBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Hosting.HostApplicationBuilder 'Microsoft.Extensions.Hosting.HostApplicationBuilder')
[Microsoft.Extensions.Hosting.IHostApplicationBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Hosting.IHostApplicationBuilder 'Microsoft.Extensions.Hosting.IHostApplicationBuilder')
The host application builder.

### Remarks
Expand Down
2 changes: 1 addition & 1 deletion src/Sagara.Core.Logging.Serilog/docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@
- **[LoggerEnrichmentProperties](Sagara.Core.Logging.Serilog.LoggerEnrichmentProperties.md 'Sagara.Core.Logging.Serilog.LoggerEnrichmentProperties')** `Class` Constants to use when configuring Serilog enrichers.
- **[Assembly](Sagara.Core.Logging.Serilog.LoggerEnrichmentProperties.md#Sagara.Core.Logging.Serilog.LoggerEnrichmentProperties.Assembly 'Sagara.Core.Logging.Serilog.LoggerEnrichmentProperties.Assembly')** `Field` Use the assembly name as a Serilog enrichment property.
- **[SerilogExtensions](Sagara.Core.Logging.Serilog.SerilogExtensions.md 'Sagara.Core.Logging.Serilog.SerilogExtensions')** `Class`
- **[UseSerilog(this HostApplicationBuilder, Action&lt;IConfiguration,IServiceProvider,LoggerConfiguration&gt;, bool, bool)](Sagara.Core.Logging.Serilog.SerilogExtensions.md#Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.HostApplicationBuilder,System.Action_Microsoft.Extensions.Configuration.IConfiguration,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool) 'Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(this Microsoft.Extensions.Hosting.HostApplicationBuilder, System.Action<Microsoft.Extensions.Configuration.IConfiguration,System.IServiceProvider,Serilog.LoggerConfiguration>, bool, bool)')** `Method` Sets Serilog as the logging provider.
- **[UseSerilog(this IHostApplicationBuilder, Action&lt;IHostApplicationBuilder,IServiceProvider,LoggerConfiguration&gt;, bool, bool)](Sagara.Core.Logging.Serilog.SerilogExtensions.md#Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(thisMicrosoft.Extensions.Hosting.IHostApplicationBuilder,System.Action_Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.IServiceProvider,Serilog.LoggerConfiguration_,bool,bool) 'Sagara.Core.Logging.Serilog.SerilogExtensions.UseSerilog(this Microsoft.Extensions.Hosting.IHostApplicationBuilder, System.Action<Microsoft.Extensions.Hosting.IHostApplicationBuilder,System.IServiceProvider,Serilog.LoggerConfiguration>, bool, bool)')** `Method` Sets Serilog as the logging provider.
- **[UtcTimestampEnricher](Sagara.Core.Logging.Serilog.UtcTimestampEnricher.md 'Sagara.Core.Logging.Serilog.UtcTimestampEnricher')** `Class` Serilog enricher that converts the log event's timestamp to UTC.
- **[Enrich(LogEvent, ILogEventPropertyFactory)](Sagara.Core.Logging.Serilog.UtcTimestampEnricher.md#Sagara.Core.Logging.Serilog.UtcTimestampEnricher.Enrich(Serilog.Events.LogEvent,Serilog.Core.ILogEventPropertyFactory) 'Sagara.Core.Logging.Serilog.UtcTimestampEnricher.Enrich(Serilog.Events.LogEvent, Serilog.Core.ILogEventPropertyFactory)')** `Method` Enrich the log event with a UTC timestamp.

0 comments on commit 95c0180

Please sign in to comment.