standardMessageDestinations.fcl

Go to the documentation of this file.

#
# Standage destinations for the message service -- 
# for use by messageService.fcl, which defines standard configurations for 
# the message service.
#
# Normally, users will use messageService.fcl which includes this file, 
# rather than dealing with this file directly.
#
# Usage - in a fcl configuration file
#
# 1 - Place the following near the start, among the PROLOGs:
#     #include "fcl/standardMessageDestinations.fcl"
#
# 2 - In a destinations entry in a block that will be part of the message
#     service block, choose the selected standard destination configuration
#     among:
#     destinations : @local::mf_error
#     destinations : @local::mf_warning
#     destinations : @local::mf_coutInfo
#     destinations : @local::mf_debug
#
# 3 - If message statistics will also be desired, also insert the corresponding
#     standard statistics, from among:
#     destinations : @local::mf_errorStats
#     destinations : @local::mf_warningStats
#     destinations : @local::mf_coutInfoStats
#     destinations : @local::mf_debugStats
#
# 3 - Customizations to configurations using these standard destinations
#     are straightforward to make; see customizingMessageFacilityFcl.txt 
#     for simple examples. 
 

BEGIN_PROLOG

# Four standardized (but customizable) destinations, with different thresholds
# ----------------------------------------------------------------------------

mf_null:
{
    type: file
    filename: "/dev/null"
}

mf_error:
{
 type:      file   # Record the messages in a file.
 filename:  "error.log" # Name of the file in which to place the messages;
                        # quoted, because if contains a dot.
 threshold: ERROR       # Threshold of what level of messages to react to.
 append:    true        # Will append messages to named file if it exists   
 categories:            # A place to list named categories, if you want to 
                        # specify the behavior for specific categories of 
                        # messages.
                        # For example, in LigInfo("suspiciousParticle") << p;
                        # the category of the message would be
                        # "suspiciousParticle."
 {
   default:             # Limits for any category not explicitly mentioned.
   {
     limit : 100        # Output first 100 instances of messages in each 
                        # category, then go to exponential backoff.
     timespan : 300     # If this many seconds elapse between messages of
                        # one category being issued, reset the counting 
                        # toward the limit (in this case, output the next
                        # 100 instances, even if limit had been exceeded).
   } 
 } # end categories
} # end mf_error
mf_errorStats : 
{ 
 type     : file
 filename : @local::mf_error.filename  # Because the filename matches that 
                                       # of a destination (if used with
                                       # errorMsg), the statistics will be 
                                       # placed at the end of the output
                                       # to that destination.
}

mf_warning: 
{ 
 type:      file       
 filename:  "warning.log"
 threshold: WARNING    # React to WARNING and ERROR message severities; 
                       # ignore messages issued via iLogInfo and LogDebug.
 categories: 
 {
  default:             
   {
     limit    : 100
     timespan : 300        
   } 
 } # end categories
} # end mf_warning
mf_warningStats : 
{ 
 type     : file
 filename : @local::mf_warning.filename  
}

mf_coutInfo: 
{ 
  type:      cout       # type could be cout, cerr, archive, dds, or file.
  threshold: INFO       # React to INFO, WARNING, and ERROR 
                        # message severities; ignore LogDebug messages. 
 categories: 
 {
   ArtReport:           # ArtReport is a category of INFO messages that
                        # the framework will generate to tell, for example, 
                        # when a next event is started. 
   {
     reportEvery : 50   # Output only every 50-th message issued in this
                        # category.
     limit       : -1   # -1 is a way to say do not impose any limit.
                        # Alternatively, one could just omit the limit 
                        # entry, which would mean no limit.
   }   
   default:             
   {
     limit : 10        
   } 
 } # end categories
} # end mf_coutInfo
mf_coutInfoStats : 
{ 
 type :     cout
}

mf_debug:
{
 type:      file
 filename:  "debug.log"  
 append:    false        
 threshold: "DEBUG"     # No messages will be ignored due to this threshold.
                        # However, unless debugModules in service.message 
                   # includes "*", messages from a module which is 
                   # not among the debug modules listed will still
                   # be suppressed.
 categories:
 {             
   default:              
   {
    limit:       -1     
   }
 } # end categories
} # end mf_debug
mf_debugStats : 
{ 
 type     : file
 filename : @local::mf_debug.filename  
}

END_PROLOG