liverig.properties

PropertyTypeDefaultSinceUOMValid ValuesRequires Property

data_path Root directory, where to look for the configuration (/conf) and where collected data will be written (/data).

string

/opt/intelie/liverig

1.0.0

enable_send_to_live Whether to send collected data to Intelie Live (when true) or save it locally only, for example on protocol conversion mode.

boolean

true

1.0.0

enable_webapp Enables the web application provision.

boolean

false

1.0.0

live.hostname Live access' hostname.

string

localhost

1.0.0

live.port Live access' port.

int

5034

1.0.0

live.username This collector's username to connect to Live.

string

live

1.0.0

live.password This collector's password to connect to Live.

string

1.0.0

live.ssl.enable Enables SSL connection to Live.

boolean

false

2.17.0

live.ssl.fingerprints SSL key fingerprints required for an SSL connection to Live.

string[]

2.17.0

live.backup.hostname Backup Live (secondary Live client) access' hostname.

string

5.20.0

live.backup.port Backup Live (secondary Live client used when main client is off) access' port.

int

0

5.20.0

live.backup.username This collector's username to connect to secondary Live (used when main client is off).

string

live

5.20.0

live.backup.password This collector's password to connect to secondary Live (used when main client is off).

string

5.20.0

live.backup.change.delay Delay (in milliseconds) to switch the events destination to backup Live.

long

60000

5.20.0

ms

live.backup.hostname

live.main.change.delay Delay (in milliseconds) to switch the events destination to main Live.

long

60000

5.20.0

ms

live.backup.hostname

connect_timeout The connection timeout.

long

30000

1.0.0

ms

reconnect_minimum_delay The minimum delay allowed on reconnections.

long

1000

1.0.0

ms

reconnect_maximum_delay The maximum delay allowed on reconnections.

long

60000

1.0.0

ms

compression Enables data compression with zlib. Modified during hello negotiation.

boolean

true

1.0.0

request_threads Maximum number of threads allowed to retrieve data.

int

64

1.0.0

hello_timeout How much can the connection wait before the source hello is received.

long

10000

1.0.0

ms

idle_timeout How much can the connection be idle before sending a keep-alive ping.

long

60000

1.0.0

ms

keep_alive_timeout How much can the connection wait before the answer to a keep-alive ping.

long

10000

1.0.0

ms

resend_request_queue_capacity Determines the length of a connection's resend request processing queue.

int

16

1.0.0

resend_rate The default resend rate value is a good one when running at the rig site. When collecting from many sources at once, this value should be increased.

long

1000

1.0.0

bytes/sec

enable_realtime Enables real time sync data.

boolean

true

1.0.0

realtime_fetch_limit Maximum time to fetch behind events when working in real time.

long

900000

1.0.0

ms

enable_realtime

realtime_fetch_tolerance Maximum time to fetch forward events when working in real time.

long

900000

1.0.0

ms

enable_realtime

enable_backlog Enables history data gathering.

boolean

false

1.0.0

backlog_fetch_limit The maximum time allowed to retrieve data when backlog enabled.

long

86400000

1.9.3

ms

enable_backlog

enable_backlog_history Enables the feature to retrieve backlog data within a start and end date.

boolean

false

2.14.0

history_execution_period The period factor that the backlog history will retrieve data.

long

1

2.14.0

enable_backlog_history

backlog_history_fetch_limit When backlog history is requested, this is the maximum fetch limit to retrieve by every history_execution_period.

long

900000

2.14.0

ms

enable_backlog_history

backlog_history_depth_fetch_limit_in_meters When backlog history is requested, this is the maximum fetch limit in depth meters to retrieve.

long

100

4.6.0

m

enable_backlog_history

backlog_history_remote_execution_period_in_seconds When backlog history is configured, this is the execution period to execute the request.

long

300

2.26.0

s

enable_backlog_history

enable_remote_control_backlog_sync Enables remote control for the backlog sync functionalities.

boolean

false

2.26.0

enable_remote_control Enables remote control for the collector's functionalities.

boolean

false

2.18.0

remote_control_max_threads Maximum number of threads allowed for the remote-control functionalities.

int

4

2.18.0

enable_remote_control

remote_control_queue_size Maximum queue of remote-control requests.

int

128

2.18.0

enable_remote_control

http_dump Enables dumping http requests to the standard output.

boolean

false

1.0.0

