StableBit CloudDrive Advanced Settings - Revision history

Alex: /* IoManager */

2018-09-05T19:28:37Z

IoManager

Christopher: /* Settings.json */

2018-05-29T19:12:10Z

Settings.json

Christopher: /* Settings */

2018-05-25T22:15:05Z

Settings

Christopher at 17:21, 6 March 2018

2018-03-06T17:21:02Z

Alex: /* Performance */

2018-02-24T04:01:17Z

Performance

Alex: /* IoManager */

2018-02-24T03:59:21Z

IoManager

Alex: /* CloudFsDisk */

2018-02-24T03:58:58Z

CloudFsDisk

Alex: /* IoManager */

2018-02-24T03:58:42Z

IoManager

Alex: /* Http */

2018-02-24T03:48:35Z

Http

Alex: /* CloudDrive */

2018-02-24T03:47:17Z

CloudDrive

@@ Line 79: / Line 79: @@
 * '''IoManager_ConnectionReadTimeoutMS''' (Default: "100000") - The maximum allowed duration of a connection in MS. The duration is calculated from the time that a connection is attempted until the final response is received.
 * '''IoManager_ConnectionWriteTimeoutMS''' (Default: "3600000") - The maximum allowed duration of a connection in MS. The duration is calculated from the time that a connection is attempted until the final response is received.
-* '''IoManager_HttpReadWriteTimeoutMS''' (Default: "") - The maximum allowed duration of a HTTP upload / download in MS.
+* '''IoManager_HttpReadWriteTimeoutMS''' (Default: "45000") - The maximum allowed duration of a HTTP upload / download in MS.
 * '''IoManager_ReadAbort''' - Maximum amount of time that a read thread is allowed to run before the thread is aborted (this is a secondary safety measure, if the timeout fails).
 * '''IoManager_NoFreeSpaceCheckOnStorageProvider''' (Default: "False") - When creating a new cloud drive or resizing an existing cloud drive, StableBit CloudDrive will make sure that there is enough free space at the storage provider (for providers that support free space checking) before allowing the resize or create operation to go through. If the storage provider is returning incorrect free space values, this can be set to '''True''' to disable this check.

@@ Line 3: / Line 3: @@
 In the newer versions, we've depreciated the config file and have moved over to a JSON file. There are a number of reasons for this, but the best is that we include the default values here, as well.
-The file is located in '''C:\ProgramData\StableBit DrivePool\Service\Settings.json'''.  Note that this file is in '''"ProgramData"''', and not '''"Program Files"'''. This folder is hidden by default, so you must type in the path, or enable '''"Show Hidden Files"''' in Windows Explorer.
+The file is located in '''C:\ProgramData\StableBit CloudDrive\Service\Settings.json'''.  Note that this file is in '''"ProgramData"''', and not '''"Program Files"'''. This folder is hidden by default, so you must type in the path, or enable '''"Show Hidden Files"''' in Windows Explorer.
 === Editing ===

@@ Line 61: / Line 61: @@
 === DeleteCloudDrive ===
 * '''DeleteCloudDrive_Retries''' (Default: "10") - How many times to retry deleting a cloud drive's metadata and data when an error is encountered.
 === FTP ===

← Older revision		Revision as of 17:21, 6 March 2018
Line 1:		Line 1:
		+	== Settings.json ==
		+
		+	In the newer versions, we've depreciated the config file and have moved over to a JSON file. There are a number of reasons for this, but the best is that we include the default values here, as well.
		+
		+	The file is located in '''C:\ProgramData\StableBit DrivePool\Service\Settings.json'''. Note that this file is in '''"ProgramData"''', and not '''"Program Files"'''. This folder is hidden by default, so you must type in the path, or enable '''"Show Hidden Files"''' in Windows Explorer.
		+
		+	=== Editing ===
		+
		+	Open the file in notepad. You'll see a JSON formatted file.
		+
		+	if you're not familiar with editing a JSON file, then you just edit the value for "Override", rather than the "Default" value. This will allow you to easily revert values to the default, by changing the override back to "null".
		+
		+	For instance, the default settings may look like this:
		+
		+	"BitLocker_CloudPartUnlockDetect": {
		+	"Default": true,
		+	"Override": null
		+	},
		+
		+	The default value means that whichever value is enabled by default. If you change the "null" in the override line to "false" and save the file, it will disable the setting in the future:
		+
		+	"BitLocker_CloudPartUnlockDetect": {
		+	"Default": true,
		+	"Override": ''false''
		+	},
		+
		+	This example would disable the BitLocker pool detection feature, meaning that you may need to manually restart the service to detect unlocked drives.
		+
	== Settings ==		== Settings ==
	Settings are organized by function.		Settings are organized by function.

@@ Line 64: / Line 64: @@
 === Performance ===
-* '''Performance_MaximumClosedIoToTrack''' (Default: "1000") ('''???''') Maximum number of IO threads to track for the performance window.
+* '''Performance_MaximumClosedIoToTrack''' (Default: "1000") When computing bandwidth averages and connection counts, this defines the maximum number of closed connections to keep track of.
 === PinDiskMetadata ===

@@ Line 51: / Line 51: @@
 * '''IoManager_ReadAbort''' - Maximum amount of time that a read thread is allowed to run before the thread is aborted (this is a secondary safety measure, if the timeout fails).
 * '''IoManager_NoFreeSpaceCheckOnStorageProvider''' (Default: "False") - When creating a new cloud drive or resizing an existing cloud drive, StableBit CloudDrive will make sure that there is enough free space at the storage provider (for providers that support free space checking) before allowing the resize or create operation to go through. If the storage provider is returning incorrect free space values, this can be set to '''True''' to disable this check.
 * '''IoManager_ReadAbort''' (Default: "00:01:55") - The maximum amount of time that a read thread is allowed to run before the thread is aborted (this is a secondary safety measure, if the timeout fails). Normally, IoManager_ConnectionReadTimeoutMS will instruct the underlying API to perform the timeout, but if the API does not respect this, it will be aborted.
 * '''IoManager_ReadRetries''' (Default: "10") - How many times to retry provider reads before returning an error to the disk.

