diff --git a/Documentation/5.4/Raven.Documentation.Pages/server/configuration/.docs.json b/Documentation/5.4/Raven.Documentation.Pages/server/configuration/.docs.json index 00663cf637..5a2a14eed8 100644 --- a/Documentation/5.4/Raven.Documentation.Pages/server/configuration/.docs.json +++ b/Documentation/5.4/Raven.Documentation.Pages/server/configuration/.docs.json @@ -1,163 +1,169 @@ [ - { - "Path": "configuration-options.markdown", - "Name": "Configuration Overview", - "DiscussionId": "5b02dc18-9f71-44c2-91e1-db773e67ee62", - "Mappings": [] - }, - { - "Path": "command-line-arguments.markdown", - "Name": "Command Line Arguments", - "DiscussionId": "9814a466-00e6-4457-b9c5-6688c65766a5", - "Mappings": [] - }, - { - "Path": "backup-configuration.markdown", - "Name": "Backup Options", - "DiscussionId": "dbee505a-ac58-4e24-9993-c4e822a47916", - "Mappings": [] - }, - { - "Path": "cluster-configuration.markdown", - "Name": "Cluster Configuration", - "DiscussionId": "35d5b815-0e93-4986-b5eb-05ba66ba154c", - "Mappings": [] - }, - { - "Path": "core-configuration.markdown", - "Name": "Core Configuration", - "DiscussionId": "64bf1f6e-6646-449b-b4ca-3df90c568ae4", - "Mappings": [] - }, - { - "Path": "database-configuration.markdown", - "Name": "Database Configuration", - "DiscussionId": "21bc3dc1-eb28-4806-99e4-ee3f8a8d2f60", - "Mappings": [] - }, - { - "Path": "etl-configuration.markdown", - "Name": "ETL Configuration", - "DiscussionId": "c98467b2-7072-4ca0-ac72-b775dc8ac67f", - "Mappings": [] - }, - { - "Path": "embedded-configuration.markdown", - "Name": "Embedded Configuration", - "DiscussionId": "a6a148d2-c4fa-47c6-aa1c-3fad81e64000", - "Mappings": [ - { - "Version": 4.0, - "Key": "server/configuration/testing-configuration" - } - ] - }, - { - "Path": "http-configuration.markdown", - "Name": "HTTP Configuration", - "DiscussionId": "21f4f4d1-cb21-40f0-9c65-af4cfb761cb9", - "Mappings": [] - }, - { - "Path": "indexing-configuration.markdown", - "Name": "Indexing Configuration", - "DiscussionId": "40464303-54d4-44f4-95c0-a69e0de985a2", - "Mappings": [] - }, - { - "Path": "license-configuration.markdown", - "Name": "License Configuration", - "DiscussionId": "f96e07fc-5344-4ba6-ab5c-d4263ee8be6b", - "Mappings": [] - }, - { - "Path": "logs-configuration.markdown", - "Name": "Logs Configuration", - "DiscussionId": "9b1ea3ed-c951-408f-acf4-74ca775ccba5", - "Mappings": [] - }, - { - "Path": "memory-configuration.markdown", - "Name": "Memory Configuration", - "DiscussionId": "d01a45fe-4356-4fc3-998c-718c62fe89b7", - "Mappings": [] - }, - { - "Path": "monitoring-configuration.markdown", - "Name": "Monitoring Configuration", - "DiscussionId": "c7ac2756-7486-4c98-bf3d-dedeed45784e", - "Mappings": [] - }, - { - "Path": "patching-configuration.markdown", - "Name": "Patching Configuration", - "DiscussionId": "0b15dc07-fcf0-4e03-9fc4-4e50eab7eeab", - "Mappings": [] - }, - { - "Path": "performance-hints-configuration.markdown", - "Name": "Performance Hints Configuration", - "DiscussionId": "8b22654a-e212-4601-ba8a-d5ababe2f730", - "Mappings": [] - }, - { - "Path": "query-configuration.markdown", - "Name": "Query Configuration", - "DiscussionId": "a70af9a0-53cd-4d98-9cff-a592d0ceca86", - "Mappings": [] - }, - { - "Path": "replication-configuration.markdown", - "Name": "Replication Configuration", - "DiscussionId": "b47bdf7d-69f2-4bc9-aad5-879311007d33", - "Mappings": [] - }, - { - "Path": "security-configuration.markdown", - "Name": "Security Configuration", - "DiscussionId": "84c7d92d-d009-4f2c-b2ca-d56afaaac2f8", - "Mappings": [] - }, - { - "Path": "server-configuration.markdown", - "Name": "Server Configuration", - "DiscussionId": "79df0789-13d6-43c1-ae47-563550cc291c", - "Mappings": [] - }, - { - "Path": "storage-configuration.markdown", - "Name": "Storage Configuration", - "DiscussionId": "76f2a9ab-56d7-42d1-80e0-38cdbd4147bb", - "Mappings": [] - }, - { - "Path": "studio-configuration.markdown", - "Name": "Studio Configuration", - "DiscussionId": "d13bd568-a7df-477e-9708-588307fba47a", - "Mappings": [] - }, - { - "Path": "subscription-configuration.markdown", - "Name": "Subscription Configuration", - "DiscussionId": "04e3284b-d599-4479-b75a-ae7d6920cd6e", - "Mappings": [] - }, - { - "Path": "tombstone-configuration.markdown", - "Name": "Tombstone Configuration", - "DiscussionId": "65ca6661-dd2f-4833-8978-c642828aa25a", - "Mappings": [] - }, - { - "Path": "transaction-merger-configuration.markdown", - "Name": "Transaction Merger Configuration", - "DiscussionId": "7b64f734-8147-4e84-815a-3c1aabfc7e68", - "Mappings": [] - }, - { - "Path": "updates-configuration.markdown", - "Name": "Updates Configuration", - "DiscussionId": "7852f306-898f-4fb4-adbd-c7b21934393d", - "Mappings": [] - } + { + "Path": "configuration-options.markdown", + "Name": "Configuration Overview", + "DiscussionId": "5b02dc18-9f71-44c2-91e1-db773e67ee62", + "Mappings": [] + }, + { + "Path": "command-line-arguments.markdown", + "Name": "Command Line Arguments", + "DiscussionId": "9814a466-00e6-4457-b9c5-6688c65766a5", + "Mappings": [] + }, + { + "Path": "backup-configuration.markdown", + "Name": "Backup Options", + "DiscussionId": "dbee505a-ac58-4e24-9993-c4e822a47916", + "Mappings": [] + }, + { + "Path": "cluster-configuration.markdown", + "Name": "Cluster Configuration", + "DiscussionId": "35d5b815-0e93-4986-b5eb-05ba66ba154c", + "Mappings": [] + }, + { + "Path": "core-configuration.markdown", + "Name": "Core Configuration", + "DiscussionId": "64bf1f6e-6646-449b-b4ca-3df90c568ae4", + "Mappings": [] + }, + { + "Path": "database-configuration.markdown", + "Name": "Database Configuration", + "DiscussionId": "21bc3dc1-eb28-4806-99e4-ee3f8a8d2f60", + "Mappings": [] + }, + { + "Path": "etl-configuration.markdown", + "Name": "ETL Configuration", + "DiscussionId": "c98467b2-7072-4ca0-ac72-b775dc8ac67f", + "Mappings": [] + }, + { + "Path": "embedded-configuration.markdown", + "Name": "Embedded Configuration", + "DiscussionId": "a6a148d2-c4fa-47c6-aa1c-3fad81e64000", + "Mappings": [ + { + "Version": 4.0, + "Key": "server/configuration/testing-configuration" + } + ] + }, + { + "Path": "http-configuration.markdown", + "Name": "HTTP Configuration", + "DiscussionId": "21f4f4d1-cb21-40f0-9c65-af4cfb761cb9", + "Mappings": [] + }, + { + "Path": "indexing-configuration.markdown", + "Name": "Indexing Configuration", + "DiscussionId": "40464303-54d4-44f4-95c0-a69e0de985a2", + "Mappings": [] + }, + { + "Path": "license-configuration.markdown", + "Name": "License Configuration", + "DiscussionId": "f96e07fc-5344-4ba6-ab5c-d4263ee8be6b", + "Mappings": [] + }, + { + "Path": "logs-configuration.markdown", + "Name": "Logs Configuration", + "DiscussionId": "9b1ea3ed-c951-408f-acf4-74ca775ccba5", + "Mappings": [] + }, + { + "Path": "memory-configuration.markdown", + "Name": "Memory Configuration", + "DiscussionId": "d01a45fe-4356-4fc3-998c-718c62fe89b7", + "Mappings": [] + }, + { + "Path": "monitoring-configuration.markdown", + "Name": "Monitoring Configuration", + "DiscussionId": "c7ac2756-7486-4c98-bf3d-dedeed45784e", + "Mappings": [] + }, + { + "Path": "patching-configuration.markdown", + "Name": "Patching Configuration", + "DiscussionId": "0b15dc07-fcf0-4e03-9fc4-4e50eab7eeab", + "Mappings": [] + }, + { + "Path": "performance-hints-configuration.markdown", + "Name": "Performance Hints Configuration", + "DiscussionId": "8b22654a-e212-4601-ba8a-d5ababe2f730", + "Mappings": [] + }, + { + "Path": "query-configuration.markdown", + "Name": "Query Configuration", + "DiscussionId": "a70af9a0-53cd-4d98-9cff-a592d0ceca86", + "Mappings": [] + }, + { + "Path": "replication-configuration.markdown", + "Name": "Replication Configuration", + "DiscussionId": "b47bdf7d-69f2-4bc9-aad5-879311007d33", + "Mappings": [] + }, + { + "Path": "security-configuration.markdown", + "Name": "Security Configuration", + "DiscussionId": "84c7d92d-d009-4f2c-b2ca-d56afaaac2f8", + "Mappings": [] + }, + { + "Path": "server-configuration.markdown", + "Name": "Server Configuration", + "DiscussionId": "79df0789-13d6-43c1-ae47-563550cc291c", + "Mappings": [] + }, + { + "Path": "storage-configuration.markdown", + "Name": "Storage Configuration", + "DiscussionId": "76f2a9ab-56d7-42d1-80e0-38cdbd4147bb", + "Mappings": [] + }, + { + "Path": "studio-configuration.markdown", + "Name": "Studio Configuration", + "DiscussionId": "d13bd568-a7df-477e-9708-588307fba47a", + "Mappings": [] + }, + { + "Path": "subscription-configuration.markdown", + "Name": "Subscription Configuration", + "DiscussionId": "04e3284b-d599-4479-b75a-ae7d6920cd6e", + "Mappings": [] + }, + { + "Path": "tombstone-configuration.markdown", + "Name": "Tombstone Configuration", + "DiscussionId": "65ca6661-dd2f-4833-8978-c642828aa25a", + "Mappings": [] + }, + { + "Path": "traffic-watch-configuration.markdown", + "Name": "Traffic Watch Configuration", + "DiscussionId": "7b64f734-8147-4e84-815a-3c1aabfc7e68", + "Mappings": [] + }, + { + "Path": "transaction-merger-configuration.markdown", + "Name": "Transaction Merger Configuration", + "DiscussionId": "7b64f734-8147-4e84-815a-3c1aabfc7e68", + "Mappings": [] + }, + { + "Path": "updates-configuration.markdown", + "Name": "Updates Configuration", + "DiscussionId": "7852f306-898f-4fb4-adbd-c7b21934393d", + "Mappings": [] + } ] diff --git a/Documentation/5.4/Raven.Documentation.Pages/server/configuration/logs-configuration.markdown b/Documentation/5.4/Raven.Documentation.Pages/server/configuration/logs-configuration.markdown index 147e130641..894ee22260 100644 --- a/Documentation/5.4/Raven.Documentation.Pages/server/configuration/logs-configuration.markdown +++ b/Documentation/5.4/Raven.Documentation.Pages/server/configuration/logs-configuration.markdown @@ -20,7 +20,7 @@ Available options: - `Operations` (high level info for operational users) - `Information` (low level debug info) -
+--- - **Type**: `string` - **Default**: `Operations` diff --git a/Documentation/5.4/Raven.Documentation.Pages/server/configuration/traffic-watch-configuration.markdown b/Documentation/5.4/Raven.Documentation.Pages/server/configuration/traffic-watch-configuration.markdown new file mode 100644 index 0000000000..eff0c95d95 --- /dev/null +++ b/Documentation/5.4/Raven.Documentation.Pages/server/configuration/traffic-watch-configuration.markdown @@ -0,0 +1,126 @@ +# Configuration: Traffic Watch Options + +{PANEL: TrafficWatch.Mode} + +Traffic Watch logging mode. + +- **Type**: `TrafficWatchMode` +- **Default**: `Off` +- **Scope**: Server-wide only + +Possible values: + +- `Off` +- `TologFile` + +{PANEL/} + +{PANEL: TrafficWatch.Databases} + +A semicolon-separated list of database names by which the Traffic Watch logging entities will be filtered. +If not specified, Traffic Watch entities of all databases will be included. +A sample list: `\"test-database;another-database;the-third-database\"` + +- **Type**: `List` +- **Default**: `null` +- **Scope**: Server-wide only + +{PANEL/} + +{PANEL: TrafficWatch.StatusCodes} + +A semicolon-separated list of response status codes by which the Traffic Watch logging entities will be filtered. +If not specified, Traffic Watch entities with any response status code will be included. +A sample list: `\"200;500;404\"` + +- **Type**: `List` +- **Default**: `null` +- **Scope**: Server-wide only + +{PANEL/} + +{PANEL: TrafficWatch.MinimumResponseSizeInBytes} + +Minimum response size by which the Traffic Watch logging entities will be filtered. + +- **Type**: `int` +- **Default**: `0` +- **Minimum**: `0` +- **Scope**: Server-wide only + +{PANEL/} + +{PANEL: TrafficWatch.MinimumRequestSizeInBytes} + +Minimum request size by which the Traffic Watch logging entities will be filtered. + +- **Type**: `int` +- **Default**: `0` +- **Minimum**: `0` +- **Scope**: Server-wide only + +{PANEL/} + +{PANEL: TrafficWatch.MinimumDurationInMs} + +Minimum duration by which the Traffic Watch logging entities will be filtered. + +- **Type**: `int` +- **Default**: `0` +- **Scope**: Server-wide only + +{PANEL/} + +{PANEL: TrafficWatch.HttpMethods} + +A semicolon-separated list of request HTTP methods by which the Traffic Watch logging entities will be filtered. +If not specified, Traffic Watch entities with any HTTP request method will be included. +A sample list: `\"GET;POST\"` + +- **Type**: `List` +- **Default**: `null` +- **Scope**: Server-wide only + +{PANEL/} + +{PANEL: TrafficWatch.ChangeTypes} + +A semicolon-separated list of Traffic Watch change types by which the Traffic Watch logging entities will be filtered. +If not specified, Traffic Watch entities with any change type will be included. +A sample list: `\"Queries;Documents\"` + +- **Type**: `List` +- **Default**: `null` +- **Scope**: Server-wide only + +{PANEL/} + +{PANEL: TrafficWatch.CertificateThumbprints} + +A semicolon-separated list of specific client certificate thumbprints by which the Traffic Watch logging entities will be filtered. +If not specified, Traffic Watch entities with any certificate thumbprint will be included, +including those without any thumbprint. +A sample list: `\"0123456789ABCDEF0123456789ABCDEF01234567;FEDCBA9876543210FEDCBA9876543210FEDCBA98\"` + +- **Type**: `List` +- **Default**: `null` +- **Scope**: Server-wide only + +Possible values: + +- `None` +- `Queries` +- `Operations` +- `MultiGet` +- `BulkDocs` +- `Index` +- `Counters` +- `Hilo` +- `Subscriptions` +- `Streams` +- `Documents` +- `TimeSeries` +- `Notifications` +- `ClusterCommands` + +{PANEL/} diff --git a/Documentation/5.4/Raven.Documentation.Pages/server/troubleshooting/collect-info.markdown b/Documentation/5.4/Raven.Documentation.Pages/server/troubleshooting/collect-info.markdown index c2f7eaabcd..956c8ce929 100644 --- a/Documentation/5.4/Raven.Documentation.Pages/server/troubleshooting/collect-info.markdown +++ b/Documentation/5.4/Raven.Documentation.Pages/server/troubleshooting/collect-info.markdown @@ -90,13 +90,35 @@ then enable the following logs (if not enabled yet) before downloading existing 1. Navigate to __Manage Server > Admin Logs__ and click 'Settings'. 2. __Server logs - Log Mode__: - * Set the server logs level to 'Information' - * Note: - Logs settings will reset to their default values after a server restart. - If you wish to maintain this setting, ensure that [Logs.Mode](../../server/configuration/logs-configuration#logs.mode) is also set in your [default configuration](../../server/configuration/configuration-options). + * Set the RavenDB server logs level to 'Information'. 3. __Traffic Watch log__: - Activate the traffic watch log. Keep the default values shown. + * Click 'Configure' to enable Traffic Watch logging to the server logs. + * Keep the default values shown in the popup dialog. + +4. __Microsoft logs__: + * This is an advanced option, set it only if requested by the support team. + * Click 'Configure' to enable the logging of Microsoft logs to the server logs. + * Use the following suggested log configuration: + + {CODE-BLOCK:json} +{ + "Microsoft.AspNetCore":"Debug" + // Available levels: Trace, Debug, Information, Warning, Error, Critical, None +} + {CODE-BLOCK/} + +{WARNING: } + +* Be aware that all logs settings will reset to their default values after a server restart. + +* To maintain a specific setting after a server restart, set the following configuration keys + in your [default configuration](../../server/configuration/configuration-options): + * Server logs - set [Logs.Mode](../../server/configuration/logs-configuration#logs.mode) + * Traffic Watch log - set [Logs.Microsoft.Disable](../../server/configuration/logs-configuration#logs.microsoft.disable) + * Microsoft logs - set [TrafficWatch.Mode](../../server/configuration/logs-configuration#logs.mode) + +{WARNING/} {PANEL/} @@ -152,7 +174,7 @@ __Before sending the log files__, perform the following checks: {PANEL: Reproduce scenario} -* If the incident is over and you can reproduce it, then first verify logging level is set to information. +* If the incident is over and you can reproduce it, then first verify logging level is set to 'Information'. * See how to enable the logs in [Enable logs](../../server/troubleshooting/collect-info#enable-logs-for-ongoing-issues). diff --git a/Documentation/5.4/Raven.Documentation.Pages/server/troubleshooting/images/enable-logs.png b/Documentation/5.4/Raven.Documentation.Pages/server/troubleshooting/images/enable-logs.png index f9edb8f904..72e57231e1 100644 Binary files a/Documentation/5.4/Raven.Documentation.Pages/server/troubleshooting/images/enable-logs.png and b/Documentation/5.4/Raven.Documentation.Pages/server/troubleshooting/images/enable-logs.png differ