Skip to content

RDoc-3281 Update NLog-related articles #2009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Traffic Watch logging mode.
Possible values:

- `Off`
- `TologFile`
- `ToLogFile`

{PANEL/}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,167 +6,159 @@
* The following configuration keys allow you to control logging behavior in a RavenDB server.
To learn more about RavenDB's logging see [Logging](../../server/troubleshooting/logging).

* In this page:
* [Logs.ConfigPath](../../server/configuration/logs-configuration#logs.configpath)
* [Logs.Path](../../server/configuration/logs-configuration#logs.path)
* [Logs.MinLevel](../../server/configuration/logs-configuration#logs.minlevel)
* [Logs.Internal.Path](../../server/configuration/logs-configuration#logs.internal.path)
* [Logs.Internal.Level](../../server/configuration/logs-configuration#logs.internal.level)
* [Logs.Internal.LogToStandardOutput](../../server/configuration/logs-configuration#logs.internal.logtostandardoutput)
* [Logs.Internal.LogToStandardError](../../server/configuration/logs-configuration#logs.internal.logtostandarderror)
* [Logs.ArchiveAboveSizeInMb](../../server/configuration/logs-configuration#logs.archiveabovesizeinmb)
* [Logs.MaxArchiveDays](../../server/configuration/logs-configuration#logs.maxarchivedays)
* [Logs.MaxArchiveFiles](../../server/configuration/logs-configuration#logs.maxarchivefiles)
* [Logs.EnableArchiveFileCompression, Logs.Compress](../../server/configuration/logs-configuration#logs.enablearchivefilecompression,-logs.compress)
* [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration#logs.microsoft.minlevel)
* [Logs.ThrowConfigExceptions](../../server/configuration/logs-configuration#logs.throwconfigexceptions)
* [Logs.NuGet.PackagesPath](../../server/configuration/logs-configuration#logs.nuget.packagespath)
* [Logs.NuGet.PackageSourceUrl](../../server/configuration/logs-configuration#logs.nuget.packagesourceurl)
* [Logs.NuGet.AllowPreReleasePackages](../../server/configuration/logs-configuration#logs.nuget.allowprereleasepackages)
* [Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration#logs.nuget.additionalpackages)

* In this page:
* RavenDB logging configuration keys:
[Logs.ArchiveAboveSizeInMb](../../server/configuration/logs-configuration#logs.archiveabovesizeinmb)
[Logs.ConfigPath](../../server/configuration/logs-configuration#logs.configpath)
[Logs.EnableArchiveFileCompression](../../server/configuration/logs-configuration#logs.enablearchivefilecompression)
[Logs.MaxArchiveDays](../../server/configuration/logs-configuration#logs.maxarchivedays)
[Logs.MaxArchiveFiles](../../server/configuration/logs-configuration#logs.maxarchivefiles)
[Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration#logs.microsoft.minlevel)
[Logs.MinLevel](../../server/configuration/logs-configuration#logs.minlevel)
[Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration#logs.nuget.additionalpackages)
[Logs.NuGet.AllowPreReleasePackages](../../server/configuration/logs-configuration#logs.nuget.allowprereleasepackages)
[Logs.NuGet.PackagesPath](../../server/configuration/logs-configuration#logs.nuget.packagespath)
[Logs.NuGet.PackageSourceUrl](../../server/configuration/logs-configuration#logs.nuget.packagesourceurl)
[Logs.Path](../../server/configuration/logs-configuration#logs.path)
[Logs.ThrowConfigExceptions](../../server/configuration/logs-configuration#logs.throwconfigexceptions)
* Internal NLog configuration keys:
[Logs.Internal.Level](../../server/configuration/logs-configuration#logs.internal.level)
[Logs.Internal.LogToStandardError](../../server/configuration/logs-configuration#logs.internal.logtostandarderror)
[Logs.Internal.LogToStandardOutput](../../server/configuration/logs-configuration#logs.internal.logtostandardoutput)
[Logs.Internal.Path](../../server/configuration/logs-configuration#logs.internal.path)

{NOTE/}

---

{PANEL: Logs.ConfigPath}
{PANEL: Logs.ArchiveAboveSizeInMb}

A path to an XML file that overrides all internal logging configuration parameters.
Set to `null` to use the configuration parameters detailed below,
or provide a path to an XML configuration file whose content overrides these settings.
The maximum size (in megabytes) a log file may reach before it is archived and logging is directed to a new file.
This setting ensures that logs are stored in multiple smaller files rather than a few large ones.

- **Type**: `PathSetting`
- **Default**: `null`
- **Type**: `int`
- **Default**: `128`
- **Min Value**: `16`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.Path}
{PANEL: Logs.ConfigPath}

A path to the folder where RavenDB server log files are stored.
By default, it is the `Logs` folder under the server folder.
The path to an XML file that overrides all logging configuration parameters.
Set to `null` to apply the configuration params detailed in this section,
or provide a path to an XML configuration file whose content overrides these settings.

- **Type**: `string`
- **Default**: `Logs`
- **Default**: `null`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.MinLevel}
{PANEL: Logs.EnableArchiveFileCompression}

Determines the minimal logging level.
Log entries will be added from the set `MinLevel`and up.
Determines whether to compress archived log files.

- **Type**: `LogLevel`
- **Default**: `LogLevel.Info`
- **Type**: `bool`
- **Default**: `false`
- **Scope**: Server-wide only

{INFO: }
[For a table of available logging levels](../../server/troubleshooting/logging#logging-levels)
{INFO/}
- **Alias:** `Logs.Compress`

{PANEL/}

{PANEL: Logs.Internal.Path}
{PANEL: Logs.MaxArchiveDays}

The path to a folder that NLog internal usage logs are written to.
This can be used when NLog needs to be debugged, for example.
The maximum number of days to retain an archived log file.
Set this value to the number of days after which log files will be deleted,
or set it to `null` to keep log files indefinitely.

- **Type**: `PathSetting`
- **Default**: `null`
- **Type**: `int?`
- **Default**: `3`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.Internal.Level}
{PANEL: Logs.MaxArchiveFiles}

Determines the logging level for NLog internal-usage logs.
The maximum number of archived log files to keep.
Set to `null` to keep log files indefinitely.

- **Type**: `LogLevel`
- **Default**: `LogLevel.Info`
- **Type**: `int?`
- **Default**: `null`
- **Min Value**: `0`
- **Scope**: Server-wide only

{INFO: }
[For a table of available logging levels](../../server/troubleshooting/logging#logging-levels)
{INFO/}

{PANEL/}

{PANEL: Logs.Internal.LogToStandardOutput}
{PANEL: Logs.Microsoft.MinLevel}

Determines whether to write log messages to the standard output stream.
Can be used, for example, to run the server and verify that it runs without issues.
The minimum logging level for Microsoft logs.

- **Type**: `bool`
- **Default**: `false`
- **Type**: `enum LogLevel` (`Trace`, `Debug`, `Info`, `Warn`, `Error`, `Fatal`, `Off`)
- **Default**: `LogLevel.Error`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.Internal.LogToStandardError}
{PANEL: Logs.MinLevel}

Determines whether to write log messages to the standard output error stream.
Determines the minimum logging level.
Log entries will be included starting from the specified MinLevel and higher.

- **Type**: `bool`
- **Default**: `false`
- **Type**: `enum LogLevel` (`Trace`, `Debug`, `Info`, `Warn`, `Error`, `Fatal`, `Off`)
- **Default**: `LogLevel.Info`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.ArchiveAboveSizeInMb}
{PANEL: Logs.NuGet.AdditionalPackages}

The largest size (in megabytes) that a log file may reach
before it is archived and logging is directed to a new file.
Can be used to make certain that logs are collected in many small files rather than a few large ones.
A dictionary of additional NuGet packages to load during server startup for additional logging targets.
Each key represents the package name, and the corresponding value specifies the package version.

- **Type**: `Size`
- **Default**: `128`
- **Min Value**: `16`
- **Type**: `Dictionary<string, string>`
- **Default**: `null`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.MaxArchiveDays}
{PANEL: Logs.NuGet.AllowPreReleasePackages}

The maximum number of days that an archived log file is kept.
Determines whether to allow installation of NuGet pre-release packages.

- **Type**: `int?`
- **Default**: `3`
- **Type**: `bool`
- **Default**: `false`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.MaxArchiveFiles}
{PANEL: Logs.NuGet.PackagesPath}

The maximum number of archived log files to keep.
Set this value to the number of days after which log files will be deleted,
or set it to `null` to refrain from removing log files.
The path where NuGet packages required by RavenDB are downloaded.

- **Type**: `int?`
- **Default**: `null`
- **Min Value**: `0`
- **Type**: `string`
- **Default**: `Packages/NuGet/Logging`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.EnableArchiveFileCompression, Logs.Compress}
{PANEL: Logs.NuGet.PackageSourceUrl}

These two names relate to the same configuration parameter (the older `Logs.Compress`
is kept for backward compatibility), determining whether to compress archived log files.
The default URL for the NuGet package source.

- **Type**: `bool`
- **Default**: `false`
- **Type**: `string`
- **Default**: `https://api.nuget.org/v3/index.json`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.Microsoft.MinLevel}
{PANEL: Logs.Path}

The minimal logging level for Microsoft logs
The path to the folder where RavenDB server log files are stored.
By default, it is the `Logs` folder under the server folder.

- **Type**: `LogLevel`
- **Default**: `LogLevel.Error`
- **Type**: `string`
- **Default**: `Logs`
- **Scope**: Server-wide only

{PANEL/}
Expand All @@ -181,43 +173,44 @@ Determines whether to throw an exception if NLog detects a logging configuration

{PANEL/}

{PANEL: Logs.NuGet.PackagesPath}
{PANEL: Logs.Internal.Level}

The location of the NuGet packages that RavenDB needs to download and resolve to utilize NLog.
Determines the logging level for NLog's internal logs.

- **Type**: `PathSetting`
- **Default**: `Packages/NuGet/Logging`
- **Type**: `enum LogLevel` (`Trace`, `Debug`, `Info`, `Warn`, `Error`, `Fatal`, `Off`)
- **Default**: `LogLevel.Info`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.NuGet.PackageSourceUrl}
{PANEL: Logs.Internal.LogToStandardError}

Default NuGet source URL
Determines whether to write NLog's internal logs to the standard error stream.

- **Type**: `string`
- **Default**: `https://api.nuget.org/v3/index.json`
- **Type**: `bool`
- **Default**: `false`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.NuGet.AllowPreReleasePackages}
{PANEL: Logs.Internal.LogToStandardOutput}

Determines whether to allow installation of NuGet pre-release packages.
Determines whether to write NLog's internal logs to the standard output stream.
This can be useful when running the server to verify that it operates without issues.

- **Type**: `bool`
- **Default**: `false`
- **Scope**: Server-wide only

{PANEL/}

{PANEL: Logs.NuGet.AdditionalPackages}
{PANEL: Logs.Internal.Path}

A list of additional Nuget packages to load during server startup, for additional logging targets.
The path to the folder where NLog's internal logs are written.
This is useful for debugging NLog.

- **Type**: `Dictionary<string, string>`
- **Type**: `string`
- **Default**: `null`
- **Scope**: Server-wide only

{PANEL/}

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

* In this page:
* Security.AuditLog:
[Security.AuditLog.EnableArchiveFileCompression, Security.AuditLog.Compress](../../server/configuration/security-configuration#security.auditlog.enablearchivefilecompression,-security.auditlog.compress)
[Security.AuditLog.EnableArchiveFileCompression](../../server/configuration/security-configuration#security.auditlog.enablearchivefilecompression)
[Security.AuditLog.FolderPath](../../server/configuration/security-configuration#security.auditlog.folderpath)
[Security.AuditLog.ArchiveAboveSizeInMb](../../server/configuration/security-configuration#security.auditlog.archiveabovesizeinmb)
[Security.AuditLog.MaxArchiveDays](../../server/configuration/security-configuration#security.auditlog.maxarchivedays)
Expand Down Expand Up @@ -57,13 +57,14 @@

---

{PANEL: Security.AuditLog.EnableArchiveFileCompression, Security.AuditLog.Compress}
{PANEL: Security.AuditLog.EnableArchiveFileCompression}

Determines whether to compress the audit log files.

- **Type**: `bool`
- **Default**: `false`
- **Scope**: Server-wide only
- **Alias:** `Security.AuditLog.Compress`

{PANEL/}

Expand Down
Loading
Loading