Latency configuration

These Liberator configuration items allow Liberator to add timestamps to objects for the purpose of latency measurement.

Since Liberator is a Datasource application, you can also set the DataSource latency chain configuration items.

timestamp-field

timestamp-field specifies the name of a field into which Liberator adds a timestamp to objects for the purposes of latency measurement. The timestamp allows a client application to calculate the time taken for the record represented by the object to be transmitted to it from this Liberator. The Liberator only adds the timestamp-field, and the timestamp within it, to objects that don't already contain a field of that name.

When you want to measure the latency of data propagation through the Caplin Platform, you typically add a timestamp to updates within the component where the update records are first created — usually in the Integration Adapter that's the source of the data. Defining a timestamp-field for the Liberator allows objects that didn't originate from an Integration Adapter to be time stamped as well.

If you ensure that timestamp-field specifies the same field name as that used for the Integration Adapter's timestamps, Liberator won't add a second timestamp to objects received from the Integration Adapter, and it won't overwrite the objects' original timestamps.

This timestamping facility is independent of the latency chain timestamps, and it isn't controlled by the setting of the latency-chain-enable configuration item.

This configuration item is overridden by the timestamp-field option of add-object for that particular object only.

Timestamp format and precision
Liberator version Format Example
< 7.1 Milliseconds since 1 Jan 1970

1509967184123

7.1.0 Microseconds since 1 Jan 1970

1509967184123456

>= 7.1.1 Milliseconds since 1 Jan 1970 with a nanosecond fractional component

1509967184.123456789

Syntax: timestamp-field <field-name>

Type: string

Default value: no timestamp field is defined so Liberator does not add timestamps to any objects, apart from objects that have been defined by add-object and have the timestamp-field option specified.


See also: