Configuration Options
On This Page
Directories and configuration options reference SkySync. This is expected.
Overview
This page provides information about how to set global configurations for the DryvIQ platform. You configure variables in the database through the command-line interface or in the appSettings.json file. (The appSettings.json file is located in C:\Program Files\SkySync\appSettings.json unless a different directory was specified during installation).
Transfer Performance Factors!
It is important to understand the factors that influence transfer performance. These variables all have a significant effect, positive or negative, on the throughput that any migration will achieve.
Please review our Scalability and Performance Whitepaper before adjusting any of these configuration options
Changes to the appsettings.json file will not take effect until the DryvIQ service is restarted.
Environment Overrides and Precedence
Below is the order of precedence, in order from highest to lowest, in which DryvIQ reads the configuration once the database and service are online and installation is complete. If a variable is set in two locations, DryvIQ will override the setting in the lower source with the one in the higher source.
License first
Then database
Then command-line
Then environment variables
Then appSettings.json
All settings can be set through the command line (--settingname=value) or through (SKYSYNC_settingname=value).
When using environment variables, replace the colon (:) with double underscore (__). So server:port could be set using an environment variable named SKYSYNC_server__port=value.
Configuration Options
See Transfer Job Configuration Options for more information about using the transfer block.
Key | Description | Default Value | Applicable to appSettings.json Only |
|---|---|---|---|
Audit | |||
transfer_audit_purge_after | The number of days to retain the audit records. | 90 |
|
Channels | |||
channels:limits:buffer | The buffer size for remote site web socket channel | 4096 |
|
channels:limits:max_message | The maximum size of a message that can be sent/received through a remote site channel | 1048576 |
|
channels:timeouts:connect_retry | The remote site channel connection retry interval | 00:01 |
|
channels:timeouts:keep_alive | The remote site channel keep-alive interval | 00:01 |
|
channels:timeouts:stale | The interval before a remote site channel is marked as stale and forcibly closed | 00:05 |
|
channels:timeouts:response | The remote site channel response timeout interval | 00:00:30 |
|
Connectors | |||
connectors:default_client_redirect | Connectors Default Client Redirect The default OAuth2 client redirect URI |
| |
connectors:hide_authentication_details | Hides the authentication block from the | true |
|
Data | |||
data:provider | The database provider (sqlite, npgsql, sqlserver, mysql, oracle) | npgsql (sqlserver in development) | true |
data:connection | The database connection string |
| true |
data:timeout | The default database command timeout interval | 00:05 | true |
data:directory | The application data directory (used for licensing, data, logging) | %LOCALAPPDATA%\SkySync\v4 | true |
Deployment | |||
deployment:packageDirectory | The directory to look for setup packages when building agent and remote site bundles | (null) | true |
Jobs | |||
jobs:retention:duration:type | Jobs Retention Duration Type Default job retention duration type (days, number, none, all) | days |
|
jobs:retention:duration:count | Jobs Retention Duration Count Default job retention count | 21 (type=days); 50 (type=number) |
|
jobs:retention:purge_empty | Jobs Retention Purge Empty A flag indicating whether empty job executions are purged by default | false |
|
jobs:priority | Jobs Priority The default job priority | 5 |
|
jobs:default_stop_policy:on_success | Jobs Default Stop Policy On Success The number of successful executions before terminating a job by default | (null) |
|
jobs:default_stop_policy:on_failure | Jobs Default Stop Policy On Failure The number of failed executions before terminating a job by default | (null) |
|
jobs:convention_stop_policy:on_success | Jobs Convention Stop Policy On Success The number of successful convention executions before terminating a convention job by default | (null) |
|
jobs:convention_stop_policy:on_failure | Jobs Convention Stop Policy On Failure The number of failed convention executions before terminating a convention job by default | (null) |
|
jobs:default_schedule:mode | Jobs Default Schedule Mode The default job schedule mode | auto |
|
jobs:default_schedule:interval | Jobs Default Schedule Interval The default job schedule interval | 15m |
|
jobs:default_schedule:max_execution | Jobs Default Schedule Max Executions The maximum amount of time that a job can run by default | (null) |
|
jobs:convention_schedule:mode | Jobs Convention Schedule Mode The default convention job schedule mode | auto |
|
jobs:convention_schedule:interval | Jobs Convention Schedule Interval The default convention job schedule interval | 6h |
|
jobs:convention_schedule:max_execution | Jobs Convention Schedule Max Executions The maximum amount of time that a convention job can run by default | (null) |
|
jobs:terminate_on_idle | The amount of time (in minutes) the DryvIQ worker node can be idle before it exits. To see the idle time for the scheduler, can go to: http://localhost:9090/v1/diagnostics/metrics?q=schedulers. The idle time returned in the diagnostics is in seconds. | (null) |
|
jobs:monitoring:cancel_polling_interval | The interval to use when polling for jobs that require cancellation | 00:00:05 |
|
LDAP | |||
ldap:server | LDAP Server Default LDAP server name if not configured | (null) |
|
ldap:port | LDAP Port Default LDAP server port if not configured | (null) |
|
ldap:dn | LDAP DN Default LDAP DN if not configured | (null) |
|
ldap:user | LDAP User Default LDAP user name used for authentication with LDAP server | (null) |
|
ldap:password | LDAP Password Default LDAP password used for authentication with LDAP server | (null) |
|
License | |||
license:activation_key | The license activation key | (null) | true |
license:service_uri | The license service URL | true | |
license:directory | The directory containing the activated license | "data:directory"\License | true |
license:agent_key | Activation Key to use for Agents | 7784e901-0000-0000-0000-df4cfde55fb4 |
|
license:site_key | Activation Key to use for Remote Sites | 7784e901-0000-0000-0000-df4cfde55fb4 |
|
Logging | |||
logging:level | Audit Level or Log Level The application audit level and the default audit level for transfer jobs In order of most → least:
| info |
|
logging:remoteLevel | The log level for remote log collection (currently Amazon Kinesis) | off |
|
logging:retention_days | The log retention duration in days | 21 |
|
Manager | |||
manager:host:url | Manager Host URL The manager URL (used for remote sites and agents) | (null) | true |
manager:client_id | Manager Client ID The client ID used when authenticating with a manager node | (null) | true |
manager:client_secret | Manager Client Secret The client secret used when authenticating with a manager node | (null) | true |
manager:mode | Manager Mode The application type used when authenticating with a manager node (i.e. site or agent) | (null) | true |
manager:site:user_id | Manager Site User ID The user ID to execute operations as on a remote site node | (null) | true |
Metrics | |||
metrics:graphite:host | The graphite server name to use when publishing metrics | (null) | true |
metrics:graphite:port | The graphite server port (can be empty and will default based on server format) | (null) | true |
metrics:graphite:id | A node identifier to prefix all metric key names (useful to distinguish metrics coming from multiple nodes in a cluster) | (null) | true |
Net | |||
net:timeouts:default | Net Timeouts Default Default timeout applied to most HTTP requests | 00:05 (5 minutes) |
|
net:timeouts:activity | Net Timeouts Activity Sliding timeout applied to read/write HTTP requests | Value of "net:timeouts:default" or default (00:05) |
|
net:fiddler:enable | Enable the FiddlerCore plugin to allow the embedded Fiddler to collect traces. You will still need to separately enable and disable trace collection as needed. | false |
|
net:fiddler:output | Fiddler traces are output to the logger by default. If you want to output the Fiddler traces to the .saz file, you need to add | (null) |
|
net:fiddler:collect | This is "false" by default. The Enable Capture toggle on the Performance tab in the Settings updates to this configuration to "true." Enabling capture through the CLI will also update this configuration value to "true." The configuration value is saved to the database so it will be picked up by all nodes through the configuration watcher system job. Since the new configuration is saved to the database, if Fiddler capture is enabled it will also stay enabled when the system restarts. There is another configuration value that is supposed to handle this scenario, | false |
|
Notifications | |||
notification:sms:enabled | Allow sending notifications via SMS | false |
|
notification:slack:enabled | Allow sending notifications via Slack | false |
|
notification:msteams:enabled | Allow sending notifications via Microsoft Teams | false |
|
notification:json:enabled | Allow sending notifications via a generic webhook endpoint | false |
|
Performance | |||
performance:retries | Unused | (null) |
|
performance:parallel_writes | Performance Parallel Writes The default number of parallel writes to use during transfer execution The default parallel write value is set at 4, 8, or 12 based on the CPU logical processors count of the machine running the DryvIQ service. If the CPU Logical Processors is 2, the default parallel writes value is 4.If the CPU Logical Processors is 8, the default parallel writes value is 8.If the CPU Logical Processors is 32, the default parallel writes value is 12. | ||