This commit is contained in:
master
5
local-nuget/serilog.sinks.console/5.0.0/.nupkg.metadata
Normal file
5
local-nuget/serilog.sinks.console/5.0.0/.nupkg.metadata
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "IZ6bn79k+3SRXOBpwSOClUHikSkp2toGPCZ0teUkscv4dpDg9E2R2xVsNkLmwddE4OpNVO3N0xiYsAH556vN8Q==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
local-nuget/serilog.sinks.console/5.0.0/.signature.p7s
Normal file
BIN
local-nuget/serilog.sinks.console/5.0.0/.signature.p7s
Normal file
Binary file not shown.
187
local-nuget/serilog.sinks.console/5.0.0/README.md
Normal file
187
local-nuget/serilog.sinks.console/5.0.0/README.md
Normal file
@@ -0,0 +1,187 @@
|
||||
# Serilog.Sinks.Console [](https://ci.appveyor.com/project/serilog/serilog-sinks-console/branch/master) [](https://www.nuget.org/packages/Serilog.Sinks.Console/) [](https://github.com/serilog/serilog/wiki) [](https://gitter.im/serilog/serilog) [](http://stackoverflow.com/questions/tagged/serilog)
|
||||
|
||||
A Serilog sink that writes log events to the Windows Console or an ANSI terminal via standard output. Coloring and custom themes are supported, including ANSI 256-color themes on macOS, Linux and Windows 10. The default output is plain text; JSON formatting can be plugged in using a package such as [_Serilog.Formatting.Compact_](https://github.com/serilog/serilog-formatting-compact).
|
||||
|
||||
### Getting started
|
||||
|
||||
To use the console sink, first install the [NuGet package](https://nuget.org/packages/serilog.sinks.console):
|
||||
|
||||
```shell
|
||||
dotnet add package Serilog.Sinks.Console
|
||||
```
|
||||
|
||||
Then enable the sink using `WriteTo.Console()`:
|
||||
|
||||
```csharp
|
||||
Log.Logger = new LoggerConfiguration()
|
||||
.WriteTo.Console()
|
||||
.CreateLogger();
|
||||
|
||||
Log.Information("Hello, world!");
|
||||
```
|
||||
|
||||
Log events will be printed to `STDOUT`:
|
||||
|
||||
```
|
||||
[12:50:51 INF] Hello, world!
|
||||
```
|
||||
|
||||
### Themes
|
||||
|
||||
The sink will colorize output by default:
|
||||
|
||||
|
||||
|
||||
Themes can be specified when configuring the sink:
|
||||
|
||||
```csharp
|
||||
.WriteTo.Console(theme: AnsiConsoleTheme.Code)
|
||||
```
|
||||
|
||||
The following built-in themes are available:
|
||||
|
||||
* `ConsoleTheme.None` - no styling
|
||||
* `SystemConsoleTheme.Literate` - styled to replicate _Serilog.Sinks.Literate_, using the `System.Console` coloring modes supported on all Windows/.NET targets; **this is the default when no theme is specified**
|
||||
* `SystemConsoleTheme.Grayscale` - a theme using only shades of gray, white, and black
|
||||
* `AnsiConsoleTheme.Literate` - an ANSI 256-color version of the "literate" theme
|
||||
* `AnsiConsoleTheme.Grayscale` - an ANSI 256-color version of the "grayscale" theme
|
||||
* `AnsiConsoleTheme.Code` - an ANSI 256-color Visual Studio Code-inspired theme
|
||||
* `AnsiConsoleTheme.Sixteen` - an ANSI 16-color theme that works well with both light and dark backgrounds
|
||||
|
||||
Adding a new theme is straightforward; examples can be found in the [`SystemConsoleThemes`](https://github.com/serilog/serilog-sinks-console/blob/dev/src/Serilog.Sinks.Console/Sinks/SystemConsole/Themes/SystemConsoleThemes.cs) and [`AnsiConsoleThemes`](https://github.com/serilog/serilog-sinks-console/blob/dev/src/Serilog.Sinks.Console/Sinks/SystemConsole/Themes/AnsiConsoleThemes.cs) classes.
|
||||
|
||||
### Output templates
|
||||
|
||||
The format of events to the console can be modified using the `outputTemplate` configuration parameter:
|
||||
|
||||
```csharp
|
||||
.WriteTo.Console(
|
||||
outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}")
|
||||
```
|
||||
|
||||
The default template, shown in the example above, uses built-in properties like `Timestamp` and `Level`. Properties from events, including those attached using [enrichers](https://github.com/serilog/serilog/wiki/Enrichment), can also appear in the output template.
|
||||
|
||||
### JSON output
|
||||
|
||||
The sink can write JSON output instead of plain text. `CompactJsonFormatter` or `RenderedCompactJsonFormatter` from [Serilog.Formatting.Compact](https://github.com/serilog/serilog-formatting-compact) is recommended:
|
||||
|
||||
```shell
|
||||
dotnet add package Serilog.Formatting.Compact
|
||||
```
|
||||
|
||||
Pass a formatter to the `Console()` configuration method:
|
||||
|
||||
```csharp
|
||||
.WriteTo.Console(new RenderedCompactJsonFormatter())
|
||||
```
|
||||
|
||||
Output theming is not available when custom formatters are used.
|
||||
|
||||
### XML `<appSettings>` configuration
|
||||
|
||||
To use the console sink with the [Serilog.Settings.AppSettings](https://github.com/serilog/serilog-settings-appsettings) package, first install that package if you haven't already done so:
|
||||
|
||||
```shell
|
||||
dotnet add package Serilog.Settings.AppSettings
|
||||
```
|
||||
|
||||
Instead of configuring the logger in code, call `ReadFrom.AppSettings()`:
|
||||
|
||||
```csharp
|
||||
var log = new LoggerConfiguration()
|
||||
.ReadFrom.AppSettings()
|
||||
.CreateLogger();
|
||||
```
|
||||
|
||||
In your application's `App.config` or `Web.config` file, specify the console sink assembly under the `<appSettings>` node:
|
||||
|
||||
```xml
|
||||
<configuration>
|
||||
<appSettings>
|
||||
<add key="serilog:using:Console" value="Serilog.Sinks.Console" />
|
||||
<add key="serilog:write-to:Console" />
|
||||
```
|
||||
|
||||
To configure the console sink with a different theme and include the `SourceContext` in the output, change your `App.config`/`Web.config` to:
|
||||
```xml
|
||||
<configuration>
|
||||
<appSettings>
|
||||
<add key="serilog:using:Console" value="Serilog.Sinks.Console" />
|
||||
<add key="serilog:write-to:Console.theme" value="Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console" />
|
||||
<add key="serilog:write-to:Console.outputTemplate" value="[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} <s:{SourceContext}>{NewLine}{Exception}" />
|
||||
```
|
||||
|
||||
### JSON `appsettings.json` configuration
|
||||
|
||||
To use the console sink with _Microsoft.Extensions.Configuration_, for example with ASP.NET Core or .NET Core, use the [Serilog.Settings.Configuration](https://github.com/serilog/serilog-settings-configuration) package. First install that package if you have not already done so:
|
||||
|
||||
```shell
|
||||
dotnet add package Serilog.Settings.Configuration
|
||||
```
|
||||
|
||||
Instead of configuring the sink directly in code, call `ReadFrom.Configuration()`:
|
||||
|
||||
```csharp
|
||||
var configuration = new ConfigurationBuilder()
|
||||
.AddJsonFile("appsettings.json")
|
||||
.Build();
|
||||
|
||||
var logger = new LoggerConfiguration()
|
||||
.ReadFrom.Configuration(configuration)
|
||||
.CreateLogger();
|
||||
```
|
||||
|
||||
In your `appsettings.json` file, under the `Serilog` node, :
|
||||
```json
|
||||
{
|
||||
"Serilog": {
|
||||
"WriteTo": [{"Name": "Console"}]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
To configure the console sink with a different theme and include the `SourceContext` in the output, change your `appsettings.json` to:
|
||||
```json
|
||||
{
|
||||
"Serilog": {
|
||||
"WriteTo": [
|
||||
{
|
||||
"Name": "Console",
|
||||
"Args": {
|
||||
"theme": "Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console",
|
||||
"outputTemplate": "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj} <s:{SourceContext}>{NewLine}{Exception}"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Performance
|
||||
|
||||
Console logging is synchronous and this can cause bottlenecks in some deployment scenarios. For high-volume console logging, consider using [_Serilog.Sinks.Async_](https://github.com/serilog/serilog-sinks-async) to move console writes to a background thread:
|
||||
|
||||
```csharp
|
||||
// dotnet add package serilog.sinks.async
|
||||
|
||||
Log.Logger = new LoggerConfiguration()
|
||||
.WriteTo.Async(wt => wt.Console())
|
||||
.CreateLogger();
|
||||
```
|
||||
|
||||
### Contributing
|
||||
|
||||
Would you like to help make the Serilog console sink even better? We keep a list of issues that are approachable for newcomers under the [up-for-grabs](https://github.com/serilog/serilog-sinks-console/issues?labels=up-for-grabs&state=open) label. Before starting work on a pull request, we suggest commenting on, or raising, an issue on the issue tracker so that we can help and coordinate efforts. For more details check out our [contributing guide](CONTRIBUTING.md).
|
||||
|
||||
When contributing please keep in mind our [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
|
||||
### Detailed build status
|
||||
|
||||
Branch | AppVeyor | Travis
|
||||
------------- | ------------- |-------------
|
||||
dev | [](https://ci.appveyor.com/project/serilog/serilog-sinks-console/branch/dev) | [](https://travis-ci.org/serilog/serilog-sinks-console)
|
||||
main | [](https://ci.appveyor.com/project/serilog/serilog-sinks-console/branch/main) | [](https://travis-ci.org/serilog/serilog-sinks-console)
|
||||
|
||||
|
||||
_Copyright © Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html)._
|
||||
@@ -0,0 +1,39 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Serilog.Sinks.Console</id>
|
||||
<version>5.0.0</version>
|
||||
<authors>Serilog Contributors</authors>
|
||||
<license type="expression">Apache-2.0</license>
|
||||
<licenseUrl>https://licenses.nuget.org/Apache-2.0</licenseUrl>
|
||||
<icon>icon.png</icon>
|
||||
<readme>README.md</readme>
|
||||
<projectUrl>https://github.com/serilog/serilog-sinks-console</projectUrl>
|
||||
<description>A Serilog sink that writes log events to the console/terminal.</description>
|
||||
<tags>serilog console terminal</tags>
|
||||
<repository type="git" url="https://github.com/serilog/serilog-sinks-console" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2">
|
||||
<dependency id="Serilog" version="3.1.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETFramework4.7.1">
|
||||
<dependency id="Serilog" version="3.1.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net5.0">
|
||||
<dependency id="Serilog" version="3.1.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net6.0">
|
||||
<dependency id="Serilog" version="3.1.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net7.0">
|
||||
<dependency id="Serilog" version="3.1.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Serilog" version="3.1.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.1">
|
||||
<dependency id="Serilog" version="3.1.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
BIN
local-nuget/serilog.sinks.console/5.0.0/icon.png
Normal file
BIN
local-nuget/serilog.sinks.console/5.0.0/icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
@@ -0,0 +1,357 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Sinks.Console</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConsoleAuditLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the AuditTo.Console() extension method to <see cref="T:Serilog.Configuration.LoggerAuditSinkConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.ConsoleLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the WriteTo.Console() extension method to <see cref="T:Serilog.LoggerConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Output.LevelOutputFormat">
|
||||
<summary>
|
||||
Implements the {Level} element.
|
||||
can now have a fixed width applied to it, as well as casing rules.
|
||||
Width is set through formats like "u3" (uppercase three chars),
|
||||
"w1" (one lowercase char), or "t4" (title case four chars).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Casing.Format(System.String,System.String)">
|
||||
<summary>
|
||||
Apply upper or lower casing to <paramref name="value"/> when <paramref name="format"/> is provided.
|
||||
Returns <paramref name="value"/> when no or invalid format provided.
|
||||
</summary>
|
||||
<param name="value">Provided string for formatting.</param>
|
||||
<param name="format">Format string.</param>
|
||||
<returns>The provided <paramref name="value"/> with formatting applied.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Padding.Apply(System.IO.TextWriter,System.String,System.Nullable{Serilog.Parsing.Alignment})">
|
||||
<summary>
|
||||
Writes the provided value to the output, applying direction-based padding when <paramref name="alignment"/> is provided.
|
||||
</summary>
|
||||
<param name="output">Output object to write result.</param>
|
||||
<param name="value">Provided value.</param>
|
||||
<param name="alignment">The alignment settings to apply when rendering <paramref name="value"/>.</param>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the ANSI terminal escape sequences. Recommended
|
||||
for Linux and Windows 10+.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Code">
|
||||
<summary>
|
||||
A 256-color theme along the lines of Visual Studio Code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Sixteen">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i> using only standard 16 terminal colors that will work on light backgrounds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,System.String})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme">
|
||||
<summary>
|
||||
The base class for styled terminal output.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.None">
|
||||
<summary>
|
||||
No styling applied.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.CanBuffer">
|
||||
<summary>
|
||||
True if styling applied by the theme is written into the output, and can thus be
|
||||
buffered and measured.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<summary>
|
||||
Begin a span of text in the specified <paramref name="style"/>.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
<param name="style">Style to apply.</param>
|
||||
<returns> The number of characters written to <paramref name="output"/>. </returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<summary>
|
||||
Reset the output to un-styled colors.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.ResetCharCount">
|
||||
<summary>
|
||||
The number of characters written by the <see cref="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)"/> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle">
|
||||
<summary>
|
||||
Elements styled by a console theme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Text">
|
||||
<summary>
|
||||
Prominent text, generally content within an event's message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.SecondaryText">
|
||||
<summary>
|
||||
Boilerplate text, for example items specified in an output template.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.TertiaryText">
|
||||
<summary>
|
||||
De-emphasized text, for example literal text in output templates and
|
||||
punctuation used when writing structured data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Invalid">
|
||||
<summary>
|
||||
Output demonstrating some kind of configuration issue, e.g. an invalid
|
||||
message template token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Null">
|
||||
<summary>
|
||||
The built-in <see langword="null"/> value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Name">
|
||||
<summary>
|
||||
Property and type names.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.String">
|
||||
<summary>
|
||||
Strings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Number">
|
||||
<summary>
|
||||
Numbers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Boolean">
|
||||
<summary>
|
||||
<see cref="T:System.Boolean"/> values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Scalar">
|
||||
<summary>
|
||||
All other scalar values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Object">
|
||||
<summary>
|
||||
Unrecognized literal values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelVerbose">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelDebug">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelInformation">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelWarning">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelError">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelFatal">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the styling facilities of the <see cref="T:System.Console"/> class. Recommended
|
||||
for Windows versions prior to Windows 10.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Colored">
|
||||
<summary>
|
||||
A theme based on the original Serilog "colored console" sink.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Styles">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle">
|
||||
<summary>
|
||||
Styling applied using the <see cref="T:System.ConsoleColor"/> enumeration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Foreground">
|
||||
<summary>
|
||||
The foreground color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Background">
|
||||
<summary>
|
||||
The background color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,357 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Sinks.Console</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConsoleAuditLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the AuditTo.Console() extension method to <see cref="T:Serilog.Configuration.LoggerAuditSinkConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.ConsoleLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the WriteTo.Console() extension method to <see cref="T:Serilog.LoggerConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Output.LevelOutputFormat">
|
||||
<summary>
|
||||
Implements the {Level} element.
|
||||
can now have a fixed width applied to it, as well as casing rules.
|
||||
Width is set through formats like "u3" (uppercase three chars),
|
||||
"w1" (one lowercase char), or "t4" (title case four chars).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Casing.Format(System.String,System.String)">
|
||||
<summary>
|
||||
Apply upper or lower casing to <paramref name="value"/> when <paramref name="format"/> is provided.
|
||||
Returns <paramref name="value"/> when no or invalid format provided.
|
||||
</summary>
|
||||
<param name="value">Provided string for formatting.</param>
|
||||
<param name="format">Format string.</param>
|
||||
<returns>The provided <paramref name="value"/> with formatting applied.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Padding.Apply(System.IO.TextWriter,System.String,System.Nullable{Serilog.Parsing.Alignment})">
|
||||
<summary>
|
||||
Writes the provided value to the output, applying direction-based padding when <paramref name="alignment"/> is provided.
|
||||
</summary>
|
||||
<param name="output">Output object to write result.</param>
|
||||
<param name="value">Provided value.</param>
|
||||
<param name="alignment">The alignment settings to apply when rendering <paramref name="value"/>.</param>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the ANSI terminal escape sequences. Recommended
|
||||
for Linux and Windows 10+.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Code">
|
||||
<summary>
|
||||
A 256-color theme along the lines of Visual Studio Code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Sixteen">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i> using only standard 16 terminal colors that will work on light backgrounds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,System.String})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme">
|
||||
<summary>
|
||||
The base class for styled terminal output.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.None">
|
||||
<summary>
|
||||
No styling applied.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.CanBuffer">
|
||||
<summary>
|
||||
True if styling applied by the theme is written into the output, and can thus be
|
||||
buffered and measured.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<summary>
|
||||
Begin a span of text in the specified <paramref name="style"/>.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
<param name="style">Style to apply.</param>
|
||||
<returns> The number of characters written to <paramref name="output"/>. </returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<summary>
|
||||
Reset the output to un-styled colors.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.ResetCharCount">
|
||||
<summary>
|
||||
The number of characters written by the <see cref="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)"/> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle">
|
||||
<summary>
|
||||
Elements styled by a console theme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Text">
|
||||
<summary>
|
||||
Prominent text, generally content within an event's message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.SecondaryText">
|
||||
<summary>
|
||||
Boilerplate text, for example items specified in an output template.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.TertiaryText">
|
||||
<summary>
|
||||
De-emphasized text, for example literal text in output templates and
|
||||
punctuation used when writing structured data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Invalid">
|
||||
<summary>
|
||||
Output demonstrating some kind of configuration issue, e.g. an invalid
|
||||
message template token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Null">
|
||||
<summary>
|
||||
The built-in <see langword="null"/> value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Name">
|
||||
<summary>
|
||||
Property and type names.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.String">
|
||||
<summary>
|
||||
Strings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Number">
|
||||
<summary>
|
||||
Numbers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Boolean">
|
||||
<summary>
|
||||
<see cref="T:System.Boolean"/> values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Scalar">
|
||||
<summary>
|
||||
All other scalar values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Object">
|
||||
<summary>
|
||||
Unrecognized literal values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelVerbose">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelDebug">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelInformation">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelWarning">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelError">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelFatal">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the styling facilities of the <see cref="T:System.Console"/> class. Recommended
|
||||
for Windows versions prior to Windows 10.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Colored">
|
||||
<summary>
|
||||
A theme based on the original Serilog "colored console" sink.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Styles">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle">
|
||||
<summary>
|
||||
Styling applied using the <see cref="T:System.ConsoleColor"/> enumeration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Foreground">
|
||||
<summary>
|
||||
The foreground color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Background">
|
||||
<summary>
|
||||
The background color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,357 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Sinks.Console</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConsoleAuditLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the AuditTo.Console() extension method to <see cref="T:Serilog.Configuration.LoggerAuditSinkConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.ConsoleLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the WriteTo.Console() extension method to <see cref="T:Serilog.LoggerConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Output.LevelOutputFormat">
|
||||
<summary>
|
||||
Implements the {Level} element.
|
||||
can now have a fixed width applied to it, as well as casing rules.
|
||||
Width is set through formats like "u3" (uppercase three chars),
|
||||
"w1" (one lowercase char), or "t4" (title case four chars).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Casing.Format(System.String,System.String)">
|
||||
<summary>
|
||||
Apply upper or lower casing to <paramref name="value"/> when <paramref name="format"/> is provided.
|
||||
Returns <paramref name="value"/> when no or invalid format provided.
|
||||
</summary>
|
||||
<param name="value">Provided string for formatting.</param>
|
||||
<param name="format">Format string.</param>
|
||||
<returns>The provided <paramref name="value"/> with formatting applied.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Padding.Apply(System.IO.TextWriter,System.String,System.Nullable{Serilog.Parsing.Alignment})">
|
||||
<summary>
|
||||
Writes the provided value to the output, applying direction-based padding when <paramref name="alignment"/> is provided.
|
||||
</summary>
|
||||
<param name="output">Output object to write result.</param>
|
||||
<param name="value">Provided value.</param>
|
||||
<param name="alignment">The alignment settings to apply when rendering <paramref name="value"/>.</param>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the ANSI terminal escape sequences. Recommended
|
||||
for Linux and Windows 10+.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Code">
|
||||
<summary>
|
||||
A 256-color theme along the lines of Visual Studio Code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Sixteen">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i> using only standard 16 terminal colors that will work on light backgrounds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,System.String})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme">
|
||||
<summary>
|
||||
The base class for styled terminal output.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.None">
|
||||
<summary>
|
||||
No styling applied.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.CanBuffer">
|
||||
<summary>
|
||||
True if styling applied by the theme is written into the output, and can thus be
|
||||
buffered and measured.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<summary>
|
||||
Begin a span of text in the specified <paramref name="style"/>.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
<param name="style">Style to apply.</param>
|
||||
<returns> The number of characters written to <paramref name="output"/>. </returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<summary>
|
||||
Reset the output to un-styled colors.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.ResetCharCount">
|
||||
<summary>
|
||||
The number of characters written by the <see cref="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)"/> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle">
|
||||
<summary>
|
||||
Elements styled by a console theme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Text">
|
||||
<summary>
|
||||
Prominent text, generally content within an event's message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.SecondaryText">
|
||||
<summary>
|
||||
Boilerplate text, for example items specified in an output template.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.TertiaryText">
|
||||
<summary>
|
||||
De-emphasized text, for example literal text in output templates and
|
||||
punctuation used when writing structured data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Invalid">
|
||||
<summary>
|
||||
Output demonstrating some kind of configuration issue, e.g. an invalid
|
||||
message template token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Null">
|
||||
<summary>
|
||||
The built-in <see langword="null"/> value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Name">
|
||||
<summary>
|
||||
Property and type names.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.String">
|
||||
<summary>
|
||||
Strings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Number">
|
||||
<summary>
|
||||
Numbers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Boolean">
|
||||
<summary>
|
||||
<see cref="T:System.Boolean"/> values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Scalar">
|
||||
<summary>
|
||||
All other scalar values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Object">
|
||||
<summary>
|
||||
Unrecognized literal values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelVerbose">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelDebug">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelInformation">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelWarning">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelError">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelFatal">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the styling facilities of the <see cref="T:System.Console"/> class. Recommended
|
||||
for Windows versions prior to Windows 10.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Colored">
|
||||
<summary>
|
||||
A theme based on the original Serilog "colored console" sink.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Styles">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle">
|
||||
<summary>
|
||||
Styling applied using the <see cref="T:System.ConsoleColor"/> enumeration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Foreground">
|
||||
<summary>
|
||||
The foreground color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Background">
|
||||
<summary>
|
||||
The background color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,357 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Sinks.Console</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConsoleAuditLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the AuditTo.Console() extension method to <see cref="T:Serilog.Configuration.LoggerAuditSinkConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.ConsoleLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the WriteTo.Console() extension method to <see cref="T:Serilog.LoggerConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Output.LevelOutputFormat">
|
||||
<summary>
|
||||
Implements the {Level} element.
|
||||
can now have a fixed width applied to it, as well as casing rules.
|
||||
Width is set through formats like "u3" (uppercase three chars),
|
||||
"w1" (one lowercase char), or "t4" (title case four chars).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Casing.Format(System.String,System.String)">
|
||||
<summary>
|
||||
Apply upper or lower casing to <paramref name="value"/> when <paramref name="format"/> is provided.
|
||||
Returns <paramref name="value"/> when no or invalid format provided.
|
||||
</summary>
|
||||
<param name="value">Provided string for formatting.</param>
|
||||
<param name="format">Format string.</param>
|
||||
<returns>The provided <paramref name="value"/> with formatting applied.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Padding.Apply(System.IO.TextWriter,System.String,System.Nullable{Serilog.Parsing.Alignment})">
|
||||
<summary>
|
||||
Writes the provided value to the output, applying direction-based padding when <paramref name="alignment"/> is provided.
|
||||
</summary>
|
||||
<param name="output">Output object to write result.</param>
|
||||
<param name="value">Provided value.</param>
|
||||
<param name="alignment">The alignment settings to apply when rendering <paramref name="value"/>.</param>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the ANSI terminal escape sequences. Recommended
|
||||
for Linux and Windows 10+.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Code">
|
||||
<summary>
|
||||
A 256-color theme along the lines of Visual Studio Code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Sixteen">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i> using only standard 16 terminal colors that will work on light backgrounds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,System.String})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme">
|
||||
<summary>
|
||||
The base class for styled terminal output.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.None">
|
||||
<summary>
|
||||
No styling applied.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.CanBuffer">
|
||||
<summary>
|
||||
True if styling applied by the theme is written into the output, and can thus be
|
||||
buffered and measured.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<summary>
|
||||
Begin a span of text in the specified <paramref name="style"/>.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
<param name="style">Style to apply.</param>
|
||||
<returns> The number of characters written to <paramref name="output"/>. </returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<summary>
|
||||
Reset the output to un-styled colors.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.ResetCharCount">
|
||||
<summary>
|
||||
The number of characters written by the <see cref="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)"/> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle">
|
||||
<summary>
|
||||
Elements styled by a console theme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Text">
|
||||
<summary>
|
||||
Prominent text, generally content within an event's message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.SecondaryText">
|
||||
<summary>
|
||||
Boilerplate text, for example items specified in an output template.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.TertiaryText">
|
||||
<summary>
|
||||
De-emphasized text, for example literal text in output templates and
|
||||
punctuation used when writing structured data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Invalid">
|
||||
<summary>
|
||||
Output demonstrating some kind of configuration issue, e.g. an invalid
|
||||
message template token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Null">
|
||||
<summary>
|
||||
The built-in <see langword="null"/> value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Name">
|
||||
<summary>
|
||||
Property and type names.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.String">
|
||||
<summary>
|
||||
Strings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Number">
|
||||
<summary>
|
||||
Numbers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Boolean">
|
||||
<summary>
|
||||
<see cref="T:System.Boolean"/> values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Scalar">
|
||||
<summary>
|
||||
All other scalar values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Object">
|
||||
<summary>
|
||||
Unrecognized literal values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelVerbose">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelDebug">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelInformation">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelWarning">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelError">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelFatal">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the styling facilities of the <see cref="T:System.Console"/> class. Recommended
|
||||
for Windows versions prior to Windows 10.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Colored">
|
||||
<summary>
|
||||
A theme based on the original Serilog "colored console" sink.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Styles">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle">
|
||||
<summary>
|
||||
Styling applied using the <see cref="T:System.ConsoleColor"/> enumeration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Foreground">
|
||||
<summary>
|
||||
The foreground color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Background">
|
||||
<summary>
|
||||
The background color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,357 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Sinks.Console</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConsoleAuditLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the AuditTo.Console() extension method to <see cref="T:Serilog.Configuration.LoggerAuditSinkConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.ConsoleLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the WriteTo.Console() extension method to <see cref="T:Serilog.LoggerConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Output.LevelOutputFormat">
|
||||
<summary>
|
||||
Implements the {Level} element.
|
||||
can now have a fixed width applied to it, as well as casing rules.
|
||||
Width is set through formats like "u3" (uppercase three chars),
|
||||
"w1" (one lowercase char), or "t4" (title case four chars).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Casing.Format(System.String,System.String)">
|
||||
<summary>
|
||||
Apply upper or lower casing to <paramref name="value"/> when <paramref name="format"/> is provided.
|
||||
Returns <paramref name="value"/> when no or invalid format provided.
|
||||
</summary>
|
||||
<param name="value">Provided string for formatting.</param>
|
||||
<param name="format">Format string.</param>
|
||||
<returns>The provided <paramref name="value"/> with formatting applied.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Padding.Apply(System.IO.TextWriter,System.String,System.Nullable{Serilog.Parsing.Alignment})">
|
||||
<summary>
|
||||
Writes the provided value to the output, applying direction-based padding when <paramref name="alignment"/> is provided.
|
||||
</summary>
|
||||
<param name="output">Output object to write result.</param>
|
||||
<param name="value">Provided value.</param>
|
||||
<param name="alignment">The alignment settings to apply when rendering <paramref name="value"/>.</param>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the ANSI terminal escape sequences. Recommended
|
||||
for Linux and Windows 10+.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Code">
|
||||
<summary>
|
||||
A 256-color theme along the lines of Visual Studio Code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Sixteen">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i> using only standard 16 terminal colors that will work on light backgrounds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,System.String})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme">
|
||||
<summary>
|
||||
The base class for styled terminal output.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.None">
|
||||
<summary>
|
||||
No styling applied.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.CanBuffer">
|
||||
<summary>
|
||||
True if styling applied by the theme is written into the output, and can thus be
|
||||
buffered and measured.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<summary>
|
||||
Begin a span of text in the specified <paramref name="style"/>.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
<param name="style">Style to apply.</param>
|
||||
<returns> The number of characters written to <paramref name="output"/>. </returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<summary>
|
||||
Reset the output to un-styled colors.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.ResetCharCount">
|
||||
<summary>
|
||||
The number of characters written by the <see cref="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)"/> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle">
|
||||
<summary>
|
||||
Elements styled by a console theme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Text">
|
||||
<summary>
|
||||
Prominent text, generally content within an event's message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.SecondaryText">
|
||||
<summary>
|
||||
Boilerplate text, for example items specified in an output template.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.TertiaryText">
|
||||
<summary>
|
||||
De-emphasized text, for example literal text in output templates and
|
||||
punctuation used when writing structured data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Invalid">
|
||||
<summary>
|
||||
Output demonstrating some kind of configuration issue, e.g. an invalid
|
||||
message template token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Null">
|
||||
<summary>
|
||||
The built-in <see langword="null"/> value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Name">
|
||||
<summary>
|
||||
Property and type names.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.String">
|
||||
<summary>
|
||||
Strings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Number">
|
||||
<summary>
|
||||
Numbers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Boolean">
|
||||
<summary>
|
||||
<see cref="T:System.Boolean"/> values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Scalar">
|
||||
<summary>
|
||||
All other scalar values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Object">
|
||||
<summary>
|
||||
Unrecognized literal values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelVerbose">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelDebug">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelInformation">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelWarning">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelError">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelFatal">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the styling facilities of the <see cref="T:System.Console"/> class. Recommended
|
||||
for Windows versions prior to Windows 10.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Colored">
|
||||
<summary>
|
||||
A theme based on the original Serilog "colored console" sink.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Styles">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle">
|
||||
<summary>
|
||||
Styling applied using the <see cref="T:System.ConsoleColor"/> enumeration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Foreground">
|
||||
<summary>
|
||||
The foreground color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Background">
|
||||
<summary>
|
||||
The background color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,357 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Sinks.Console</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConsoleAuditLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the AuditTo.Console() extension method to <see cref="T:Serilog.Configuration.LoggerAuditSinkConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.ConsoleLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the WriteTo.Console() extension method to <see cref="T:Serilog.LoggerConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Output.LevelOutputFormat">
|
||||
<summary>
|
||||
Implements the {Level} element.
|
||||
can now have a fixed width applied to it, as well as casing rules.
|
||||
Width is set through formats like "u3" (uppercase three chars),
|
||||
"w1" (one lowercase char), or "t4" (title case four chars).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Casing.Format(System.String,System.String)">
|
||||
<summary>
|
||||
Apply upper or lower casing to <paramref name="value"/> when <paramref name="format"/> is provided.
|
||||
Returns <paramref name="value"/> when no or invalid format provided.
|
||||
</summary>
|
||||
<param name="value">Provided string for formatting.</param>
|
||||
<param name="format">Format string.</param>
|
||||
<returns>The provided <paramref name="value"/> with formatting applied.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Padding.Apply(System.IO.TextWriter,System.String,System.Nullable{Serilog.Parsing.Alignment})">
|
||||
<summary>
|
||||
Writes the provided value to the output, applying direction-based padding when <paramref name="alignment"/> is provided.
|
||||
</summary>
|
||||
<param name="output">Output object to write result.</param>
|
||||
<param name="value">Provided value.</param>
|
||||
<param name="alignment">The alignment settings to apply when rendering <paramref name="value"/>.</param>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the ANSI terminal escape sequences. Recommended
|
||||
for Linux and Windows 10+.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Code">
|
||||
<summary>
|
||||
A 256-color theme along the lines of Visual Studio Code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Sixteen">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i> using only standard 16 terminal colors that will work on light backgrounds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,System.String})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme">
|
||||
<summary>
|
||||
The base class for styled terminal output.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.None">
|
||||
<summary>
|
||||
No styling applied.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.CanBuffer">
|
||||
<summary>
|
||||
True if styling applied by the theme is written into the output, and can thus be
|
||||
buffered and measured.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<summary>
|
||||
Begin a span of text in the specified <paramref name="style"/>.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
<param name="style">Style to apply.</param>
|
||||
<returns> The number of characters written to <paramref name="output"/>. </returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<summary>
|
||||
Reset the output to un-styled colors.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.ResetCharCount">
|
||||
<summary>
|
||||
The number of characters written by the <see cref="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)"/> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle">
|
||||
<summary>
|
||||
Elements styled by a console theme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Text">
|
||||
<summary>
|
||||
Prominent text, generally content within an event's message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.SecondaryText">
|
||||
<summary>
|
||||
Boilerplate text, for example items specified in an output template.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.TertiaryText">
|
||||
<summary>
|
||||
De-emphasized text, for example literal text in output templates and
|
||||
punctuation used when writing structured data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Invalid">
|
||||
<summary>
|
||||
Output demonstrating some kind of configuration issue, e.g. an invalid
|
||||
message template token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Null">
|
||||
<summary>
|
||||
The built-in <see langword="null"/> value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Name">
|
||||
<summary>
|
||||
Property and type names.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.String">
|
||||
<summary>
|
||||
Strings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Number">
|
||||
<summary>
|
||||
Numbers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Boolean">
|
||||
<summary>
|
||||
<see cref="T:System.Boolean"/> values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Scalar">
|
||||
<summary>
|
||||
All other scalar values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Object">
|
||||
<summary>
|
||||
Unrecognized literal values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelVerbose">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelDebug">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelInformation">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelWarning">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelError">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelFatal">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the styling facilities of the <see cref="T:System.Console"/> class. Recommended
|
||||
for Windows versions prior to Windows 10.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Colored">
|
||||
<summary>
|
||||
A theme based on the original Serilog "colored console" sink.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Styles">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle">
|
||||
<summary>
|
||||
Styling applied using the <see cref="T:System.ConsoleColor"/> enumeration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Foreground">
|
||||
<summary>
|
||||
The foreground color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Background">
|
||||
<summary>
|
||||
The background color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,357 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Serilog.Sinks.Console</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Serilog.ConsoleAuditLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the AuditTo.Console() extension method to <see cref="T:Serilog.Configuration.LoggerAuditSinkConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleAuditLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerAuditSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.ConsoleLoggerConfigurationExtensions">
|
||||
<summary>
|
||||
Adds the WriteTo.Console() extension method to <see cref="T:Serilog.LoggerConfiguration"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Events.LogEventLevel,System.String,System.IFormatProvider,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},Serilog.Sinks.SystemConsole.Themes.ConsoleTheme,System.Boolean,System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="outputTemplate">A message template describing the format used to write to the sink.
|
||||
The default is <code>"[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}"</code>.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<param name="theme">The theme to apply to the styled output. If not specified,
|
||||
uses <see cref="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate"/>.</param>
|
||||
<param name="applyThemeToRedirectedOutput">Applies the selected or default theme even when output redirection is detected.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="outputTemplate"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="M:Serilog.ConsoleLoggerConfigurationExtensions.Console(Serilog.Configuration.LoggerSinkConfiguration,Serilog.Formatting.ITextFormatter,Serilog.Events.LogEventLevel,Serilog.Core.LoggingLevelSwitch,System.Nullable{Serilog.Events.LogEventLevel},System.Object)">
|
||||
<summary>
|
||||
Writes log events to <see cref="T:System.Console"/>.
|
||||
</summary>
|
||||
<param name="sinkConfiguration">Logger sink configuration.</param>
|
||||
<param name="formatter">Controls the rendering of log events into text, for example to log JSON. To
|
||||
control plain text formatting, use the overload that accepts an output template.</param>
|
||||
<param name="syncRoot">An object that will be used to `lock` (sync) access to the console output. If you specify this, you
|
||||
will have the ability to lock on this object, and guarantee that the console sink will not be about to output anything while
|
||||
the lock is held.</param>
|
||||
<param name="restrictedToMinimumLevel">The minimum level for
|
||||
events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param>
|
||||
<param name="levelSwitch">A switch allowing the pass-through minimum level
|
||||
to be changed at runtime.</param>
|
||||
<param name="standardErrorFromLevel">Specifies the level at which events will be written to standard error.</param>
|
||||
<returns>Configuration object allowing method chaining.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="sinkConfiguration"/> is <code>null</code></exception>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="formatter"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Output.LevelOutputFormat">
|
||||
<summary>
|
||||
Implements the {Level} element.
|
||||
can now have a fixed width applied to it, as well as casing rules.
|
||||
Width is set through formats like "u3" (uppercase three chars),
|
||||
"w1" (one lowercase char), or "t4" (title case four chars).
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Casing.Format(System.String,System.String)">
|
||||
<summary>
|
||||
Apply upper or lower casing to <paramref name="value"/> when <paramref name="format"/> is provided.
|
||||
Returns <paramref name="value"/> when no or invalid format provided.
|
||||
</summary>
|
||||
<param name="value">Provided string for formatting.</param>
|
||||
<param name="format">Format string.</param>
|
||||
<returns>The provided <paramref name="value"/> with formatting applied.</returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Rendering.Padding.Apply(System.IO.TextWriter,System.String,System.Nullable{Serilog.Parsing.Alignment})">
|
||||
<summary>
|
||||
Writes the provided value to the output, applying direction-based padding when <paramref name="alignment"/> is provided.
|
||||
</summary>
|
||||
<param name="output">Output object to write result.</param>
|
||||
<param name="value">Provided value.</param>
|
||||
<param name="alignment">The alignment settings to apply when rendering <paramref name="value"/>.</param>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the ANSI terminal escape sequences. Recommended
|
||||
for Linux and Windows 10+.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Code">
|
||||
<summary>
|
||||
A 256-color theme along the lines of Visual Studio Code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Sixteen">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i> using only standard 16 terminal colors that will work on light backgrounds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,System.String})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme">
|
||||
<summary>
|
||||
The base class for styled terminal output.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.None">
|
||||
<summary>
|
||||
No styling applied.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.CanBuffer">
|
||||
<summary>
|
||||
True if styling applied by the theme is written into the output, and can thus be
|
||||
buffered and measured.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<summary>
|
||||
Begin a span of text in the specified <paramref name="style"/>.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
<param name="style">Style to apply.</param>
|
||||
<returns> The number of characters written to <paramref name="output"/>. </returns>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<summary>
|
||||
Reset the output to un-styled colors.
|
||||
</summary>
|
||||
<param name="output">Output destination.</param>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.ResetCharCount">
|
||||
<summary>
|
||||
The number of characters written by the <see cref="M:Serilog.Sinks.SystemConsole.Themes.ConsoleTheme.Reset(System.IO.TextWriter)"/> method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle">
|
||||
<summary>
|
||||
Elements styled by a console theme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Text">
|
||||
<summary>
|
||||
Prominent text, generally content within an event's message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.SecondaryText">
|
||||
<summary>
|
||||
Boilerplate text, for example items specified in an output template.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.TertiaryText">
|
||||
<summary>
|
||||
De-emphasized text, for example literal text in output templates and
|
||||
punctuation used when writing structured data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Invalid">
|
||||
<summary>
|
||||
Output demonstrating some kind of configuration issue, e.g. an invalid
|
||||
message template token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Null">
|
||||
<summary>
|
||||
The built-in <see langword="null"/> value.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Name">
|
||||
<summary>
|
||||
Property and type names.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.String">
|
||||
<summary>
|
||||
Strings.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Number">
|
||||
<summary>
|
||||
Numbers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Boolean">
|
||||
<summary>
|
||||
<see cref="T:System.Boolean"/> values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Scalar">
|
||||
<summary>
|
||||
All other scalar values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.Object">
|
||||
<summary>
|
||||
Unrecognized literal values, e.g. <see cref="T:System.Guid"/> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelVerbose">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelDebug">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelInformation">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelWarning">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelError">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle.LevelFatal">
|
||||
<summary>
|
||||
Level indicator.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme">
|
||||
<summary>
|
||||
A console theme using the styling facilities of the <see cref="T:System.Console"/> class. Recommended
|
||||
for Windows versions prior to Windows 10.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Grayscale">
|
||||
<summary>
|
||||
A theme using only gray, black and white.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Literate">
|
||||
<summary>
|
||||
A theme in the style of the original <i>Serilog.Sinks.Literate</i>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Colored">
|
||||
<summary>
|
||||
A theme based on the original Serilog "colored console" sink.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.#ctor(System.Collections.Generic.IReadOnlyDictionary{Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle,Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle})">
|
||||
<summary>
|
||||
Construct a theme given a set of styles.
|
||||
</summary>
|
||||
<param name="styles">Styles to apply within the theme.</param>
|
||||
<exception cref="T:System.ArgumentNullException">When <paramref name="styles"/> is <code>null</code></exception>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Styles">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.CanBuffer">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="P:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.ResetCharCount">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Set(System.IO.TextWriter,Serilog.Sinks.SystemConsole.Themes.ConsoleThemeStyle)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="M:Serilog.Sinks.SystemConsole.Themes.SystemConsoleTheme.Reset(System.IO.TextWriter)">
|
||||
<inheritdoc/>
|
||||
</member>
|
||||
<member name="T:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle">
|
||||
<summary>
|
||||
Styling applied using the <see cref="T:System.ConsoleColor"/> enumeration.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Foreground">
|
||||
<summary>
|
||||
The foreground color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Serilog.Sinks.SystemConsole.Themes.SystemConsoleThemeStyle.Background">
|
||||
<summary>
|
||||
The background color to apply.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
lbwb+E+Ha9zI0iuciPTBNJ6bi0ADet/FZ2u/59rxkptv6zXbKyvT7Ql9sgDrkWriklFrzNkSH/sn0glcRi/h0w==
|
||||
Reference in New Issue
Block a user