-
Notifications
You must be signed in to change notification settings - Fork 0
Running drunc
Pierre Lasorak edited this page Jun 12, 2024
·
8 revisions
You will need 1 terminal windows open, and have drunc setup (by sourcing the same env.sh from the DAQ dev area explained here).
This shell will be used to run the process manager, the process manager CLI and root controller CLI:
drunc-unified-shell file://<where_drunc_is>/data/process-manager-CERN-kafka.json ## or data/process-manager-no-kafka.json or data/process-manager-pocket-kafka.json
<snip>
ProcessManager was started on 0.0.0.0:10054
drunc-unified-shell >Now let us start the DAQ processes, it will send a message to the process manager:
drunc-unified-shell > boot test/config/test-sesssion.data.xml test-session # to run the appdal configuration in [here](https://github.com/DUNE-DAQ/appdal/blob/develop/test/config/test-session.data.xml)
drunc-unified-shell > ps
Processes running
┏━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━━━┓
┃ session ┃ user ┃ friendly name ┃ uuid ┃ alive ┃ exit-code ┃
┡━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━━━━━┩
│ session-name │ plasorak │ dataflow0 │ 15f32283-b920-4e0b-9746-ea146f2889ad │ True │ 0 │
│ session-name │ plasorak │ dfo │ 498bf1e6-78a5-42a1-a429-2b56c5e942ae │ True │ 0 │
│ session-name │ plasorak │ fakehsi │ d9a471da-acde-47ae-abe3-98d7f5c1abaa │ True │ 0 │
│ session-name │ plasorak │ rulocalhosteth0 │ fc76d990-d32d-44ce-be98-f45c28e1c4cd │ True │ 0 │
│ session-name │ plasorak │ trigger │ b3082787-3039-4df9-bcf9-3d137bea8faf │ True │ 0 │
│ session-name │ plasorak │ root-controller │ 81901dc8-3417-4870-8ea4-d222fd9a9e12 │ True │ 0 │
│ ... │ ... | ... | ... | ... | ... |
└──────────────┴──────────┴─────────────────┴──────────────────────────────────────┴───────┴───────────┘We have started a couple of processes, the standard DAQ applications, and a root-controller that will control them. The logs and work directory is the ${PWD} where you executed the drunc-unified-shell.
To kill the processes, you can do
drunc-unified-shell > kill --user plasorak
# or
drunc-unified-shell > kill --session test-session
# or
drunc-unified-shell > kill --name dfoThere are many more functionalities to the shell, head over to the process manager CLI documentation to see how to interact with it.
Next, let's send commands to the root-controller. These commands will be propagated by it to other applications, to see which application a controller controls, you can use ls:
drunc-unified-shell > ls
['ru-controller', 'df-controller', 'trg-controller', 'hsi-controller']drunc-unified-shell > describe
root-controller.test-session (controller) commands
┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ name ┃ input type ┃ return type ┃ help ┃
┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ describe │ None │ request_response_pb2.Description │ Describe self (return a list of commands, the type of endpoint, the │
│ │ │ │ name and session). │
│ get_children_status │ generic_pb2.PlainText,None │ controller_pb2.ChildrenStatus │ Get the status of all the children. Only get the status from the │
│ │ │ │ child if provided in the request. │
│ get_status │ None │ controller_pb2.Status │ Get the status of self │
│ ls │ None │ generic_pb2.PlainTextVector │ List the children │
│ describe_fsm │ None │ request_response_pb2.Description │ List available FSM commands for the current state. │
│ execute_fsm_command │ controller_pb2.FSMCommand │ controller_pb2.FSMCommandResponse │ Execute an FSM command │
│ include │ None │ controller_pb2.FSMCommandResponse │ Include self in the current session, if a children is provided, │
│ │ │ │ include it and its eventual children │
│ exclude │ None │ controller_pb2.FSMCommandResponse │ Exclude self in the current session, if a children is provided, │
│ │ │ │ exclude it and its eventual children │
│ take_control │ None │ generic_pb2.PlainText │ Take control of self and children │
│ surrender_control │ None │ generic_pb2.PlainText │ Surrender control of self and children │
│ who_is_in_charge │ None │ generic_pb2.PlainText │ Get who is in control of self │
└─────────────────────┴────────────────────────────┴───────────────────────────────────┴─────────────────────────────────────────────────────────────────────┘
drunc-unified-shell > describe --command fsm
root-controller.test-session (controller) commands
┏━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━┓
┃ name ┃ input type ┃ return type ┃ help ┃ Command arguments ┃
┡━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━┩
│ conf │ controller_pb2.FSMCommand │ controller_pb2.FSMCommandResponse │ │ │
└──────┴───────────────────────────┴───────────────────────────────────┴──────┴───────────────────┘
drunc-unified-shell > fsm conf
<snip>
conf execution report
┏━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
┃ Name ┃ Command execution ┃ FSM transition ┃
┡━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
│ root-controller │ success │ success │
│ hsi-controller │ success │ success │
│ hsi-01 │ success │ success │
│ ru-controller │ success │ success │
│ ru-01 │ success │ success │
│ trg-controller │ success │ success │
│ tc-maker-1 │ success │ success │
│ mlt │ success │ success │
│ hsi-to-tc-app │ success │ success │
│ df-controller │ success │ failed │
│ tp-stream-writer │ success │ success │
│ df-01 │ success │ success │
│ df-02 │ success │ success │
│ dfo-01 │ failed │ failed │
└──────────────────────┴───────────────────┴────────────────┘
drunc-unified-shell > describe --command fsm
topcontroller.session-name (controller) commands
┏━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ name ┃ input type ┃ return type ┃ help ┃ Command arguments ┃
┡━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ start │ controller_pb2.FSMCommand │ controller_pb2.FSMCommandResponse │ │ run_number (INT OPTIONAL) default: 1 help: │
│ │ │ │ │ disable_data_storage (BOOL OPTIONAL) default: False help: │
│ │ │ │ │ trigger_rate (FLOAT OPTIONAL) default: 1.0 help: │
│ scrap │ controller_pb2.FSMCommand │ controller_pb2.FSMCommandResponse │ │ │
└───────┴───────────────────────────┴───────────────────────────────────┴──────┴────────────────────────────────────────────────────────────┘
drunc-unified-shell > fsm startEtc.
Let's take the DAQ for a spin:
drunc-unified-shell > fsm enable_triggers
[...we wait for a bit of time, to get a file...]
drunc-unified-shell > fsm disable_triggers
drunc-unified-shell > fsm drain_dataflow
drunc-unified-shell > fsm stop_trigger_sources
drunc-unified-shell > fsm stop
drunc-unified-shell > fsm scrapSeveral things to note:
- There is a profusion of logging that happens. This is coming from the asynchronous logging from the controller. If someone tries to connect at the same time or to execute a command you will see it appearing on your shell too (you can try it yourself in a different shell). Unfortunately CLIs do not lend itself very well with this, and one needs a better UI for the logs to be rendered better and to not distract.
- The
describecommand describes the endpoint NOT the shell. This means that there are some commands that are not directly available in the shell (for exampleget_children_status). However if you dostatusis the shell, you will get the children statuses because the shell callsget_children_statusunder the hood. - The sequence commands (
start_run,shutdownetc.) are not available (yet). This means if youstartthe run, you will need to manuallydrain_dataflow,stop_trigger_sourcesandstop.
You can now head to the controller CLI documentation for more information.
drunc-unified-shell > kill --session test-session
drunc-unified-shell > quit