Status Page: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
{{Pagelinks}}
* [[Midas_documentation|Midas Documentation]]
* [[Feature_listing|Feature Listing]]
* [[Application_listing|Application Listing]]
* [[Online_Database|Online Database]]
</div>


= Links =
= Links =
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
{{mhttpdpages}}
* [[Mhttpd|mhttpd MIDAS web server]]
* [[ODB Page]]
* [[Programs Page]]
* [[Alarms Page]]
* [[MSCB Page]]
* [[History Page]]
* [[Custom Page]]
* [[odbedit]]
</div>


= Purpose =
= Purpose =
Line 22: Line 8:


= Access the status page =
= Access the status page =
To connect to the MIDAS web server [[mhttpd]] status page for an experiment see  [[mhttpd#Usage|Usage]]. An example of the status page is shown [[#Example Status Page|below]]. By default, if [[mhttpd]] is running, anyone can access the experiment through the web.
If the MIDAS web server [[mhttpd]] is running, the experiment can be accessed from the web (see  [[mhttpd#Usage|usage]]). An example of the status page is shown in [[#Figure 1|Figure 1]]. By default, anyone can access the experiment via the web.
The user may set up web access restrictions to their experiment (see [[Security]]).
Web access restrictions to the experiment can be set by the user (see [[Security]]).


= Page Refresh =
= Status Page Refresh =
It is important to note that the refresh of the Status Page is not "event driven" but is controlled by a timer whose rate is adjustable through the Config button. This means the information at any given time may reflect the experiment state of up to n seconds in the past, where n is the timer setting of the refresh parameter.
It is important to note that the refresh of the Status Page is not "event driven" but is controlled by a timer whose rate is adjustable through the [[Config Page]].
 
This means the information at any given time may reflect the experiment state of up to n seconds in the past, where n is the timer setting of the refresh parameter.
 
= Example Status Page =
[[File:status_page.png|Main status page of pol experiment]]


<div id="Figure 1"></div>
= Features of the status page =
{|  style="text-align: left; width: 100%; background-color: rgb(255, 255, 255);" border="0" cellpadding="2" cellspacing="2"


= Features of the status page =
|-
| [[File:status_page.png|thumb|left|Figure 1: Example of status page]] <div style="clear: both"></div> Click image to enlarge
| colspan="1" rowspan="1" style="vertical-align: top; background-color: white; font-weight: normal;"|
The status page is divided into several parts
The status page is divided into several parts
* Menu Buttons
* Menu Buttons
Line 41: Line 29:
* Run Status information
* Run Status information
** Optional display of status items
** Optional display of status items
** Optional Run Description and Comment
** Last system message
** Last system message
* Equipment Information and Event rates
* Equipment Information and Event rates
* Data Logging Information
* Data Logging Information
* Active client list
* Active client list
|}


<div style="clear: both"></div>
<div id="suppressed"></div> <div id="page-switch-buttons"></div>  <!-- Anchor page-switch-buttons and suppressed-->
== Menu Buttons ==
The top row of Menu buttons on the main status page [[#Figure 1|Figure 1]] include the '''run control buttons''' (Start/Stop/Pause/Resume depending on the run state) and the '''page switch buttons''' (e.g. ODB, Messages, Elog, Alarms, Programs, History, Sequencer, MSCB, Chat, Help). Clicking on a page switch button will replace the Status page with the requested page. The pages may contain a
<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">Status</span> button to return to the Status page (see [[#Select visible menu buttons|select visible menu buttons]], or the browser "Back" button can be used.


For the <span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">Config</span> button see [[#Page Refresh|page refresh]].


== Menu Buttons ==
=== Select visible menu buttons ===
The top row of Menu buttons on the main status page include the run control buttons (Start/Stop/Pause/Resume depending on the run state) and the page switch buttons (e.g. Messages, Elog, Alarms, Programs, History, Sequencer, MSCB, Help). Clicking on a page switch button will replace the Status page with the requested page. All the pages contain a Status button to return to the Status page. The ODB button allows the user to access and edit the ODB and the Config button allows the Status page refresh time to be changed.
Not all the available buttons may be visible on the status and other pages.
Keys in the [[/Experiment ODB tree]] control which menu buttons are visible. The user may customize these by '''hiding unneeded buttons'''. The [[/Experiment ODB tree#Menu Buttons|Menu Buttons]] key lists the buttons to appear on the page. By default, the Status button is not visible on subpages, but can be made so by adding "Status" to this key.


Not all the available buttons may be visible on the main status page. For example, the MSCB button will only be visible if MSCB support has been built into Midas. Keys in the [[/Experiment ODB tree]] controls which menu buttons are visible on the status page. The user may change these as required. The [[/Experiment ODB tree#Menu Buttons|Menu Buttons]] key lists the buttons to appear on the page. The Start/Stop buttons and Pause/Resume buttons may be suppressed using the [[/Experiment ODB tree#Start-Stop Buttons|Start-Stop Buttons]] and [[/Experiment ODB tree#Pause-Resume Buttons|Pause-Resume Buttons]] keys respectively.
Sometimes it is desirable to stop users from starting/stopping or pausing/resuming runs, and this can easily be done by hiding the
appropriate buttons.
The Start/Stop buttons and Pause/Resume buttons may be suppressed using the [[/Experiment ODB tree#Start-Stop Buttons|Start-Stop Buttons]] and [[/Experiment ODB tree#Pause-Resume Buttons|Pause-Resume Buttons]] keys respectively
 
Note that the
<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">MSCB</span> button
will only be visible if MSCB support has been built into Midas.


== Optional Buttons ==
== Optional Buttons ==
Below the Menu Buttons, there may be up to three rows of optional user-added buttons. These may include
On the Status page ([[#Figure 1|Figure 1]]), below the Menu Buttons, there may be up to three rows of optional user-added buttons. These may include
* [[/Script ODB tree#Script-button|script-buttons]]
* [[/Script ODB tree#Script-button|script-buttons]]
* [[Frontend user code#Manual Trigger|manually-triggered event]] buttons
* [[Frontend user code#Manual Trigger|manually-triggered event]] buttons
* [[/Alias ODB tree#Alias-Button|alias-buttons]] and [[/Custom ODB tree#Custom-Button|custom-buttons]]
* [[/Alias ODB tree#Alias-Button|alias-buttons]] and [[/Custom ODB tree#Custom-Button|custom-buttons]]


In the [[#Example|example]],
In [[#Figure 1|Figure 1]],
<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">test</span> is a script-button,
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">test</span> is a script-button,
Line 66: Line 70:
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">ppg-cycle</span> is a custom-button, the other buttons on the line are all alias-buttons.
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">ppg-cycle</span> is a custom-button, the other buttons on the line are all alias-buttons.


== Alarm Banner ==
[[File:status_page_alarm.png|thumb|left|Figure 2: Example of status page with alarm banner]]


== Run Status Information ==
The alarms (see [[Alarm System]]) are configured using the [[Alarms Page]]. If an alarm is triggered, a banner appears on the status page as shown in Figure 2.
The run status information displays important information, such as the run status, alarm system status and data directory. The run may also be started/stopped using the button provided. The colour or information changes depending whether the run is active or not (e.g. run elapsed time or run stop time). By default, the experiment name is also shown here. The user may choose to display other useful information in this area (see [[/Experiment ODB tree#Status items subtree|Status items]].


The last item in this area is a one-line display of the last Midas message. More messages can be viewed on the Message page.
The alarm may be reset with the
<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">Reset</span> button on the banner (or on the [[Alarms Page]]). However, unless the alarm condition is resolved, the alarm will be triggered again at an interval given by [[/Alarms ODB tree#Check interval|Check interval]], causing the alarm banner to reappear.  To see which alarm(s) have triggered, check the [[Alarms Page]].


== Equipment Information ==
The alarm message and colour of the banner are configured in the ODB [[/Alarms ODB tree#<alarm-name> subtree|/Alarms/<alarm-name>]] and [[/Alarms ODB tree#<class-name> subtree|/Alarms/<class-name>]] subtrees respectively.
This area shows the status (by colour) of any  [[Frontend Operation#Equipments in Frontend|defined Equipments]] (unless [[/Equipment ODB tree#Hidden|hidden]]). If Hidden equipments are present, they may also be displayed by clicking on the "+" link above the equipment names.  This area also displays the number of events sent, the event rate and the data rate. These values are found in the [[/Equipment ODB tree#Statistics|Statistics subtree]] for each Equipment.


The names of the equipments
<div style="clear: both"></div>
are links to the <span style="color: purple; font-style:italic;">/Equipment/<equipment-name>/Variables</span> subtree. If the Equipment sends data to the ODB (see [[/Equipment ODB tree#Log history|Log History]] and  [[Equipment List Parameters#ReadOn|RO_ODB flag]]), clicking on this link will display the contents of the <span style="color: purple; font-style:italic;">/Equipment/<equipment-name>/Variables</span> subtree  with the name of each variable if the [[/Equipment ODB tree#<Names> subtree|<Names> subtree]] has been set up as shown below:
== Run Status Information ==
The{{Spacer|blank=a}}{{Banner|name=Run Status}}{{Spacer|blank=a}} information on the status page ([[#Figure 1|Figure 1]]) displays important information, such as the run status, alarm system status and data directory. The run may also be started/stopped using the button provided. The colour or information changes depending whether the run is active or not (e.g. run elapsed time or run stop time). By default, the experiment name is also shown here. The user may choose to display other useful information in this area (see [[/Experiment ODB tree#Status items subtree|Status items]].


The last item in this area is a one-line display of the last Midas message. More messages can be viewed on the Message page by clicking
<span style="color: #444444; background-color: #CCCCCC; font-style:italic; font-size: 90; padding:0.25em;
padding-left: 0.5em;padding-right: 0.5em;border:1px solid #808080;border-radius: 5px;margin-bottom:1px;">Message</span>.


[[File:status_variables.png|Display of Info Equipment variables]]
== Equipment Information ==
<div style="clear: both"></div>
The{{Spacer|blank=a}}{{Banner|name= Equipment}}{{Spacer|blank=a}} area on the status page ([[#Figure 1|Figure 1]]) shows the status (by colour) of any  [[Frontend Operation#Equipments in Frontend|defined Equipments]] (unless [[/Equipment ODB tree#Hidden|hidden]]). If Hidden equipments are present, they may also be displayed by clicking on the "+" link above the equipment names. This area also displays the number of events sent, the event rate and the data rate. These values are found in the [[/Equipment ODB tree#Statistics|Statistics subtree]] for each Equipment.


The names of each equipments is a link to the relevant [[Equipment page]], which displays any Variables related to that equipment.


== Logging Channels ==
== Logging Channels ==
This section contains a display of the status of open [[Keys in the /Logger/Channels ODB subtree#logging channels]], number of events logged, disk usage etc.
The{{Spacer|blank=a}}{{Banner|name=Logging Channels}}{{Spacer|blank=ab} section on the status page ([[#Figure 1|Figure 1]]) contains a display of the status of open [[Keys in the ODB /Logger/Channels subtree#Multiple Logging Channels|logging channels]], number of events logged, disk usage etc.


== Clients ==
== Clients ==
The names of the clients currently running are listed in the clients' section.
The {{Spacer|blank=a}}{{Banner|name= Clients }}{{Spacer|blank=b}} area on the status page ([[#Figure 1|Figure 1]]) displays
the names of the clients that are currently running.  


[[Category:mhttpd]]
[[Category:mhttpd Pages]]
[[Category:alarms]]
[[Category:ODB]]
[[Category:Programs]]

Latest revision as of 14:32, 11 October 2023


Links


Purpose

The purpose of the mhttpd status page is to allow the user to control and monitor the experiment.

Access the status page

If the MIDAS web server mhttpd is running, the experiment can be accessed from the web (see usage). An example of the status page is shown in Figure 1. By default, anyone can access the experiment via the web. Web access restrictions to the experiment can be set by the user (see Security).

Status Page Refresh

It is important to note that the refresh of the Status Page is not "event driven" but is controlled by a timer whose rate is adjustable through the Config Page. This means the information at any given time may reflect the experiment state of up to n seconds in the past, where n is the timer setting of the refresh parameter.

Features of the status page

Figure 1: Example of status page
Click image to enlarge

The status page is divided into several parts

  • Menu Buttons
    • Run Control buttons
    • Page Switch Buttons
    • Optional (user-defined) buttons
  • Run Status information
    • Optional display of status items
    • Last system message
  • Equipment Information and Event rates
  • Data Logging Information
  • Active client list

Menu Buttons

The top row of Menu buttons on the main status page Figure 1 include the run control buttons (Start/Stop/Pause/Resume depending on the run state) and the page switch buttons (e.g. ODB, Messages, Elog, Alarms, Programs, History, Sequencer, MSCB, Chat, Help). Clicking on a page switch button will replace the Status page with the requested page. The pages may contain a Status button to return to the Status page (see select visible menu buttons, or the browser "Back" button can be used.

For the Config button see page refresh.

Select visible menu buttons

Not all the available buttons may be visible on the status and other pages. Keys in the /Experiment ODB tree control which menu buttons are visible. The user may customize these by hiding unneeded buttons. The Menu Buttons key lists the buttons to appear on the page. By default, the Status button is not visible on subpages, but can be made so by adding "Status" to this key.

Sometimes it is desirable to stop users from starting/stopping or pausing/resuming runs, and this can easily be done by hiding the appropriate buttons. The Start/Stop buttons and Pause/Resume buttons may be suppressed using the Start-Stop Buttons and Pause-Resume Buttons keys respectively.

Note that the MSCB button will only be visible if MSCB support has been built into Midas.

Optional Buttons

On the Status page (Figure 1), below the Menu Buttons, there may be up to three rows of optional user-added buttons. These may include

In Figure 1, test is a script-button, ppg-cycle is a custom-button, the other buttons on the line are all alias-buttons.

Alarm Banner

Figure 2: Example of status page with alarm banner

The alarms (see Alarm System) are configured using the Alarms Page. If an alarm is triggered, a banner appears on the status page as shown in Figure 2.

The alarm may be reset with the Reset button on the banner (or on the Alarms Page). However, unless the alarm condition is resolved, the alarm will be triggered again at an interval given by Check interval, causing the alarm banner to reappear. To see which alarm(s) have triggered, check the Alarms Page.

The alarm message and colour of the banner are configured in the ODB /Alarms/<alarm-name> and /Alarms/<class-name> subtrees respectively.

Run Status Information

The a space Run Status space a information on the status page (Figure 1) displays important information, such as the run status, alarm system status and data directory. The run may also be started/stopped using the button provided. The colour or information changes depending whether the run is active or not (e.g. run elapsed time or run stop time). By default, the experiment name is also shown here. The user may choose to display other useful information in this area (see Status items.

The last item in this area is a one-line display of the last Midas message. More messages can be viewed on the Message page by clicking Message.

Equipment Information

The a space Equipment space a area on the status page (Figure 1) shows the status (by colour) of any defined Equipments (unless hidden). If Hidden equipments are present, they may also be displayed by clicking on the "+" link above the equipment names. This area also displays the number of events sent, the event rate and the data rate. These values are found in the Statistics subtree for each Equipment.

The names of each equipments is a link to the relevant Equipment page, which displays any Variables related to that equipment.

Logging Channels

The a space Logging Channels space {{Spacer|blank=ab} section on the status page (Figure 1) contains a display of the status of open logging channels, number of events logged, disk usage etc.

Clients

The a space Clients space b area on the status page (Figure 1) displays the names of the clients that are currently running.