Changes between Version 10 and Version 11 of statmgr


Ignore:
Timestamp:
01/31/12 09:18:01 (9 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • statmgr

    v10 v11  
    206206Calnet:   GetStatusFrom  INST_WILDCARD  MOD_WILDCARD 
    207207}}} 
    208 '''heartbeatPageit nsec                 statmgr_config          Monitor system'''[[BR]] 
     208 
     209'''heartbeatPageit nsec'''[[BR]] 
     210Processed by:statmgr_config[[BR]] 
     211Function: Monitor system 
    209212Defines the number of seconds nsec between heartbeat messages issued by statmgr to the Pageit computer. This heartbeat serves as the heartbeat for the entire Earthworm system being monitored by statmgr. A statmgr heartbeat is actually a TYPE_PAGE message that contains a character string (example: "alive: sysname#"). statmgr places this TYPE_PAGE message into shared memory where the pagerfeeder module can find it and send it to the Pageit system via the serial port. If the Pageit computer doesn't receive a heartbeat within a specified time interval, it will issue an "obituary" page for the Earthworm system. 
    210213{{{ 
     
    212215Calnet:   heartbeatPageit 60 
    213216}}} 
    214 '''LogFile switch                               statmgr_config          output'''[[BR]] 
     217 
     218'''LogFile switch'''[[BR]] 
     219Processes by: statmgr_config[[BR]] 
     220Function: output 
     221 
    215222Sets the on-off switch for writing a log file to disk. If switch is 0, no log file will be written. If switch is 1, statmgr will write a daily log file(s) called statmgrxx.log_yymmdd where xx is statmgr's module id (set with "MyModuleId" command) and yymmdd is the current UTC date (ex: 960123) on the system clock. The file(s) will be written in the EW_LOG directory (environment variable). 
    216223{{{ 
    217224Default:  none 
    218225}}} 
    219 ''mail recipient                                statmgr_config          Monitor system''[[BR]] 
     226 
     227'''mail recipient'''[[BR]] 
     228Processed by: statmgr_config[[BR]] 
     229Function: Monitor system 
     230 
    220231Registers one recipient email address with the statmgr. As configured by descriptor files, statmgr will send every recipient an email message about patient-module errors and state of health (dead/alive) changes. Up to MAXRECIP (currently defined as 10 in statmgr.h) "mail" commands may be issued, but none are required. Each recipient address can be up to 59 characters long. 
    221232{{{ 
     
    223234Example:  mail  jdoe@yourmachine.edu 
    224235}}} 
    225  MyModuleId mod_id                      statmgr_config          Earthworm setup 
     236 
     237'''MyModuleId mod_id'''[[BR]] 
     238Processed by: statmgr_config[[BR]] 
     239Function: Earthworm setup 
     240 
    226241Sets the module id for labeling all outgoing messages. mod_id is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique single-byte number. 
    227  
     242{{{ 
    228243Default:  none 
    229244Calnet:   MyModuleId MOD_STATMGR 
    230  pagegroup group                                statmgr_config          Monitor system 
     245}}} 
     246  
     247'''pagegroup group'''[[BR]] 
     248Processed by: statmgr_config[[BR]] 
     249Function: Monitor system 
     250 
    231251Registers a pager group (string up to 79 characters long) with the statmgr. statmgr will address all of its TYPE_PAGE messages to group unless the module's descriptor file included its own pagegroup command. When the paging system computer receives the message, it maps group to a list of pager recipients and sends a page to each one. Only one "pagegroup" command is allowed and it is required. 
    232  
     252{{{ 
    233253Default:  none 
    234254Example:  pagegroup  ew_operators 
    235  RingName ring                          statmgr_config          Earthworm setup 
     255}}} 
     256 
     257'''RingName ring'''[[BR]] 
     258Processed by: statmgr_config[[BR]] 
     259Function: Earthworm setup 
     260 
    236261Tells statmgr which shared memory region to use for input/output. ring is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique number for the key to the shared memory region. 
    237  
     262{{{ 
    238263Default:  none 
    239264Calnet:   RingName HYPO_RING 
    240 4. DESCRIPTOR FILE DETAILS 
     265}}} 
     266 
     267=== DESCRIPTOR FILE DETAILS === 
    241268 
    242269Every module is registered with the statmgr by means of a "Descriptor" command in statmgr's configuration file. This command gives the name of the module's "descriptor file" which contains details about the module's name and ID, its heartbeat rate, its error codes, and when/how to notify operators of any problems. Statmgr processes each descriptor file in the function statmgr_getdf().