timestamp_adjustment_alpha Timestamp adjustment factor to compensate the difference between the real-world time and the source's clock.

double

0.01

1.0.0

timestamp_adjustment_limit The maximum difference allowed between the adjusted timestamp and the original one.

double

null

1.0.0

ms

time_travel This sets an offset time on the collector's clock.

long

0

1.6.0

ms

enable_lcd Enables the collector to display its status on an LCD screen.

boolean

true

2.7.0

lcd_type The LCD's messaging type.

string

ipmi

2.7.0

enable_lcd

crystalfontz_port If the lcd_type is crystalfontz, this will set the port to access it.

string

/dev/ttyLCD

2.7.0

lcd_type

crystalfontz_baud If the lcd_type is crystalfontz, this will set its baud rate.

string

115200

2.7.0

lcd_type

witsml_connect_timeout The connection timeout value for a WITSML source.

int

15000

1.0.0

ms

witsml_request_timeout The request timeout value for a WITSML source.

int

120000

1.0.0

ms

witsml_query_force_return_elements_all Enables forcing WITSML's getFromStore to return all elements.

boolean

false

1.4.1

witsml.certificates Base directory where the HTTPS certificates are stored for WITSML client source configuration. This is not mandatory.

string

/opt/intelie/liverig/conf/witsml

4.7.0

witsml.keystore File name for the client keystore containing client private key and certificate for HTTPS certificate-based authentications for WITSML client sources.

string

witsml.jks

4.7.0

witsml.keypass Password for the client keystore.

string

liverig

4.7.0

witsml.truststore File name of the trusted WITSML servers store file. This file should contain the certificates the client can trust. To disable the validation of server certificates, set the property ignore_invalid_witsml_certificate to true.

string

witsml-trust.jks

4.7.0

witsml.trustpass Password for the trusted servers keystore.

string

liverig

4.7.0

ignore_invalid_witsml_certificate Enables ignoring invalid certificates from WITSML servers.

boolean

false

2.19.0

opcua.applicationuri The OPC-UA source's server application URI.

string

null

2.12.0

opcua.securitymode.min The minimum endpoint security level required for the collector to try to connect to the OPC-UA server.

string

Sign

2.12.0

None, Sign or SignAndEncrypt

opcua.applicationuri

opcua.securitymode.max The minimum endpoint security level required for the collector to try to connect to the OPC-UA server.

string

2.12.0

None, Sign or SignAndEncrypt

opcua.applicationuri

opcua.securitypolicy.min The minimum endpoint security policy required by the collector to try to connect to the OPC-UA server.

string

Basic256Sha256

2.12.0

None, Basic128Rsa15, Basic256, Basic256Sha256, Aes128_Sha256_RsaOaep or Aes256_Sha256_RsaPss

opcua.applicationuri

opcua.securitypolicy.max The maximum endpoint security policy required by the collector to try to connect to the OPC-UA server.

string

2.12.0

None, Basic128Rsa15, Basic256, Basic256Sha256, Aes128_Sha256_RsaOaep or Aes256_Sha256_RsaPss

opcua.applicationuri

opcua.certificates Base directory for the OPC-UA certificates.

string

opcua

2.12.0

opcua.applicationuri

opcua.keystore Name of the OPC-UA key store.

string

opcua.jks

2.12.0

opcua.applicationuri

opcua.storetype OPC-UA Keystore Type

string

PKCS12

2.12.0

opcua.applicationuri

opcua.storepass OPC-UA Keystore password

string

liverig

2.12.0

opcua.applicationuri

opcua.keyalias OPC-UA's private key alias.

string

opcua

2.12.0

opcua.applicationuri

opcua.keypass OPC-UA's private key password.

string

liverig

2.12.0

opcua.applicationuri

opcua.queuesize Sets the OPC-UA's subscription queue size.

int

10

2.12.0

opcua.applicationuri

ignore_invalid_opc_certificate Enables ignoring invalid certificates from OPC-UA and OPC-DA servers.

boolean

false

2.23.0

enable_witsml_tree_event This Property was removed on Liverig 2.22.0

boolean

true

2.17.0

witsml_tree_event_period_seconds This Property was removed on Liverig 2.22.0

long

600

2.17.0

s

wildcard_period_in_seconds Sets the Wildcard Period if the Request does not contain it.

int

600

2.22.0

s