@@ Line 27: / Line 27: @@
 * '''CloudFsDisk_Tracing''' (Default: "False") - When set to True, kernel driver tracing will be enabled by default at all times. Tracing logs are written to ''%ProgramData%\StableBit CloudDrive\Service\Logs\CloudFsDisk''. They are written in a binary format and can be submitted to technical support for analysis.
 * '''CloudFs_TracingFlushS''' (Default: "0") - This sets flush to disk the interval. 0 will flush on every trace.
 === CreateDrive ===

@@ Line 44: / Line 44: @@
 === IoManager ===
-* '''IoManager_DefaultConnectionLimit''' (Default: "1000") - The maximum number of simultaneous HTTP connections that the service is allowed to create.
+* '''IoManager_DefaultConnectionLimit''' (Default: "1000") - The absolute maximum number of simultaneous HTTP connections that the service is allowed to create.
-** Clarification needed.
+* '''IoManager_DefaultMaximumReadAggregation''' (Default: "1048576") - When multiple read request arrive to the disk in close temporal proximity, and they are requesting adjacent data, those requests will be combined into one request to the storage provider. Certain providers (e.g. Local Disk, File Share) always use a 100 MB limit regardless of this setting.
-* '''IoManager_DefaultMaximumReadAggregation''' (Default: "1048576") - Sets the maximum read I/O aggregation for providers that don't explicitly define one.
+** More information: [https://stablebit.com/Admin/IssueAnalysis/27309 Issue #27309]
 * '''IoManager_ConnectionReadTimeoutMS''' (Default: "100000") - The maximum allowed duration of a connection in MS. The duration is calculated from the time that a connection is attempted until the final response is received.
 * '''IoManager_ConnectionWriteTimeoutMS''' (Default: "3600000") - The maximum allowed duration of a connection in MS. The duration is calculated from the time that a connection is attempted until the final response is received.
 * '''IoManager_HttpReadWriteTimeoutMS''' (Default: "") - The maximum allowed duration of a HTTP upload / download in MS.
 * '''IoManager_ReadAbort''' - Maximum amount of time that a read thread is allowed to run before the thread is aborted (this is a secondary safety measure, if the timeout fails).
-* '''IoManager_NoFreeSpaceCheckOnStorageProvider''' (Default: "False") - ('''???''') Disables the free space check on provider when creating new drives.
+* '''IoManager_NoFreeSpaceCheckOnStorageProvider''' (Default: "False") - When creating a new cloud drive or resizing an existing cloud drive, StableBit CloudDrive will make sure that there is enough free space at the storage provider (for providers that support free space checking) before allowing the resize or create operation to go through. If the storage provider is returning incorrect free space values, this can be set to '''True''' to disable this check.
 ** Clarification needed.
 * '''IoManager_ReadRetries''' (Default: "10") - How many times to retry provider reads before returning an error to the disk.
 * '''IoManager_ReadThreads''' (Default: "2") - The default number of read threads when creating a new cloud drive, unless overridden by the provider.
 * '''IoManager_ThrottlingCatchupS'''(Default: "3.0")  - The set limit for the I/O Manager can now be temporarily exceeded in order to "catch up" due to a previous slow down. Set to 0.0 to disable.
 * '''IoManager_UseHttpCompression''' (Default: "True") - Set to True to use HTTP compression, set to False otherwise.
-* '''IoManager_WriteAbort''' (Default: "00:05:00") - Maximum amount of time that a write thread is allowed to run before the thread is aborted (this is a secondary safety measure, if the timeout fails).
+* '''IoManager_WriteAbort''' (Default: "00:05:00") - Maximum amount of time that a write thread is allowed to run before the thread is aborted (this is a secondary safety measure, if the timeout fails). Normally, IoManager_ConnectionWriteTimeoutMS will instruct the underlying API to perform the timeout, but if the API does not respect this, it will be aborted.
 * '''IoManager_WriteRetries''' - How many times to retry provider reads before giving up and showing an error to the user.
 * '''IoManager_WriteThreads''' - The default number of write threads when creating a new cloud drive, unless overridden by the provider.

@@ Line 41: / Line 41: @@
 === Http ===
-* '''Http_Legacy10''' (Default: "False") - ('''???''')
+* '''Http_Legacy10''' (Default: "False") - When set to true, the HTTP protocol will use version 1.0 instead of 1.1 throughout the application. This is useful for compatibility with older HTTP proxies that don't support version 1.1.
 === IoManager ===

@@ Line 15: / Line 15: @@
 * '''CloudDrive_ServiceLoggingEnabled''' (Default: "True") - Enables normal service logging, such as remote control info, cloud provider I/O info, etc...
 * '''CloudDrive_SynchronousServiceStart''' (Default: "False") - When the service starts, for performance reasons, Windows will be told that service startup is complete even before some time consuming startup tasks are done running. One of these tasks is waiting for all of the existing cloud drives to finish mounting. If you want to set up a service dependency on the StableBit CloudDrive service, such that you want to ensure that all of the cloud drives have finished mounting before the service enters the running state, set this to '''True'''.
 * '''CloudDrive_WaitForInternetS''' (Default: "120") - How long to wait for an Internet connection to become available before allowing the service to complete startup and mount the first cloud drive (set to 0 to start immediately and not wait).