Changes between Version 14 and Version 15 of statmgr


Ignore:
Timestamp:
01/31/12 15:26:27 (10 years ago)
Author:
branden
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • statmgr

    v14 v15  
    272272Here are the lines that make up a descriptor file: 
    273273 
    274 Comment lines are preceded by #. 
    275 The following lines describe the patient module: 
    276 instId inst 
     274 * Comment lines are preceded by #. 
     275 * The following lines describe the patient module: 
     276 
     277'''instId [inst here]''' 
    277278 
    278279inst is the installation at which the patient-module is running. inst is a character string (valid strings are listed in earthworm.h) that relates (in earthworm.h) to a unique single-byte number. This line is required; inst and modId allow statmgr to match an error message with its proper descriptor file instructions. 
    279 modId modId 
     280 
     281'''modId [modId here]''' 
    280282modid is the module id of the patient module. modid is a character string (valid strings are listed in earthworm.d) that relates (in earthworm.d) to a unique single-byte number. modid must match that used in the patient module's own configuration file. This line is required; inst and modId allow statmgr to match an error message with its proper descriptor file instructions. 
    281 modName modName 
     283 
     284'''modName [modName here]''' 
    282285Give the name of the patient module. name is text string (up to 39 characters) which statmgr includes in each logged and reported error message from this patient. This line is required. 
    283 system sysname 
     286 
     287'''system [sysname here]''' 
    284288This is an optional parameter. sysname is a string (up to 29 characters) giving the name of the computer on which the patient module is running. statmgr includes this text string in each logged and reported error message from this patient. If the "system" line is ommitted, statmgr assumes the module is running on the local computer and uses the environment variable, SYS_NAME, in its place. 
    285 pagegroup group 
     289 
     290'''pagegroup [group here]''' 
    286291This is an optional parameter. group is a string (up to 79 characters) to which statmgr will address all TYPE_PAGE messages regarding this specific module. If the "pagegroup" line is ommitted here, statmgr uses the pagegroup listed in its own configuration file. 
    287 Next is a required line that describes the patient module's heartbeat: 
    288 tsec: tsec page: npage mail: nmail 
     292 
     293 * Next is a required line that describes the patient module's heartbeat: 
     294'''tsec: [tsec here] page: [npage here] mail: [nmail here]''' 
    289295 
    290296If the statmgr does not receive a heartbeat message every tsec seconds from this patient module, an error will be reported (LOCAL_time modName/sysname module dead). If statmgr receives a heartbeat from a module that it has reported "dead," it will send out an "alive" message (LOCAL_time modName/sysname module alive). tsec is generally set to 2*(heartbeat-interval) of the patient module. npage is the maximum number of pager messages that will be reported and nmail is the maximum number of email messages that will be reported. Each "dead" and "alive" message counts as a separate message. If the page or mail limit is exceeded, no further errors will be reported until the status manager is restarted. 
    291 And finally follows the list of possible errors that the patient module may produce. Each error is described by two lines: 
    292 err: code nerr: nerr tsec: tsec page: npage mail: nmail 
    293 text: description 
     297 
     298 * And finally follows the list of possible errors that the patient module may produce. Each error is described by two lines: 
     299err: [code here] nerr: [nerr here] tsec: [tsec here] page: [page here] mail: [nmail here] [[BR]] 
     300text: [description here] 
    294301 
    295302code is the error code generated by the patient module. Error codes can be any unsigned integer, not necessarily sequential.