Edge configuration for constrained hardware & networks

When the ClearBade Edge is used on constrained hardware (i.e. with limited CPU and Memory resources) or in environments with constrained networks (e.g. with bad cellular connectivity), there are certain configuration settings that are recommended to improve connectivity, improve performance and reduce resource utilization.

NOTE:

1. These changes are made in the config.toml file used by the edge.

2. If a mentioned section is missing it can simply be added to the config.toml.

3. If a mentioned parameter is missing then the default value is currently in use.

4. If a mentioned parameter is missing it can simply be added and its value set to a non-default value.

Recommended changes:

1. [RPC] section (RPC = Remote Procedure Call):

   1. RPCConnectionTimeout

      1. Amount of time an edge will try to establish connection with the platform before timing out

      2. Default: 30 (seconds)

      3. RECOMMENDATION: Set this to 1000 or greater. This has been seen to help in environments with constrained communication

   2. RPCTimeout

      1. Amount of time an edge will wait for an RPC call to complete before timing out.

      2. Default: 120 (seconds)

      3. RECOMMENDATION: Set this to 1000 or greater. This has been seen to help in environments with constrained communication

   3. RPCKeepaliveInterval

      1. Period of heartbeat from edge to let platform know it is still connected

      2. Default: 60 (seconds)

      3. RECOMMENDATION: Set this to 120 or greater. This has been seen to help in environments with constrained communication
         

2. [LeanMode] section:

   1. LeanMode

      1. When true, runs edge with minimal logging

      2. Default: false

      3. RECOMMENDATION: Set this to true to reduce disk usage. Set this to false temporarily when troubleshooting.

      4. NOTE: Setting this parameter to true causes other parameters in the section to be ignored. Setting this to true overrides all settings that increase logging.

   2. StoreAnalytics

      1. When true, causes MQTT message history to be stored

      2. Default: true

      3. RECOMMENDATION: If LeanMode cannot be set to false, then set this to false to reduce disk usage

   3. StoreCodeLogs

      1. When true, causes storage of logs for code-services where logging is enabled

      2. Default: true

      3. RECOMMENDATION: If LeanMode cannot be set to false, then set this to false to reduce disk usage

   4. MaxCodeLogs

      1. Max. number of most recent code logs to keep

      2. Default: 25

      3. RECOMMENDATION: Leave as is

   5. MaxAuditTrailDays

      1. Number of days of audit trail to keep

      2. Default: 7

      3. RECOMMENDATION: Leave as is