Change File for Label - dialog box

The Change File for Label: instanceName dialog box allows you to change the monitoring properties and the default search criterion settings for an existing log instance that you are monitoring. 


The following table describes the properties available in the Change File for Label: instanceName dialog box.

Change File for Label: instanceName dialog box field descriptions

ItemDescription
File/Pipe Name text boxDisplays the full path, including the name, of the text instance that you want to search and monitor (900 byte limit) The BMC PATROL Agent default account must be able to read this file.
Logical Name text boxSpecify the logical name for the LOGMON instance that you want to monitor The instance logical name is stored in the pconfig variable located at /PMG/CONFIG/label/actLogicalName. An event is generated with the logical name and the file name of the instance. If you do not specify a logical name, the pconfig variable remains blank.
Contains Environmental Variables check boxSelect this check box to enter a path defined by an environment variable that is resolved at run time. If you select this check box, environment variables in the file path are resolved. Otherwise, the file is treated as a pure file name. For example, if you enter%HOME%/log.txt in the File/Pipe Name text box and select this check box, the product substitutes the path defined in%HOME%. If the check box is cleared, the product tries to find a path called %HOME%.
File Type optionsSelect a file type.
Filter Program text boxIf the file type is Binary File, enter the filter program to read the monitored binary.
Always Read at Beginning check boxWhen a file is modified, the KM reads the file from its beginning in each polling cycle. If you do not select this check box, the KM reads only the text that was added since the last time file was scanned.
File DispositionoptionsIf multiple files match the file name (for example, if you use wildcard characters), select Latest to monitor only the most recent file or All to monitor all the files.
Generate ALARM if file not modified in check boxSelect this check box if you want the LOGMON instance to go into an alarm state if the monitored file is not modified periodically.
minutes text boxIf you have selected the Generate ALARM if file not modified incheck box, specify the time in minutes after which an alarm must be generated if the file is not modified.
Default Settings for Search Criteria: Specify the default settings for a search criterion (described in the following rows). These settings can be overridden by the individual search criterion defined in the Configure Search Criteria: instanceName:Override Default Settings dialog box.
Threshold #1 text boxDisplays the number of search string matches that must occur before producing a specified state For example, if the Match Count field value is 3, the search string must occur 3 times in the monitored file before the KM goes into the state specified by theState list.
State listSpecify the state that the KM will exhibit when the Threshold-Match Count value is reached: NoneOKWarn, or Alarm For example, if you want the KM to go into alarm if the search string is found 3 times in the monitored file, set the value of Threshold #1to 3 and select Alarm from the State list.
Threshold #2 text boxIf you want the KM to exhibit a second state when a different number of search strings occurs, enter the number of matched search strings in this text box. For example, if you set theThreshold #1 to alarm when 3 occurrences of the search string are found and you want the KM to warn when 1 occurrence of the search string is found, enter 1 in the Threshold #2 text box.
State listSpecify the state that the KM will exhibit when the Threshold#2 value is reached: NoneOKWarn, or Alarm
Custom Event Message text box(optional) Specify the message text that you want to be displayed when your search string conditions are satisfied For more information, see Customizing event messages.
Custom Event Origin text boxSpecify the customized origin for events If you do not specify the origin, the product uses the instance name as the default origin of events. You can use built-in macros (except the %x-y macro) as the customized origin for events. For more information about built-in macros, see Built-in macros.
Ignore duplicate events for next ... minutes text boxSpecify an interval in minutes during which the product does not generate an event after the first match and its corresponding event After the specified time elapses, the search criteria generate an event for the next match.
Number of Lines in Log Entry text box (Not applicable for an XML instance)Specify the number of lines that you want to be displayed when a match is found For example, if you want to determine when a disk is full and where the disk is mounted, you would enter Error: Disc Full as the search string and 2 as the value of Number of Lines in Log Entry so that when a disk is full, a message similar to the following one is displayed in LOGMatchString text parameter: 
Id=id1 
031605: Error: Disc Full 
Id=;MatchedLines 
/hd001 mounted as /opt 
SUMMARY:id1=1;Note: If either, the search string or the nullify string, occurs again within the number of lines selected to be displayed, the KM does not find the instances of the search strings for all the search identifiers.
Nullify Alarm/Warn String text box (Not applicable for an XML instance)Displays the string that is used to nullify the alarm for the dual-search feature You can configure dual search for an instance so that the KM goes into an alarm state when any of the search criteria is found in the monitored file and nullifies the alarm when the nullify string is found. You must specify atleast one search string in the String1 text box (in the Configure Search Criteria:instanceName dialog box) and the nullify string in the Nullify Alarm/Warn String text box. For nullified customized events, the default custom event message is used (as provided in the Custom Event Message text box). For example, if you specify Alarm up in the String1 text box of the search criteria and Alarm down in theNullify Alarm/Warn String text box, the KM goes into an alarm state when Alarm up is found in the monitored file. The alarm is nullified when Alarm down is found in the monitored file.
Once closing root-tag is found, Delete instance after... minutes text box (Applicable only for an XML instance)Specify an interval in minutes during which the product should not delete an instance even if the closing root-tag is found. After the specified time elapses, the product will delete the instance for which the closing root-tag is found.
Return to OK if no match found on next scan check boxIf the KM goes into an alarm or a warning state because the search string is found and you want the KM state to return to OK if the search string is not found on the next scan, select this check box.
Scan Priority list

Displays the priority level at which you want the text instance to be scanned:

  • Normal is associated with the LogMainColl and LogRemoteMainColl collectors. Select this option to scan the file every 2 minutes.
  • Medium is associated with the LogMainCollP2 collector. Select this option to scan the file every 10 minutes.
  • Low is associated with the LogMainCollP3 collector. Select this option to scan the file every 30 minutes.

If you want to change how often the file is scanned, change the polling time of these collectors. 
Note: You cannot select a value other than Normal for remote log instances. Attempting to do so will result in an error message.

Accept buttonClick this button to save the properties and close the dialog box.
Cancel buttonClick this button to close the dialog box.
Was this page helpful? Yes No Submitting... Thank you

Comments