Re: Phoebus connection to alarm server / Kafka

[Ian Gillingham via Tech-talk <tech-talk at aps.anl.gov>]

Hi Kay,

That's super useful guidance - thank you.

To configure the GUI (in this case on Windows), should I set the "org.phoebus.applications.alarm/config_name=... " parameter in settings.ini or a .properties file? Do I need to add a runtime parameter to point Phoebus at the config file?

Thanks,

Ian

-----Original Message-----

From: "Kasemir, Kay" <kasemirk at ornl.gov>

To: ian.gillingham at gmail.com <ian.gillingham at gmail.com>, tech-talk at aps.anl.gov <tech-talk at aps.anl.gov>, "Gotz, Malte" <malte.gotz at helmholtz-berlin.de>

Subject: Re: Phoebus connection to alarm server / Kafka

Date: Tue, 28 Jun 2022 12:22:19 +0000

 P {margin-top:0;margin-bottom:0;}

Note that you can share the same Kafka server for multiple alarm setups.

Depending on your overall infrastructure, you can decide to either have one central kafka setup, so all the alarm tools (server, GUI) point to that one:

org.phoebus.applications.alarm/server=the_one_kafka_server.mysite.org:9092

On that server, you create the alarm topics for say "Accelerator", "Cryo", "Facilities".

For each one, you start an alarm server. The alarm server has a command-line option to select "Accelerator" or "Cryo" or "Facilities", seehttps://github.com/ControlSystemStudio/phoebus/blob/500069034bda5b64a191df55b9ac709bd13b2278/services/alarm-server/src/main/java/org/phoebus/applications/alarm/server/AlarmServerMain.java#L537

For the GUI, you have two options. You can either do this:

# Start with "Accelerator" as the default for newly opened Alarm Table and Alarm Tree:

org.phoebus.applications.alarm/config_name=Accelerator

# .. but allow selecting any of the three setups via a drop-down on the alarm table & tree:

org.phoebus.applications.alarm/config_names=Accelerator, Cryo, Facilities

Or you do this:

# Start with "Accelerator" as the default for newly opened Alarm Table and Alarm Tree:

org.phoebus.applications.alarm/config_name=Accelerator

# .. and don't allow changing that:

org.phoebus.applications.alarm/config_names=

So possible options include:
a) Run one Kafka server for your site, which may be shared with other tools that use Kafka

b) Run one Kafka server per alarm setup, and use it only for that.

Kinda like running MySQL or Oracle, where you typically share it with a variety of applications, but you can also run an instance just for one app.

You _always_ need to run one alarm server per configuration.

On the GUI side, you can then decide to

a) Allow access to multiple alarm setups, operators can select at runtime

b) Lock the CS-Studio GUI for the main control room to "Accelerator", the one for the cryo control room to "Cryo" etc.

-Kay

From: Tech-talk on behalf of Gotz, Malte via Tech-talk

 

this: https://control-system-studio.readthedocs.io/en/latest/preference_properties.html#preference-settings

is an overview of all the preferences available for Phoebus, I like to use as a reference. Luckily, alarm is at the very top.

You need to preface the property with the package. So, create a settings file with:

org.phoebus.applications.alarm/server=your.host.com:9092

org.phoebus.applications.alarm/config_name=YourTopic

org.phoebus.applications.alarm/config_names=YourTopic, YourOtherTopic

 

and pass it to Phoebus with -settings your-settings.ini

 

 

Von: Tech-talk <tech-talk-bounces at aps.anl.gov> Im Auftrag von Ian Gillingham via Tech-talk

 

I now need to modify it for my own requirements and have used the phoebus/app/alarm/examples/create_alarm_topics.sh script to create a new topic.

 

I will have Phoebus clients running on Windows machines (on the same network).

 

Is someone able to point me at the documentation as to where to edit Phoebus configuration to tell it which host:port to connect to for the alarm server (running on a single Linux box) and to change the Kafka topic?

Attachment: signature.asc
Description: This is a digitally signed message part