Agent Errors Test

This test monitors the error log file of the target eG agent and reports the number of errors of specific error patterns available in the error log file.

Target of the test : An eG Agent

Agent deploying the test : An internal agent

Outputs of the test : One set of results for every AlertFile and SearchPattern pair configured.

Configurable parameters for the test
Parameter Description

Test Period

How often should the test be executed.

Host

The host for which the test is being configured.

Port

Specify the port at which the specified host listens in the Port text box. By default, this is NULL.

AlertFile

specify the path to the alert log file to be monitored. For eg., /user/john/alert_john.log. Multiple log file paths can be provided as a comma-separated list - e.g., /user/john/alert_egurkha.log,/tmp/log/alert.log.

Your AlertFile specification can also be of the following format: Name@logfilepath_or_pattern. Here, Name represents the display name of the path being configured. Accordingly, the parameter specification for the ‘dblogs’ and ‘applogs’ example discussed above can be: dblogs@/tmp/db/*dblogs*,applogs@/tmp/app/*applogs*. In this case, the display names ‘dblogs’ and ‘applogs’ will alone be displayed as descriptors 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 monitored 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).

SearchPattern

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 ORA:ORA-* in the SearchPattern text box. This indicates that "ORA" is the pattern name to be displayed in the monitor interface. "ORA-*" indicates that the test will monitor only those lines in the alert log which start with the term "ORA-". Similarly, if your pattern specification reads: offline:*offline, then it means that the pattern name is offline and that the test will monitor those lines in the alert log which end with the term offline.

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: ORA:ORA-*,offline:*offline*,online:*online

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 the log file path, 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>:*.

Lines

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 Error:ERROR:*, Fail:*failed, then:

0:0 will be applied to Error:ERROR:* pattern

1:1 will be applied to Fail:*failedpattern

ExcludePattern

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’.

UniqueMatch

By default, this 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 Error:*ERROR:*, Fail:*failed* 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 ‘ERROR:’ and ‘failed’. 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 ‘ERROR:’ and ‘failed’ 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.

RotatingFile

This flag governs the display of descriptors for this test in the eG monitoring console.

If this flag is set to True, 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. 

CaseSensitive

This flag is set to No by default. This indicates that the test functions in a ‘case-insensitive’ manner by default. This implies that, by default, the test ignores the case of your AlertFile and SearchPattern specifications. If this flag is set to Yes on the other hand, then the test will function in a ‘case-sensitive’ manner. In this case therefore, for the test to work, even the case of your AlertFile and SearchPattern specifications should match with the actuals.

RolloverFile

By default, this flag is set to False. Set this flag to True if you want the test to support the ‘roll over’ capability (if any) of the specified AlertFile. A roll over typically occurs when the timestamp of a file changes or when the log file size crosses a pre-determined threshold. When a log file rolls over, the errors/warnings that pre-exist in that file will be automatically copied to a new file, and all errors/warnings that are captured subsequently will be logged in the original/old file.In such a scenario, since the RolloverFile flag is set to False by default, the test by default scans only the original/old file for new log entries and ignores the new file. On the other hand, if the flag is set to True, then the test will scan both old and the rolled-over file for new entries.

If you want this test to support the ‘roll over’ capability described above, the following conditions need to be fulfilled:

  • The AlertFile parameter has to be configured only with the name and/or path of one/more alert files. File patterns should not be specified in the AlertFile text box.
  • The roll over file name should be of the format: “<AlertFile>.1”, and this file must be in the same directory as the AlertFile.

OverwrittenFile

By default, this flag is set to False. Set this flag to True if log files do not ‘roll over’ in your environment, but get overwritten instead. In such environments typically, new messages that are captured will be written into the log file that pre-exists and will replace the original contents of that log file;  unlike when ‘roll over’ is enabled, no new log files are created for new entries in this case. If the OverwrittenFile flag is set to True, then the test will scan the new entries in the log file for matching patterns. However, if the flag is set to False, then the test will ignore the new entries.   

EncodeFormat

By default, this is set to none, indicating that no encoding format applies by default. However, if the test has to use a specific encoding format for reading from the specified AlertFile , then you will have to provide a valid encoding format here.  Where multiple log files are being monitored, you will have to provide a comma-separated list of encoding formats – one each for every log file monitored - eg., UTF-8, UTF-16. Make sure that your encoding format specification follows the same sequence as your AlertFile specification. In other words, the first encoding format should apply to the first alert file, and so on. For instance, say that your alertfile specification is as follows: D:\logs\report.log,E:\logs\error.log, C:\logs\warn_log. Assume that while UTF-8 needs to be used for reading from report.log, UTF-16 is to be used for reading from warn_log. No encoding format need be applied to error.log. In this case, your EncodeFormat specification will be: UTF-8,none,UTF-16.

Note:

If your AlertFile specification consists of file patterns that include wildcard characters (eg.,D:\logs\report.log,E:\logs\error.log.03*15, D:\logs\report.log,E:\logs\error.log.04*15), then such configurations will only be supported in the ANSI format, and not the UTF format. 

UseUTF8

If UTF-8 encoding is to be used for reading the specified log file, then, set the UseUTF8 flag to true. By default, this flag is set to false. If multiple log files are being monitored, then, for each file, you will have to indicate whether UTF-8 encoding is to be used for reading that file or not. For instance, assume that the AlertFile parameter is set to dblogs@/tmp/db/dblogs.log,applogs@/tmp/app/applogs.log. Now, to instruct the test to use UTF-8 encoding for reading the ‘dblogs’ log file and not to use the UTF-8 encoding while reading the ‘applogs’ log file, your USEUTF8 setting should be as follows: true,false. Note that the number of values provided against the UseUTF8 parameter should be equal to the number of log files being monitored. Also, note that if the AlertFile being monitored has BOM, then the test will automatically use UTF-8 encoding to read that file, even if the UseUTF8 flag is set to false.

Note:

If your AlertFile specification consists of file patterns that include wildcard characters (eg., /tmp/db/*dblogs*,/tmp/app/*applogs*), then the files that match such patterns will only support the ANSI format, and not the UTF format, even if the UTF-8 parameter is set to true for such patterns.

UseUTF16

If UTF-16 encoding is to be used for reading the specified log file, then, set the UseUTF16 flag to true. By default, this flag is set to false. If multiple log files are being monitored, then, for each file, you will have to indicate whether UTF-16 encoding is to be used for reading that file or not. For instance, assume that the AlertFile parameter is set to dblogs@/tmp/db/dblogs.log,applogs@/tmp/app/applogs.log. Now, to instruct the test to use UTF-16 encoding for reading the 'dblogs' log file and not to use the UTF-16 encoding while reading the ‘applogs’ log file, your UseUTF8 setting should be as follows: true,false. Note that the number of values provided against the UseUTF16 parameter should be equal to the number of log files being monitored.

Note:

If your AertFile specification consists of file patterns that include wildcard characters (eg., /tmp/db/*dblogs*,/tmp/app/*applogs*), then the files that match such patterns will only support the ANSI format, and not the UTF format, even if the UTF-16 parameter is set to true for such patterns.

DD Frequency

Refers to the frequency with which detailed diagnosis measures are to be generated for this test. 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. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD Frequency. 

Detailed Diagnosis

To make diagnosis more efficient and accurate, the eG Enterprise suite 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 for a particular server, choose the On option. 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:

  • The eG manager license should allow the detailed diagnosis capability
  • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
Measurements made by the test
Measurement Description Measurement Unit Interpretation

Recent errors

Indicates the number of errors that were added to the error log file when the test was last executed.

Number

The value of this measure is a clear indicator of the number of “new” alerts that were logged into the error log of the monitored eG agent.