Skip to main content
Version: V3.2

Syncer

tip

If you don't see this page, you need to enable the Advanced options toggle in the top right.

The Syncer controls where locally stored data is sent. In most deployments, the destination is the Capture platform Data API.

note

Syncing is configured per destination. You can add multiple destinations and choose between Batch and Realtime delivery.

Destinations tab​

The Destinations tab lists all configured sync destinations.

  • Select a destination to edit its settings.
  • Use + to add a new destination.
  • Use the three dots menu on a destination to Duplicate or Delete it.
warning

You cannot delete the last remaining destination.

Add a destination​

Select + and choose one of:

  • Batch sync destination
  • Realtime sync destination
tip

Use Batch for reliable, complete uploads to the cloud. Use Realtime only for time-critical signals.

Batch sync destination​

Batch sync uploads points (or files) in chunks to a destination endpoint (typically the Capture Data API).

important

Batch sync is the primary mechanism for complete, reliable cloud synchronization.

Min points measurement switch​

After sending this many points for a single measurement (table), the Syncer switches to the next measurement.

  • Use this to prevent one high-volume measurement from monopolizing upload time.

Min points to sync​

If a measurement has fewer than this number of points ready, the Syncer skips it for now to avoid many small uploads.

note

If enough time passes, the measurement is uploaded anyway: after 3 × Sync delay (configured on the Advanced tab), pending points will be uploaded even if the threshold is not reached.

Delete local files after syncing​

Only applies when syncing files (instead of points).

  • Enabled: Capture deletes files after they are successfully synced.
  • Disabled: an external system is responsible for file retention/cleanup.

Measurements to sync​

Choose which measurements are uploaded by this destination:

  • Sync everything: upload all measurements.
  • Select specific measurements: upload only a chosen subset.

Extra measurements (tables)​

Use Extra to sync measurements that exist in local storage but do not have Collector configuration.

Examples:

  • Monitoring (automatically created)
  • any custom table receiving data from outside Capture

Each Extra entry associates:

  • a retention policy / bucket selection
  • the measurement (table) name to upload
tip

Use Extra for “out-of-band” data that lands in the local database through external processes, but still needs to be uploaded.

Realtime sync destination​

Realtime sync streams points to an endpoint as they are produced.

warning

Realtime sync is not a replacement for batch sync. Use it for time-critical variables only.

Destination type​

Type of realtime endpoint.

note

Currently, only MQTT is supported for realtime syncing.

Queue capacity​

Maximum number of points held in the realtime queue for this destination.

  • If the queue is full, no new points are added to the realtime queue.
  • Points are not attempted for realtime syncing again until there is space in the queue.
note

Points are still stored in the local database and remain eligible for batch sync, unless you enable Skip local database.

Max send threads​

How many threads upload points to this realtime destination concurrently.

Skip local database​

If enabled, a point that is successfully queued for realtime syncing is not stored in the local database.

danger

This reduces safety: when the point is queued, but the Collector process is killed, or the system is shut down, these points are lost. The safest configuration is:

  • store points locally, and
  • upload them via batch sync as well.

Only consider skipping local storage when upload volume or disk storage is a hard constraint and the risk of loss is acceptable.

Authentication​

Controls which credentials are used to authenticate against the endpoint.

  • Use Capture credentials: use Capture environment credentials (when the endpoint is a Capture environment).
  • Disabled: provide custom credentials (username/password).

Variables to sync (Realtime)​

Choose what is streamed in real time:

  • Sync everything: stream all measurements/variables (not recommended).
  • Select subset: stream only specific measurements and/or variables.
tip

Enable realtime syncing only for time-critical variables (for example, live dashboards) and avoid enabling it for high-volume signals.

Advanced tab​

The Advanced tab controls global sync behavior.

Sync delay (seconds)​

How many seconds old data must be before it is considered for upload.

important

The Syncer will not go back in time. Set Sync delay high enough to ensure all data for a moment has arrived before upload. This matters when sources have clocks that are not fully reliable.

note

If Sync delay is too high, new data will appear in the Capture portal later than necessary. Use Realtime for time-critical visibility instead of pushing Sync delay too low.

Workers​

How many threads upload in parallel (batch sync workers).

Network adapter constraints​

Network adapter constraints allow you to restrict uploads for specific buckets to only occur when a specific network adapter is connected.

Configuration per rule:

  • Bucket: the bucket to which the rule applies
  • Network adapter: adapter name that must be present and connected to upload
  • Fallback time (optional): if the adapter is not online after this duration, upload anyway
  • Fallback duration (optional): how long uploads are allowed during fallback

Supported units for Fallback time and Fallback duration:

  • ms, s, m, h, d
note

Leave fallback fields empty to disable fallback behavior entirely.