|
Configuration
of XenAlertLogTest
The XenAlertLogTest monitors the log files of the DDC to capture errors/warnings of configured patterns. The default parameters associated with this test are as follows:
-
The port number to which
the server is listening is to be provided in the PORT text
box.The default port is 80.
-
In the ALERTFILE text box, specify the path to the alert log file to be monitored. For eg., C:/cds/controller.log. Multiple log file paths can be provided as a comma-separated list - eg., c:/cds/pool.log,C:/cds/controller.log.
Also, instead of a specific log file path, the path to the directory containing log files can be provided - eg., c:/cds. This ensures that eG monitors the most recent log files in the specified directory. Specific log file name patterns can also be specified. For example, to monitor the latest log files with names containing the string 'pool', the parameter specification can be, c:/cds/*pool*. Here, '*' indicates leading/trailing characters (as the case may be). In this case, the eG agent first enumerates all the log files in the specified path that match the given pattern, and then picks only the latest log file from the result set for monitoring.
You can also configure the path in the following format:Name@logfilepath. Here, Name represents the display name of the path being configured. Accordingly, the parameter specification for the 'pool' example discussed above can be: pool@/tmp/db/*pool*. In this case, the display name pool will alone be displayed as the descriptor of this test.
Every time this test is executed, the eG agent verifies the following:
- Whether any changes have occurred in the size and/or timestamp of the log files that were monitoring during the last measurement period;
- Whether any new log files (that match the ALERTFILE specification) have been newly added since the last measurement period;
If a few lines have been added to a log file that was monitored previously, then the eG agent monitors the additions to that log file, and then proceeds to monitor newer log files (if any). If an older log file has been overwritten, then, the eG agent monitors this log file completely, and then proceeds to monitor the newer log files (if any).
-
In
the SEARCHPATTERN text box, enter the specific patterns of
alerts to be monitored. The pattern should be in the following format:<PatternName>:<Pattern>,
where <PatternName> is the pattern name that will be
displayed in the monitor interface and <Pattern> is
an expression of the form - *expr* or expr or *expr
or expr*, etc. A leading '*'
signifies any number of leading characters, while a trailing '*'
signifies any number of trailing characters.
For
example, say you specify OXenFactory:*XenFactory* in the SEARCHPATTERN text
box. This indicates that "XenFactory" is the pattern
name to be displayed in the monitor interface. ""*XenFactory*"
indicates that the test will monitor only those lines in the alert log
which contain the term "XenFactory".
A single pattern may also be of the
form e1+e2, where + signifies an OR condition. That is, the
PatternName is matched if either e1 is true or e2 is true.
Multiple
search patterns can be specified as a comma-separated list. For example:
XenFactory:*XenFactory*,LicenseRetry:*LicenseRetryThreadBody*
If the ALERTFILE specification is of the format Name@logfilepath, then the descriptor for this test in the eG monitor interface will be of the format: Name:PatternName. On the other hand, if the ALERTFILE specification consists only of a comma-separated list of log file paths, then the descriptors will be of the format: LogFilePath:PatternName.
If you want all the messages in a log file to be monitored, then your specification would be: <PatternName>:*.
-
In
the LINES text box, specify two numbers in the format x:y.
This means that when
a line in the alert file matches a particular pattern, then x
lines before the matched line and y lines after the matched
line will be reported in the detail diagnosis output (in addition to
the matched line). The default value here is 0:0. Multiple entries can
be provided as a comma-separated list.
If
you give 1:1 as the value for LINES, then this value will
be applied to all the patterns specified in the SEARCHPATTERN
field. If you give 0:0,1:1 as the value for LINES and if the corresponding
value in the SEARCHPATTERN field is like XenFactory:*XenFactory*,LicenseRetry:*LicenseRetryThreadBody*
then:
0:0 will be applied to XenFactory:*XenFactory*
pattern
1:1 will be applied to LicenseRetry:*LicenseRetryThreadBody*
pattern
-
Provide a comma-separated list of patterns to be excluded from monitoring in the EXCLUDEPATTERN text box. For example, *critical*,*exception*. By default, this parameter is set to 'none'.
-
By default, the
UNIQUEMATCH parameter is set to FALSE, indicating that, by default, the test checks every line in the log file for the existence of each of the configured SEARCHPATTERNS. By setting this parameter to TRUE, you can instruct the test to ignore a line and move to the next as soon as a match for one of the configured patterns is found in that line. For example, assume that Pattern1:*fatal*,Pattern2:*error* is the SEARCHPATTERN that has been configured. If UNIQUEMATCH is set to FALSE, then the test will read every line in the log file completely to check for the existence of messages embedding the strings 'fatal' and 'error'. If both the patterns are detected in the same line, then the number of matches will be incremented by 2. On the other hand, if UNIQUEMATCH is set to TRUE, then the test will read a line only until a match for one of the configured patterns is found and not both. This means that even if the strings 'fatal' and 'error' follow one another in the same line, the test will consider only the first match and not the next. The match count in this case will therefore be incremented by only 1.
-
The ROTATINGFILE flag governs the display of descriptors for this test in the eG monitoring console.
If this flag is set to true and the ALERTFILE text box contains the full path to a specific (log/text) file, then, the descriptors of this test will be displayed in the following format: Directory_containing_monitored_file:<SearchPattern>. For instance, if the ALERTFILE parameter is set to c:\eGurkha\logs\syslog.txt, and ROTATINGFILE is set to true, then, your descriptor will be of the following format: c:\eGurkha\logs:<SearchPattern>. On the other hand, if the ROTATINGFILE flag had been set to false, then the descriptors will be of the following format: <FileName>:<SearchPattern> - i.e., syslog.txt:<SearchPattern> in the case of the example above.
If this flag is set to true and the ALERTFILE parameter is set to the directory containing log files, then, the descriptors of this test will be displayed in the format: Configured_directory_path:<SearchPattern>. For instance, if the ALERTFILE parameter is set to c:\eGurkha\logs, and ROTATINGFILE is set to true, then, your descriptor will be: c:\eGurkha\logs:<SearchPattern>. On the other hand, if the ROTATINGFILE parameter had been set to false, then the descriptors will be of the following format: Configured_directory:<SearchPattern> - i.e., logs:<SearchPattern> in the case of the example above.
If this flag is set to true and the ALERTFILE parameter is set to a specific file pattern, then, the descriptors of this test will be of the following format: <FilePattern>:<SearchPattern>. For instance, if the ALERTFILE parameter is set to c:\eGurkha\logs\*sys*, and ROTATINGFILE is set to true, then, your descriptor will be: *sys*:<SearchPattern>. In this case, the descriptor format will not change even if the ROTATINGFILE flag status is changed.
-
The DD FREQUENCY refers to the frequency with which detailed diagnosis measures are to be generated. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. The DD FREQUENCY refers to the frequency with which detailed diagnosis measures are to be generated. The default is 1:1. This indicates that, by default, detailed measures will be generated every time this test runs, and also every time the test detects a problem. Typically, detailed diagnosis frequencies are set globally, using the DIAGNOSIS CONFIGURATION page that appears when the Configure -> Diagnosis menu sequence is followed. This global setting can be overridden at the test-level using the DD FREQUENCY parameter. To disable the detailed diagnosis capability for a test, you can set this parameter to none.
-
To make diagnosis
more efficient and accurate, eG embeds an optional detailed
diagnostic capability. With this capability, the eG agents can be
configured to run detailed, more elaborate tests as and when specific
problems are detected. To enable the detailed diagnosis capability of
this test, by default, for a particular server, choose the On
option against DETAILED DIAGNOSIS. To disable the
capability, click on the Off option.
The option to
selectively enable/disable the detailed diagnosis capability will be
available only if the following conditions are fulfilled:
-
If multiple components of the same component type are awaiting configuration, then an APPLY TO OTHER COMPONENTS check box will appear in this page. Clicking on this check box will allow you to apply the configuration to all/selected components of that type.
-
Once the necessary
values have been provided, clicking on the UPDATE button will
register the changes made.
When changing the
configuration for specific servers, a “*” beside the text box
corresponding to the parameter signifies that these values have to be
manually configured by the user. The parameter values that require to
be configured will typically be prefixed with a “$” or contain a
series of “*”. A value of "none"
in the parameter value indicates that the corresponding parameter
value can be changed if required.
|