Configuring XML Files

Discontinued support

Support for all versions of the XML Files monitor type is discontinued from September 20, 2019 and it is removed from the product in the 2.7.40 version.

This topic provides information about configuring the XML files. 

Click  to configure XML files for monitoring.

Field

Description

Label for new file to be addedSpecify the name of the label for the log file that you want to start monitoring.
Logical name

Specify the logical name of the instance that you want to monitor. Maximum 80 characters are supported in this field.

File name

Specify the full path and the filename for the file that you want to monitor.

Note: To monitor log files that have dynamic names, use the * and ?regular expressions to define the file name. For example, if a log file is named backup_date.log, where date changes each day, enter the log file name as backup_*.log.

Regular expressions are not accepted for named pipes. Maximum 900 characters are supported in this field.

Path contains environment variables

Select 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 XML file path are resolved. Otherwise, the XML file is treated as a pure file name.

Advanced Settings

File dispositionSelect ALL option if you are monitoring a dynamically named file and you want to monitor all of the files using the dynamic name specified in the File/Pipe Name field, rather than just the latest file.
Scan priority

The KM has three predefined collection intervals which can be set by configuring the Scan Priority field. This field displays the priority level at which you want the instance to be scanned.

The priority-collection interval mapping:

Scan Priority

Predefined Data Collection interval

Normal

2 minutes                        

Medium

10 minutes

Low

30 minutes

  • 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. The default scan interval is 2 minutes.

Note: You cannot select a value other than Normal for remote log instances. Attempting to do so will result in an error message.

Setting a custom collection interval:

You can set a none-default value also known as, custom collection interval, for each of the above priority values.

  1. Navigate to your Log Management KM policy and select the Polling Intervals tab.
  2. Click Add Polling Interval.
    1. In the Monitoring solution field, select Log Management.
    2. Select the version.
    3. Select the Monitor Parameter as per your requirements. For more information, refer Scan priority, collection interval, and collection timeout table.
    4. Set the polling interval of the monitor parameter with the custom collection interval.

    5. Save the policy.

Scan priority, collection interval, and collection timeout table

Priority

Monitor Parameter

Predefined Data Collection
interval

Collection timeout

Normal

LogMainColl

2 minutes

8 minutes

Medium

LogMainColl2

10 minutes

13 minutes

Low

LogMainColl3

30 minutes

33 minutes

Note: If you are using Log Management KM prior to version 2.7.30, ensure that the predefined data collection interval value does not exceed the collection timeout value.

Generate alarm if file not modified

Select this check box if you want the instance to generate an alarm if the monitored file is not modified periodically. Specify the time in minutes after which you want the KM to alarm if the file is not modified, in the minutes text box.

If no match on the next scan return to OK

Select this checkbox iIf 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.

XML Settings

Expand the frame to configure the XML settings.

FieldDescription
Once closing root-tag is found, Delete instance after (minutes)Specify the time in minutes after which you want the KM to delete the instance once the closing root-tag is found.
Always read at beginningSelect this checkbox if you want to scan the entire XML file on each scan, rather than scanning only the new content.

Multiline Search

Expand the Multiline Search frame to configure the start and end delimiters.

FieldDescription
Start delimiterSpecify the start limit to search a block of lines containing a match string.
End delimiterSpecify the end limit to search a block of lines containing a match string.

Remote Monitoring

Expand the Remote Monitoring frame to add a remote host for monitoring.

Remote hostname: Specify the hostname for remote monitoring. This field is applicable only for UNIX and Linux platforms. UNIX KM must be installed and the Remote Monitoring policy must be defined.

Search Criteria Settings

Pattern Search Criteria: Click  to configure a Pattern Search Criteria for the configured file. 

FieldDescription
Search Criterion
Search Identifier NameSpecify a unique label in the Search Identifier Name text box and configure a search string to define what type of messages the KM should search for.
String

In the String text box, enter the search string in one of the following formats:

  • A combination of XML elements and values that you want to find in the monitored file. For configuring XML search strings, see Rules for entering XML search strings.
  • Search pattern (s). Each search pattern should be a valid regular expression. Enclose each pattern in parentheses ({}).

Search Criteria Event Handling ConfigurationExpand the frame to add a search criteria for handling events.

FieldDescription
Override default setting

Select this checkbox to custom-define the settings for each search criterion.

You can custom-define a search criterion with settings that are different from the default settings. To do so, select the Override default setting check box and custom-define the settings for each search criterion.

Threshold # 1Specify the minimum number of text search string matches in a polling cycle required to produce a specified state.
Threshold # 1 state

Select the state that you want the KM to exhibit when a threshold is reached.

    • None
    • Ok
    • Warn
    • Alarm

Note: If you want the KM to go into alarm when the search string is found 3 times in the monitored file, then you would set the value of Threshold #1 to 3 and select Alarm from the State list.

Threshold #2Specify the minimum number of text search string matches required to produce a specified state. You can specify a different state and a different number of matches from Threshold #1. Threshold #2 should be higher than Threshold #1. To search for a minimum number of text strings across a number of polling cycles, enter values in the x:y format.
Threshold # 2 state

Select the state that you want the KM to exhibit when a threshold is reached.

    • None
    • Ok
    • Warn
    • Alarm
Custom event messageSpecify the message that you want to be displayed in the events when your search string conditions are satisfied. For more information, see Customizing event messages.
Custom event origin

Specify the customized origin for events. If you do not specify the origin, the product uses the instance name as the default origin of events, which is APPCLASS.INSTANCE.textFileName.

You can use built-in macros (except the %x[-%y] macro) as the customized origin for events.

Ignore duplicate events for next (mins)

Specify the time threshold for which the duplicate events will be ignored.

Note:

You can also modify the default search criterion settings after you configure the instance.


Default Settings For Search Criteria
Threshold # 1

Specify the minimum number of text search string matches in a polling cycle required to produce a specified state.

To search for a minimum number of text strings across a number of polling cycles, enter values in the x : y format; x represents the minimum number of text string matches, and y represents the total number of polling cycles.

Threshold # 1 state

Select the state that you want the KM to exhibit when a threshold is reached.

    • None
    • Ok
    • Warn
    • Alarm

Note: If you want the KM to go into alarm when the search string is found 3 times in the monitored file, then you would set the value of Threshold #1 to 3 and select Alarm from the State list.

Threshold #2

Specify the minimum number of text search string matches required to produce a specified state. You can specify a different state and a different number of matches from Threshold #1. Threshold #2 should be higher than Threshold #1. To search for a minimum number of text strings across a number of polling cycles, enter values in the x:y format.

Threshold # 2 state

Select the state that you want the KM to exhibit when a threshold is reached.

    • None
    • Ok
    • Warn
    • Alarm

Note: If you want the KM to go into alarm when the search string is found 3 times in the monitored file, then you would set the value of Threshold #1 to 3 and select Alarm from the State list.

Custom event message

Specify the message that you want to be displayed in the events when your search string conditions are satisfied. For more information, see Customizing event messages.

Custom event origin

Specify the customized origin for events. If you do not specify the origin, the product uses the instance name as the default origin of events, which is APPCLASS.INSTANCE.textFileName. You can use built-in macros (except the %x[-%y] macro) as the customized origin for events.

Modifying this field affects the generated custom event origin causing the event to not be associated with the LOG instance level in the Central Monitoring Administration console.

Ignore duplicate events for next (mins)

Specify the time threshold for which the duplicate events will be ignored. You can also modify the default search criterion settings after you configure the instance.

OKClick to save the configuration.
CloseClick this button to exit without saving any changes.

Was this page helpful? Yes No Submitting... Thank you

Comments