Sinks
Sinks are connections to endpoints for which
forwarders
can be configured to stream points and events to.
Currently 2 types of sinks are supported:
To create a sink:
- navigate to
configuration>sinks - click
Create sinkin the top-right corner
This will take you to a screen to configure a new sink.
- Enter a unique name
- Optionally enter a description
- Select a sink type
SparkplugB
- Enter a NodeID to connect to
- Enter a GroupID to connect to
- Enter the URL of the MQTT broker to connect to
- Enter the client certificate file location if applicable
- Enter the client key file location if applicable
- Enter the username
- Enter the password
- Enter the keep alive period(in seconds)
- Optionally, enter the max amount of metrics to send per message. By default this is set to 0, which means no limit.
- Optionally toggle DataOnly mode. When enabled no birth or death messages will be sent, only data messages will be sent.
- Optionally enable the buffer, if enabled, the sink will buffer messages when the MQTT broker is not reachable.
- Optionally configure the buffer settings:
- Process interval (in milliseconds): The interval at which the buffer is processed.
- Max batch size: The maximum number of messages in a batch, the batch size determines how many messages are sent in one go.
- Max batches: The maximum amount of batches to keep in memory, when the maximum is reached a batch will be saved to disk if the disk queue is enabled and there is space available.
- Disk batches: The maximum amount of batches to write to a single file on disk
- Min free disk space: The minimum amount of free disk space required to write a batch to disk, if the free disk space is below this value, the sink will not write batches to disk and will drop batches instead.
- Max disk space: The maximum amount of disk space to use for the buffer, if the maximum is reached, the sink will drop batches instead of writing them to disk.
- Enable disk queue: If enabled batches will be written to disk when the maximum amount of batches in memory is reached or the application is stopped.
Generic MQTT
- Enter the URL of the MQTT broker to connect to
- Enter the client certificate file location if applicable
- Enter the client key file location if applicable
- Enter the username
- Enter the password
- Enter the QOS with which to publish
- Enter the keep alive period(in seconds)
- Optionally enable the buffer, if enabled, the sink will buffer messages when the MQTT broker is not reachable.
- Optionally configure the buffer settings:
- Process interval (in milliseconds): The interval at which the buffer is processed.
- Max batch size: The maximum number of messages in a batch, the batch size determines how many messages are sent in one go.
- Max batches: The maximum amount of batches to keep in memory, when the maximum is reached a batch will be saved to disk if the disk queue is enabled and there is space available.
- Disk batches: The maximum amount of batches to write to a single file on disk
- Min free disk space: The minimum amount of free disk space required to write a batch to disk, if the free disk space is below this value, the sink will not write batches to disk and will drop batches instead.
- Max disk space: The maximum amount of disk space to use for the buffer, if the maximum is reached, the sink will drop batches instead of writing them to disk.
- Enable disk queue: If enabled batches will be written to disk when the maximum amount of batches in memory is reached or the application is stopped.