witsml_change_mechanism_feature Enables a mechanism for identifying change for data objects in a WITSML server

boolean

false

5.17.x

witsml_change_mechanism_delay_period_in_seconds The number of seconds for the client to detect a change in a growing data object.

int

0

5.17.x

s

witsml_change_mechanism_feature = true

witsml_change_mechanism_detection_period_in_seconds The number of seconds for the client delayed to start

int

10

5.17.x

s

witsml_change_mechanism_feature = true

witsml_change_mechanism_initial_last_change_feature Enables the use of a default initial lastChange when starts the feature

boolean

true

5.17.x

witsml_change_mechanism_feature = true

witsml_change_mechanism_late_channels_feature Allows to collect channels that arrive with low-frequency samples

boolean

false

5.17.x

witsml_change_mechanism_feature = true

witsml_change_mechanism_object_growing_feature Enables the use of object-growing queries when there aren't changed objects

boolean

false

5.17.x

witsml_change_mechanism_feature = true

witsml_change_mechanism_initial_last_change_in_minutes The number of minutes before now for use as the default last change for an initial request

int

1440

5.17.x

minutes

witsml_change_mechanism_feature = true

enable_revision

boolean

false

2.24.1

enable_revision_offset

boolean

false

2.25.0

log_rotate_hour Sets the hour of day to rotate Event logs.

int

4

2.18.1

minimum_diskspace_in_megabytes Minimum available disk space required to collector work properly. The collector is restarted whenever the available disk space is less than the minimum required.

int

20

2.24.0

MB

internal_events_period_in_seconds Period to compute and transmit the internal events reporting actual source configuration and basic server statistics to central sites.

int

60

4.7.0

s

internal_events_initial_delay_in_seconds The initial delay for the computation and transmission of internal events can be customized freely.

int

60

4.7.0

s

enable_config_only_on_first_internal Enables sending the internals configurationStatus field only on the first internal event sent. The configurationStatus field contains a HashCode representation of every configuration file from the Liverig Collector, reducing bandwidth consumption for collector remote control features.

boolean

false

5.0.0

serial_connect_timeout How much can the connection wait before retrying in case of failure when using a Serial Port. The amount of time waiting is proportional to the number of failed attempts and it is given by serial_connect_timeout multiplied by the minimum between amount of attempts failed and serial_max_retry_jump.

int

15000

4.7.1

ms

serial_max_retry_jump The maximum serial timeout connection multiplier.

int

8

4.7.1

Example

data_path=/opt/intelie/liverig

# if false, write output to local files in /opt/intelie/liverig/data
enable_send_to_live=true
# if true, enable local webapp for management; change the password in the login.properties file before enabling
enable_webapp=true
enable_remote_control=false

live.hostname=localhost
live.port=5034
live.username=live
live.password=

# Please copy the public key fingerprint from liverig-server to live.ssl.fingerprints below
live.ssl.enable=true
live.ssl.fingerprints=

connect_timeout=30000
reconnect_minimum_delay=1000
reconnect_maximum_delay=60000

compression=true
hello_timeout=10000
idle_timeout=60000
keep_alive_timeout=10000
resend_request_queue_capacity=16
resend_rate=1000
request_threads=64
http_dump=false

enable_realtime=true
# maximum ms to fetch behind when real time
realtime_fetch_limit=900000

enable_backlog=true

# Timestamp adjustment EWMA filter alpha value
#timestamp_adjustment_alpha=0.01
# Timestamp adjustment limit in ms (default value 2 * realtime_fetch_limit)
#timestamp_adjustment_limit=1800000

witsml_connect_timeout=15000
witsml_request_timeout=120000
wildcard_period_in_seconds=600

# LCD report via IPMI or Crystalfontz
#
# enable_lcd=true
# lcd_type=ipmi
# lcd_type=crystalfontz
# crystalfontz_port=/dev/ttyLCD
# crystalfontz_baud=115200

# WITSML Change mechanism features
#
# witsml_change_mechanism_feature=false
# witsml_change_mechanism_delay_period_in_seconds=0
#witsml_change_mechanism_detection_period_in_seconds=10
# witsml_change_mechanism_initial_last_change_feature=true
# witsml_change_mechanism_late_channels_feature=false
# witsml_change_mechanism_object_growing_feature=true
# witsml_change_mechanism_initial_last_change_in_minutes=10

Last updated