diff --git a/docs/server/configuration/logs-configuration.mdx b/docs/server/configuration/logs-configuration.mdx index d5519e280c..ad3b76ef50 100644 --- a/docs/server/configuration/logs-configuration.mdx +++ b/docs/server/configuration/logs-configuration.mdx @@ -25,6 +25,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Logs.EnableArchiveFileCompression](../../server/configuration/logs-configuration.mdx#logsenablearchivefilecompression) [Logs.MaxArchiveDays](../../server/configuration/logs-configuration.mdx#logsmaxarchivedays) [Logs.MaxArchiveFiles](../../server/configuration/logs-configuration.mdx#logsmaxarchivefiles) + [Logs.Microsoft.Enabled](../../server/configuration/logs-configuration.mdx#logsmicrosoftenabled) [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logsmicrosoftminlevel) [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logsminlevel) [Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration.mdx#logsnugetadditionalpackages) @@ -99,9 +100,22 @@ Set to `null` to keep log files indefinitely. +## Logs.Microsoft.Enabled + +Determines whether [Microsoft logs](../../server/troubleshooting/logging.mdx#microsoft-logs) are enabled. +When enabled, RavenDB captures the diagnostic logs that .NET and Kestrel (RavenDB's web server) +emit internally, and writes them to RavenDB's log output. +Note that enabling this setting can affect request latency under certain conditions. + +- **Type**: `bool` +- **Default**: `false` +- **Scope**: Server-wide only + + + ## Logs.Microsoft.MinLevel -The minimum logging level for Microsoft logs. +The minimum logging level for [Microsoft logs](../../server/troubleshooting/logging.mdx#microsoft-logs). - **Type**: `enum LogLevel` (`Trace`, `Debug`, `Info`, `Warn`, `Error`, `Fatal`, `Off`) - **Default**: `LogLevel.Error` diff --git a/docs/server/troubleshooting/logging.mdx b/docs/server/troubleshooting/logging.mdx index d7132c8ab2..ea87b2c7b5 100644 --- a/docs/server/troubleshooting/logging.mdx +++ b/docs/server/troubleshooting/logging.mdx @@ -36,6 +36,7 @@ import Panel from '@site/src/components/Panel'; * [Available logging levels](../../server/troubleshooting/logging.mdx#available-logging-levels) * [Customizing logging level after Migration](../../server/troubleshooting/logging.mdx#customizing-logging-level-after-migration) * [Default values](../../server/troubleshooting/logging.mdx#default-values) + * [Microsoft logs](../../server/troubleshooting/logging.mdx#microsoft-logs) * [CLI customization: immediate temporary changes](../../server/troubleshooting/logging.mdx#cli-customization-immediate-temporary-changes) * [Configuring and using NLog](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog) * [Configure RavenDB to use an external NLog configuration file](../../server/troubleshooting/logging.mdx#1-configure-ravendb-to-use-an-external-nlog-configuration-file) @@ -197,6 +198,32 @@ You **will** need to update the logging settings if you want to take advantage o are **identical** to those used by RavenDB's internal configuration keys. See the full list in: [Logging configuration keys and their default values](../../server/configuration/logs-configuration.mdx). +## Microsoft logs + +Beyond its own log entries, RavenDB can capture the diagnostic logs that .NET and Kestrel +(RavenDB's web server) emit internally. +These entries come from the `Microsoft.Extensions.Logging` infrastructure and cover events such as +ASP.NET Core hosting, Kestrel connections, and the start and finish of each request. +They can help you investigate connection-level or HTTP-level behavior that RavenDB's own logs do not describe. + +These entries are collectively called **Microsoft logs**, and they are disabled by default. +Capturing them can affect request latency under certain conditions, so enable them only when you need them, +typically while diagnosing a specific problem. + +To enable Microsoft logs, set the following configuration keys and restart the server: + +* [Logs.Microsoft.Enabled](../../server/configuration/logs-configuration.mdx#logsmicrosoftenabled) + Set to `true` to capture Microsoft logs. +* [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logsmicrosoftminlevel) + Set the minimum level of the Microsoft entries that are logged. The default is `Error`. + + + +Once Microsoft logs are enabled, you can adjust their minimum level at runtime, without restarting the server, +using the [SetLogsConfigurationOperation](../../client-api/operations/server-wide/logs/set-logs-configuration.mdx) in the Client API. + + + ## CLI customization: immediate temporary changes Logging settings can also be customized via the [CLI](../../server/administration/cli.mdx), using the [log](../../server/administration/cli.mdx#log) command. diff --git a/versioned_docs/version-7.0/server/configuration/logs-configuration.mdx b/versioned_docs/version-7.0/server/configuration/logs-configuration.mdx index b82648158c..71b68bb617 100644 --- a/versioned_docs/version-7.0/server/configuration/logs-configuration.mdx +++ b/versioned_docs/version-7.0/server/configuration/logs-configuration.mdx @@ -24,6 +24,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Logs.EnableArchiveFileCompression](../../server/configuration/logs-configuration.mdx#logsenablearchivefilecompression) [Logs.MaxArchiveDays](../../server/configuration/logs-configuration.mdx#logsmaxarchivedays) [Logs.MaxArchiveFiles](../../server/configuration/logs-configuration.mdx#logsmaxarchivefiles) + [Logs.Microsoft.Enabled](../../server/configuration/logs-configuration.mdx#logsmicrosoftenabled) [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logsmicrosoftminlevel) [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logsminlevel) [Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration.mdx#logsnugetadditionalpackages) @@ -98,9 +99,22 @@ Set to `null` to keep log files indefinitely. +## Logs.Microsoft.Enabled + +Determines whether [Microsoft logs](../../server/troubleshooting/logging.mdx#microsoft-logs) are enabled. +When enabled, RavenDB captures the diagnostic logs that .NET and Kestrel (RavenDB's web server) +emit internally, and writes them to RavenDB's log output. +Note that enabling this setting can affect request latency under certain conditions. + +- **Type**: `bool` +- **Default**: `false` +- **Scope**: Server-wide only + + + ## Logs.Microsoft.MinLevel -The minimum logging level for Microsoft logs. +The minimum logging level for [Microsoft logs](../../server/troubleshooting/logging.mdx#microsoft-logs). - **Type**: `enum LogLevel` (`Trace`, `Debug`, `Info`, `Warn`, `Error`, `Fatal`, `Off`) - **Default**: `LogLevel.Error` diff --git a/versioned_docs/version-7.0/server/troubleshooting/logging.mdx b/versioned_docs/version-7.0/server/troubleshooting/logging.mdx index 12c7f3fd9e..8194304cd2 100644 --- a/versioned_docs/version-7.0/server/troubleshooting/logging.mdx +++ b/versioned_docs/version-7.0/server/troubleshooting/logging.mdx @@ -35,6 +35,7 @@ import Panel from '@site/src/components/Panel'; * [Available logging levels](../../server/troubleshooting/logging.mdx#available-logging-levels) * [Customizing logging level after Migration](../../server/troubleshooting/logging.mdx#customizing-logging-level-after-migration) * [Default values](../../server/troubleshooting/logging.mdx#default-values) + * [Microsoft logs](../../server/troubleshooting/logging.mdx#microsoft-logs) * [CLI customization: immediate temporary changes](../../server/troubleshooting/logging.mdx#cli-customization-immediate-temporary-changes) * [Configuring and using NLog](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog) * [Configure RavenDB to use an external NLog configuration file](../../server/troubleshooting/logging.mdx#1-configure-ravendb-to-use-an-external-nlog-configuration-file) @@ -196,6 +197,32 @@ You **will** need to update the logging settings if you want to take advantage o are **identical** to those used by RavenDB's internal configuration keys. See the full list in: [Logging configuration keys and their default values](../../server/configuration/logs-configuration.mdx). +## Microsoft logs + +Beyond its own log entries, RavenDB can capture the diagnostic logs that .NET and Kestrel +(RavenDB's web server) emit internally. +These entries come from the `Microsoft.Extensions.Logging` infrastructure and cover events such as +ASP.NET Core hosting, Kestrel connections, and the start and finish of each request. +They can help you investigate connection-level or HTTP-level behavior that RavenDB's own logs do not describe. + +These entries are collectively called **Microsoft logs**, and they are disabled by default. +Capturing them can affect request latency under certain conditions, so enable them only when you need them, +typically while diagnosing a specific problem. + +To enable Microsoft logs, set the following configuration keys and restart the server: + +* [Logs.Microsoft.Enabled](../../server/configuration/logs-configuration.mdx#logsmicrosoftenabled) + Set to `true` to capture Microsoft logs. +* [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logsmicrosoftminlevel) + Set the minimum level of the Microsoft entries that are logged. The default is `Error`. + + + +Once Microsoft logs are enabled, you can adjust their minimum level at runtime, without restarting the server, +using the [SetLogsConfigurationOperation](../../client-api/operations/server-wide/logs/set-logs-configuration.mdx) in the Client API. + + + ## CLI customization: immediate temporary changes Logging settings can also be customized via the [CLI](../../server/administration/cli.mdx), using the [log](../../server/administration/cli.mdx#log) command. diff --git a/versioned_docs/version-7.1/server/configuration/logs-configuration.mdx b/versioned_docs/version-7.1/server/configuration/logs-configuration.mdx index b82648158c..71b68bb617 100644 --- a/versioned_docs/version-7.1/server/configuration/logs-configuration.mdx +++ b/versioned_docs/version-7.1/server/configuration/logs-configuration.mdx @@ -24,6 +24,7 @@ import LanguageContent from "@site/src/components/LanguageContent"; [Logs.EnableArchiveFileCompression](../../server/configuration/logs-configuration.mdx#logsenablearchivefilecompression) [Logs.MaxArchiveDays](../../server/configuration/logs-configuration.mdx#logsmaxarchivedays) [Logs.MaxArchiveFiles](../../server/configuration/logs-configuration.mdx#logsmaxarchivefiles) + [Logs.Microsoft.Enabled](../../server/configuration/logs-configuration.mdx#logsmicrosoftenabled) [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logsmicrosoftminlevel) [Logs.MinLevel](../../server/configuration/logs-configuration.mdx#logsminlevel) [Logs.NuGet.AdditionalPackages](../../server/configuration/logs-configuration.mdx#logsnugetadditionalpackages) @@ -98,9 +99,22 @@ Set to `null` to keep log files indefinitely. +## Logs.Microsoft.Enabled + +Determines whether [Microsoft logs](../../server/troubleshooting/logging.mdx#microsoft-logs) are enabled. +When enabled, RavenDB captures the diagnostic logs that .NET and Kestrel (RavenDB's web server) +emit internally, and writes them to RavenDB's log output. +Note that enabling this setting can affect request latency under certain conditions. + +- **Type**: `bool` +- **Default**: `false` +- **Scope**: Server-wide only + + + ## Logs.Microsoft.MinLevel -The minimum logging level for Microsoft logs. +The minimum logging level for [Microsoft logs](../../server/troubleshooting/logging.mdx#microsoft-logs). - **Type**: `enum LogLevel` (`Trace`, `Debug`, `Info`, `Warn`, `Error`, `Fatal`, `Off`) - **Default**: `LogLevel.Error` diff --git a/versioned_docs/version-7.1/server/troubleshooting/logging.mdx b/versioned_docs/version-7.1/server/troubleshooting/logging.mdx index 12c7f3fd9e..8194304cd2 100644 --- a/versioned_docs/version-7.1/server/troubleshooting/logging.mdx +++ b/versioned_docs/version-7.1/server/troubleshooting/logging.mdx @@ -35,6 +35,7 @@ import Panel from '@site/src/components/Panel'; * [Available logging levels](../../server/troubleshooting/logging.mdx#available-logging-levels) * [Customizing logging level after Migration](../../server/troubleshooting/logging.mdx#customizing-logging-level-after-migration) * [Default values](../../server/troubleshooting/logging.mdx#default-values) + * [Microsoft logs](../../server/troubleshooting/logging.mdx#microsoft-logs) * [CLI customization: immediate temporary changes](../../server/troubleshooting/logging.mdx#cli-customization-immediate-temporary-changes) * [Configuring and using NLog](../../server/troubleshooting/logging.mdx#configuring-and-using-nlog) * [Configure RavenDB to use an external NLog configuration file](../../server/troubleshooting/logging.mdx#1-configure-ravendb-to-use-an-external-nlog-configuration-file) @@ -196,6 +197,32 @@ You **will** need to update the logging settings if you want to take advantage o are **identical** to those used by RavenDB's internal configuration keys. See the full list in: [Logging configuration keys and their default values](../../server/configuration/logs-configuration.mdx). +## Microsoft logs + +Beyond its own log entries, RavenDB can capture the diagnostic logs that .NET and Kestrel +(RavenDB's web server) emit internally. +These entries come from the `Microsoft.Extensions.Logging` infrastructure and cover events such as +ASP.NET Core hosting, Kestrel connections, and the start and finish of each request. +They can help you investigate connection-level or HTTP-level behavior that RavenDB's own logs do not describe. + +These entries are collectively called **Microsoft logs**, and they are disabled by default. +Capturing them can affect request latency under certain conditions, so enable them only when you need them, +typically while diagnosing a specific problem. + +To enable Microsoft logs, set the following configuration keys and restart the server: + +* [Logs.Microsoft.Enabled](../../server/configuration/logs-configuration.mdx#logsmicrosoftenabled) + Set to `true` to capture Microsoft logs. +* [Logs.Microsoft.MinLevel](../../server/configuration/logs-configuration.mdx#logsmicrosoftminlevel) + Set the minimum level of the Microsoft entries that are logged. The default is `Error`. + + + +Once Microsoft logs are enabled, you can adjust their minimum level at runtime, without restarting the server, +using the [SetLogsConfigurationOperation](../../client-api/operations/server-wide/logs/set-logs-configuration.mdx) in the Client API. + + + ## CLI customization: immediate temporary changes Logging settings can also be customized via the [CLI](../../server/administration/cli.mdx), using the [log](../../server/administration/cli.mdx#log) command.