Common Block Config Fields

See The Blocks Section for an explanation of what a block is in the Cloud Gateway.

log_level

The log_level field determines which level of logs to output. If the field is not set to one of the following values, the block will not log anything. The values below are listed in order from most to least verbose:
  • debug
  • info
  • warn
  • err
  • critical

log_name

The log_name field defines a name to identify the block's logs. This is typically prepended to the log output and can be any string you wish to set it to. If unset, it defaults to the block's name.

mqtt/transport_addr

The transport_addr field within the mqtt section should be set to the URI of the MQTT broker you wish to receive data from.
Note: This field is not required for the Time Series Publisher block (as it defaults to "mqtt-tcp://predix-edge-broker"), but it IS currently required for the Event Hub Publisher block.
Note: Supported URI prefixes for the Time Series Publisher block include mqtt-tcp, mqtt, and tcp. However, the Event Hub Publisher block supports only mqtt-tcp as the URI prefix for this field.

mqtt/qos

The qos field within the mqtt section can be set to the desired "quality of service" for the block's MQTT subscriptions.

This field's value can be 0, 1, or 2. These values correspond to "at most once", "at least once", and "exactly once" message delivery from the MQTT broker to the block.

mqtt/client_id

The cliend_id field within the mqtt section can be set to the desired client ID for the block's MQTT subscriptions.

This client ID helps the MQTT broker to identify the block. If the Cloud Gateway is restarted, and during that restart, data is published to topics the block was subscribed to, the broker will be able to deliver that data to the block after the Cloud Gateway comes back up as long as it uses the same client ID.

mqtt/topics

The topics field within the mqtt section should be set to an array of strings denoting the topics that the block should subscribe to on the MQTT broker specified by the transport_addr field.

store_forward/max_store_percent

The max_store_percent field within the store_forward section should be set to the max percent of disk space that the block's store and forward functionality is allowed to use.
Note: This value may be reduced (proportionally to other blocks) at runtime if the total max_store_percent set by all of the blocks is too large.

store_forward/max_batch_interval

The max_batch_interval field within the store_forward section should be set to the desired maximum interval (in milliseconds) between batch publish requests.

If input data is not received quickly enough to fill the maximum batch size for the respective block, the current batch will be completed at this interval (regardless of its size) and stored or sent according to the type of block and store forward functionality.