Changes between Version 2 and Version 3 of ServerStatus

Timestamp:

Nov 30, 2014, 8:23:58 PM (10 years ago)

Author:

davea

Comment:

--

ServerStatus

@@ -1 +1 @@
 = Server status =
 
-Each project should export its server status in two forms:
+A project exports its server status in two forms:
 
  * '''URL/server_status.php:''' human-readable (web page).
- * '''URL/server_status.php?xml=1:''' XML format, as follows:
+ * '''URL/server_status.php?xml=1:''' XML format.
+
+These show the status of daemon processes and counts of users and jobs.
+
+The database queries used for getting the counts can be slow.
+The results are cached so that the queries are done infrequently.
+The caching period is defined by the constant '''STATUS_PAGE_TTL'''
+in html/project/cache_parameters.inc.
+The default is 1 hour.
+
+If your project runs daemons on hosts other than the web server,
+you'll need to run the script '''html/ops/remote_server_status.php'''
+as a period script; i.e. put something like
 {{{
-<server_status>
-    <update_time>1127772607</update_time>
-    <daemon_status>
-        <daemon>
-            <host>jocelyn</host>
-            <command>BOINC database</command>
-            <status>running</status>
-        </daemon>
-        <daemon>
-            <host>castelli</host>
-            <command>master science database</command>
-            <status>running</status>
-        </daemon>
-        <daemon>
-            <host>kryten</host>
-            <command>sah_validate4</command>
-            <status>running</status>
-        </daemon>
-        ...
-    </daemon_status>
-    <database_file_states>
-        <results_ready_to_send>563389</results_ready_to_send>
-        <results_in_progress>1198237</results_in_progress>
-        <workunits_waiting_for_validation>19</workunits_waiting_for_validation>
-        <workunits_waiting_for_assimilation>16</workunits_waiting_for_assimilation>
-        <workunits_waiting_for_deletion>0</workunits_waiting_for_deletion>
-        <results_waiting_for_deletion>0</results_waiting_for_deletion>
-        <transitioner_backlog_hours>-0.0002777</transitioner_backlog_hours>
-    </database_file_states>
-</server_status>
+<task>
+   <cmd>run_in_ops remote_server_status.php</cmd>
+   <period>1 hour</period>
+</task>
 }}}
+in the '''<tasks>''' section of your config.xml.
 
-There are two ways to do this:
-
- 1. Copy `html/ops/sample_server_status.php` to `html/user/server_status.php`. This works as long as you don't need any customization, and the DB queries in the page only take a few seconds (the page is cached, so they are done infrequently).
- 1. Write a periodic script that generates the 2 pages as files, and put a script in `user/server_status.php` that echoes one file or the other.
+This script uses ssh to find the status of daemons on remote hosts.
+This can't be done directly from server_status.php because the Apache user
+typically can't ssh to other hosts.
+Your BOINC user (e.g. boincadm) must be able to ssh without password to
+the hosts on which daemons run.