Configuring a text file for multiple search criteria by using pconfig variables

In addition to using the Graphical User Interface (GUI), you can use pconfig variables to configure multiple search criteria for a text instance.
This topic describes the pconfig variables that you must define to configure multiple search criteria for a text file instance.

pconfig variable

Required?

Description

Type

actName

y

Specify the name of the log file to be monitored
The file name can include wildcard characters.

text

actLogicalName

y

If the instance is a static instance and the logical name is provided through the GUI, the logical name is stored in this pconfig variable.
The LOGMON instance name displays the specified logical name.

text

actContainEnv

n

Specify whether the monitored file contains environment variables.
Valid values are as follows:

  • 0 indicates that no environment variable expansion takes place
  • 1 indicates that the monitored file name entered is checked for environment variables. Items enclosed in '%' are expanded
    in the variable defined at the PATROL Agent start time or replaced with the string MISSING.

Boolean

actFileType

y

Specify the type of monitored log file.
Valid values are:

  • 1 indicates a text file
  • 2 indicates a command
  • 3 indicates a pipe
  • 4 indicates a binary file

integer

actFileFilter

n

Specify a filter program.
This variable is required when the actFileType variable is set to a value 4. This filter program must exist and be executable by the PATROL Agent user (on UNIX)
when the KM reads the configuration instance.

actFileBegin

y

Specify the log file read position indicator.
Valid values are:

  • 1 indicates that the file is scanned from the beginning each time
  • 0 indicates that each file scan starts from the position where the previous scan ended (previous EOF)

boolean

actFileTreatment

y

Specify the log file treatment indicator.
This variable is required when the actFileType variable is set to a value 1 (when the file type is text).
Valid values are:

  • 1 indicates that only the latest matching file is monitored
  • 2 indicates that all matching files are monitored

boolean

actAlertEventTime

n

If the log file is not modified in the last specified minutes, an event is generated and the LOGStatus parameter goes into an alarm state.
This variable is required when the value of the actAlertEvent variable is set to 1.

integer

ActFileTimestampChange

n

If you set the /PMG/CONFIG/actFileTimestampChange pconfig variable to 1,
the parameter goes into an alarm state when the timestamp of the monitored file changes.

integer

actRegexTypey

Use the variable to look for the search strings:

  • ECMAScript – The ECMAScript standard regex style.
  • PATROL – The patrol regex style (used in the version 2.7.30.01 and earlier).
instance

actStateEventCount1

y

Specify the number of monitoring matches per scan before the state change.
This variable is only checked if the match count is less than actStateEventCount2.
This variable is specific to the default setting for a search criterion.

integer

actStateEventCount2

n

Specify the number of monitoring matches per scan before the state change.
This variable is specific to the default setting for a search criterion.

integer

actStateEvent1

y

Specify the state associated with actStateEventCount1.
Valid values are:

  • 1 indicates no action
  • 2 indicates OK
  • 3 indicates warn
  • 4 indicates alarm

    The LOGErrorLvl parameter is set to this value when the threshold for a string match is reached.
    This variable is specific to the default setting for a search criterion.

integer

actStateEvent2

n

Specify the state associated with actStateEventCount2.
Valid values are:

  • 1 indicates no action
  • 2 indicates OK
  • 3 indicates warn
  • 4 indicates alarm

    The LOGErrorLvl parameter is set to this value when the threshold for a string match is reached.
    This variable is specific to the default setting for a search criterion.

integer

actAlertEventMessage

n

Specify a custom event message.
This variable is specific to the default setting for a search criterion.

text

actAlertEventOrigin

n

Specify a custom event origin.
This variable is specific to the default setting for a search criterion.

text

actNullifyString

n

Add a regular expression to nullify the alarm condition.

text

actNoMatch

n

Specify whether an event is generated if no matches are found.
Valid values are:

  • 0 indicates that an event is not generated if no matches are found during the timed scan.
  • 1 indicates that an event is generated if no matches are found at the end of a timed scan.

Boolean

actPriority

y

Specify the monitoring priority.
Valid values are:

  • 1 indicates normal priority
  • 2 indicates medium priority
  • 3 indicates low priority

integer

customEvtMatchCount

n

If set to 1, only one event is generated per search criterion independent of number of matches found.
The generated event contains total number of matches found and the last matched text for the search criterion.
The value is stored at /PMG/CONFIG/customEvtMatchCount.

Integer

searchIdentifierLabel

y

Describes the label for a search criterion that you define
Each time you define a search criterion, this variable is created with the same name as that of the search identifier.
This variable is a collection of fields and is created under the /PMG/CONFIG/instanceName/actPatterns pconfig branch.
For more information, see Defining multiple search criteria by using the pconfig branch.

String

actSearchList

y

Stores the entire configuration information of an XML instance

Text

InstOnFileNotExist

n

Allows an instance to get created on file that does not exist
You must add the /PMG/CONFIG/InstOnFileNotExist manually, and set it to a value of 1.

Boolean

Related topics

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

Comments