Phoebus alarm logger

services.phoebus-alarm-logger
services.phoebus-alarm-logger.enable boolean[source]

Whether to enable the Phoebus Alarm logger.

The alarm logging service records all alarm messages to create an archive of all alarm state changes and the associated actions.

Default value
false
Example
true
services.phoebus-alarm-logger.openFirewall boolean[source]

Open the firewall for the Phoebus Alarm Logger service.

Warning

This opens the firewall on all network interfaces.

Default value
false
services.phoebus-alarm-logger.settings attribute set of (string, package, bool, int or float)[source]

Configuration for the Phoebus Alarm Logger.

These options will be put into a .properties file.

Note that options containing a “.” must be quoted.

Available options can be seen here: https://github.com/ControlSystemStudio/phoebus/blob/master/services/alarm-logger/src/main/resources/application.properties

Default value
{ }
services.phoebus-alarm-logger.settings."bootstrap.servers" string[source]

Location of the Kafka server

services.phoebus-alarm-logger.settings."server.port" 16 bit unsigned integer; between 0 and 65535 (both inclusive)[source]

Port for the Alarm Logger service

Default value
8080
services.phoebus-alarm-logger.settings.alarm_topics list of string[source]

Alarm topics to be logged

Default value
[
  "Accelerator"
]
services.phoebus-alarm-logger.settings.date_span_units one of "D", "W", "M", "Y"[source]

Units of the indices date span.

Can be Days (D), Weeks (W), Months (M), Years (Y).

Default value
"M"
services.phoebus-alarm-logger.settings.es_create_templates boolean[source]

Automatically create the index templates needed

Default value
true
services.phoebus-alarm-logger.settings.es_host string[source]

Elasticsearch server host

Default value
"localhost"
services.phoebus-alarm-logger.settings.es_port 16 bit unsigned integer; between 0 and 65535 (both inclusive)[source]

Elasticsearch server port

Default value
config.services.elasticsearch.port
services.phoebus-alarm-logger.settings.es_sniff boolean[source]

Use the Elasticseach sniff feature

Default value
false
services.phoebus-alarm-logger.settings.thread_pool_size positive integer, meaning >0[source]

Size of the thread pool for message and command loggers.

Two threads per topic/configuration are required.

Default value
config.services.elasticsearch.port