FKM Plug-In: Technical Reference

Plug-in Configuration

The FKM plug-in can be configured to run on any Netprobe host. Configuration should consist of at least one file to be monitored, which will provide basic statistics about the file. Key tables can optionally be configured for additional scanning of file lines for keys. To share key tables between multiple files, configure key tables in a static variables section and reference these for each file.

View

This plug-in produces a single view that consists of all information which can be displayed by FKM. A customized list of columns can be specified via the Plugin Configuration setting.

Headline Legend

NameDescription
filesMonitoredNumber of files currently being monitored by FKM
filesInErrorNumber of files which are in an error (fail) state
filesInWarningNumber of files which are in a warning state
filesNotFoundNumber of files which could not be opened (typically because they do not exist and could not be found)
  

Table Legend

Name Description
nameThe name of the file being monitored by FKM. This may be post-fixed by the tag "#fail" or "#warning" followed by a number. In this case, the row indicates a trigger that was found by a keyword match in the file.
statusThe overall status of the file. For files this will show OK, WARNING, FAIL or NOT_FOUND to indicate the current state. When a trigger is detected for the file, the overall file status is set to the highest alert of all triggers. The text from the latest trigger can optionally be shown in this column. The status column is blank for trigger rows.
permissionsA display of file permissions. These are shown in octal with a human-readable version to the right. On Windows systems only one set of permissions is shown, but under Unix-based systems the typical user/group/all permission set is displayed. This column appears blank for NT event logs, streams and triggers.
lastModificationTimeFor files this column shows the last time the file was modified. For triggers the time the trigger was detected is shown. For streams the time shown is the last time a message was received. For NT event logs this column appears blank.
fileSizeThe current size of the file. The column appears blank for stream, NT event logs and triggers.
updateRateThis shows the update rate of the file, averaged over the sample interval. This gives an indication of how fast the file is growing.
triggerDetailsThis column is only populated for trigger rows. It shows a keyword message (if configured) and the line of the file which contains the detected keyword.
secondsSinceLastTriggerThe number of seconds since a trigger was last detected for this file. This value is updated every sample interval.
triggerCountThe trigger count displays the number of triggers detected for a file. In multiple-trigger mode, this figure is displayed next to the file entry and shows either a count of all active triggers, or the cumulative total of all triggers detected for the file so far. In single-trigger mode, this count is shown for a particular trigger row, and shows the number of triggers detected for that keyword since it was last cleared.
filenameThe current filename of the monitored file. For files with wildcards in the name, this will show the file currently being monitored otherwise it appears the same as the name column described above.
absolutePathShows the absolute path to the file (includes the directory and the filename).
secondsSinceLastModifiedThe number of seconds (at the time of sampling) since the file was last modified. For trigger rows, this column shows the number of seconds since the trigger was detected.
<additional user-defined>Additional user-defined columns may also appear when using extractors.
  

File configuration

This section describes the FKM settings related to file configuration.

files

This section defines the files that will be monitored by the FKM plug-in. Files can either be defined directly in the sampler configuration, referenced as a static variable, or included from a sampler include.

Mandatory: No

files > file

Specifies a single file to be monitored. The filename or alias should be unique so that this file can be uniquely identified in the published view, and to enable unique identification in gateway rules (for example).

files > file > path

The full path to the file.

Example:

/usr/data/FileX.dat

If <today> (including the < > brackets) is specified as part of the file name, then it will result in the automatic substitution of the date in yyyymmdd format.

Additionally, you can include one or more formatting codes to format the date, such as <today%d%m%Y>.

Also, in place of the <today> keyword, you can use these keywords when specifying the filename:

Date keywordDescription
<today...>Current date.
<yesterday...>Actual date yesterday.

If monitored days are configured, then this keyword will count the previous monitored day with respect to monitored days, similar to the previous_monitored_day keyword.
<tomorrow...>Actual date tomorrow.

If monitored days are configured, then this keyword will count the next monitored day with respect to monitored days, similar to the next_monitored_day keyword.
Formatting codeDescription
%aAbbreviated weekday name.
%AFull weekday name.
%bAbbreviated month name.
%^bAbbreviated month name (but capitalised).
%BFull month name.
%dDay of month as decimal number (01 - 31).
%jDay of year as decimal number (001 - 366).
%mMonth as decimal number (01 - 12).
%UWeek of year as decimal number, with Sunday as first day of week (00 - 53).
%wWeekday as decimal number (0 - 6; Sunday is 0).
%WWeek of year as decimal number, with Monday as first day of week (00 - 53).
%xDate representation for current locale.
%yYear without century, as decimal number (00 - 99).
%YYear with century, as decimal number.
%ZTime-zone name or abbreviation; no characters if time zone is unknown.

Examples:

ConfiguredEquivalent (if date is 24 September 2003)
filename<today%d%m%Y>.txtfilename24092003.txt
filename<today%d%b%Y>.txtfilename24Sep2003.txt
filename<today%d%^b%Y>.txtfilename24SEP2003.txt
filename<today%d-%b-%Y>.txtfilename24-Sep-2003.txt

Mandatory: Yes

files > file > source

The source setting specifies where the monitored file data comes from.

Mandatory: Yes

files > file > source > filename

Selecting this setting specifies that the file monitored is a file on disk. The value of this setting specifies the location of the file. Relative paths will be evaluated from the Netprobe working directory.

If a filename contains wildcard characters, then FKM will automatically check for creation of newer files matching the wildcard pattern. When a new file is detected (provided the current file has been scanned to the end) FKM will then switch to monitor the newer file.

There are two types of wildcard specifications which can be used:

  1. Globbing using * and ? characters, as typically used in a UNIX shell session. e.g. apache*.log
  2. Filename date generation using the current date / time. e.g. app<today%Y%m%d>.log

If in case the monitored file is rolled-over, i.e. current monitored file has been renamed and a new file is created with the original filename, FKM will continue to read the renamed file to the end as long as a new file with the original filename exists. After reading the renamed file to the end, it will start reading the new file.

Note: File roll-over monitoring on Windows only works if netprobe is run with admin privileges and if the file is in an NTFS file system. Otherwise, FKM will not be able to follow the renamed file up to the end and may result to missing lines after the file has been rolled over.

files > file > multiline

Specifies if a message should be matched across multiple lines. Messages that are on a single line will also be matched.

Mandatory: No

files > file > multiLine > startPattern

A regular expression that matches the start of a multi line message.

files > file > multiLine > messageEnd > endPattern

A regular expression that matches the end of a multi line message. The start and end pattern will scan single lines as well as multi line messages.

If a start and end pattern match on the same line, the start pattern must appear before the end pattern.

files > file > multiLine > messageEnd > maxNumberOfSamplesToWait

A multi line message will considered to be complete if another start pattern is found e.g. the start pattern in this case is "Start" and 2 complete multi line messages have been found.

Start
        Message 1
        Message 2
Start
        Message 3
        Message 4

Or if the maximum number of samples to wait has been exceeded. This setting has been included to capture the last message in a file as there is no start pattern to end the last message.

files > file > source > stream

Selecting this setting specifies that the file monitored is a stream. Streams are created by certain other Netprobe plug-ins which monitor data streams, such as the TIB-RVSTREAM plug-in. The value specified here should match the stream name as exported by the other plug-ins.

files > file > source > ntEventLog

Selecting this setting specifies that the file monitored is an NT event log. Event logs are only available in Netprobes running on a Microsoft Windows system.

There are usually three default event logs present on a Windows system, named Application, Security and System. Other applications may install their own custom event logs, with a custom log name.

The drop down menu will only contain the three default event logs. To specify a custom event log, type in the full name of the event log into the drop down menu field. The name specified should match the full name of the event log found in the Properties window of the event log in the Windows event viewer.

files > file > source > processDescriptor

Selecting this setting specifies that the file monitored is the log file for a process monitored by a PROCESSES plug-in. The value specified should be the name of a processDescriptor definition in the static variables section of the gateway setup. FKM will then monitor the file specified in the logFile setting of this process descriptor.

files > file > source > dynamicFiles

The dynamicFiles type file-source configures FKM to match groups of files based the configured path, pattern and optionally the alias.

When a new group is identified, an additional file row is created which behaves as a normal filename source. Settings for this new row are copied from the settings of the parent dynamicFiles row. The row will be removed when no files remain to create that grouping.

This feature is similar to using a normal filename source with the wildcardMonitorAllMatches setting, but the two features cannot be used in conjunction. FKM will report an error if you attempt to do this.

Groups are specified using the path setting, which should be a file path containing wildcard globbing characters (* and ?). This path will be evaluated, and all files discovered will then be matched against the configured regex pattern.

The name of a row in the view is determined by evaluating the file alias. Any numbered inserts in the alias (identified by a % followed by a number, e.g. %4) will be replaced with the content of that capture group in the regex pattern, as matched against the filename. Capture groups that do not exist or have no content will be replaced with an empty string. A literal percent character can be produced escaping it as %%. When using a case-insensitive regular expression, insertions will be lowercased to ensure consistent row names.

For example, the value of capture group 1 for regex "app_(.*)_\d+\.log$" matched against file "app_Apache_001.log" would be "Apache" (the contents of the .* portion of the regex). The website http://www.internetofficer.com/seo-tool/regex-tester/ can be used to test regexes against various strings, to see the content of each capture group.

Given the following configuration:

Path: /var/logs/app_*.log
Regex pattern: app_(.*)_\d+\.log$
Alias: App-%1

And the files:

/var/logs/app_Apache_001.log
/var/logs/app_Apache_002.log
/var/logs/app_Samba_1_01.log
/var/logs/app_Router.log

FKM would create two rows in the view:

"App-Apache" monitoring "app_Apache_002.log"
"App-Samba_1" monitoring "app_Samba_1_01.log".

The file app_Apache_002.log is selected over app_Apache_001.log because it has a more recent modification-time (it is assumed that Apache is rolling files by creating higher-numbered logs). The time used for this check can be controlled using the wildcardMatchTime setting. File "app_Router.log" is ignored as it does not pass the regex.

files > file > contentType

The content type specifies how FKM will read the file. This setting only applies to files on disk, including process log files. This setting allows a file to be marked as BINARY or Unicode, which alters the way the file is read. See the Technical Reference section on binary files and Unicode files for more information.

Possible values are as follows:

ValueDescription
TEXTThe file is read as normal.
BINARYNUL characters are replaced with spaces.
UNICODE-AUTODETECTDetects the Unicode file format (from the choices below) by examining the file Byte-Order-Marker.
UTF-8Reads the file as a UTF-8 encoded file.
UTF-16Reads the file as a UTF-16 encoded file.

Mandatory: No
Default: TEXT

files > file > clearTime

The clear time setting specifies an optional time of day at which all triggers of a file will be cleared. This has the same affect as a user using the "accept this file" menu option on the file.

This may be used for example, to ensure that all active triggers are cleared at the end of the business day.

The clear time should be specified as a time in hours and minutes, using 24-hour clock. E.g. 18:30

Mandatory: No

files > file > defaultKeyClearTime

Specifies a default value for the key clear time for trigger rows for this file. This will only apply to keys that do not specify a clearTime value, any keys that specify a clearTime value will override this setting.

Mandatory: No

files > file > rewind

By default when FKM starts monitoring files all existing data in the file is ignored - i.e. monitoring starts from the current end of the file. Enabling this setting will instruct FKM to start monitoring from the start of the file, and process the existing file data.

Note: This setting only applies to files on disk. The FKM plug-in reads from the beginning of a file whenever it detects the file is new, specifically if the file's inode (File ID in Windows) changes, regardless of the rewind option.

Mandatory: No
Default: false

files > file > alias

By default the name column in the FKM dataview displays the file source for each file. This can be overridden by specifying a file alias using this setting. This can be used to provide a description of the contents of the file (e.g. "GL log") or to give files a unique name when monitoring the same file multiple times.

If using a dynamicFiles source, the alias may optionally contain numbered capture-groups from a regular expression for insertion, denoted by the % character (e.g. %4 for the 4th capture group). A literal percent character can be produced using the character sequence %%. Empty or non-existent capture groups will be replaced with an empty string. Percent characters not followed by a number will be repeated verbatim.

Mandatory: No
Default: %0 (the full filename) when using a dynamicFiles source.

files > file > activeTime

The activeTime setting references an activeTime definition from elsewhere in the gateway setup. This time controls whether any keyword tables are checked for the file, as opposed to the keyTable activeTime setting which controls whether one particular keyword table is checked or the key activeTime setting which controls whether one particular keyword in a table is checked.

If the activeTime is inactive then file lines are not scanned for keywords (which includes set-keys, clear-keys and ignore-keys). File statistics such as the modification time or file size are updated however. The file status column will also be updated to display "INACTIVE" provided there are no outstanding conditions for the file.

This setting can be used in conjunction with activeTimes configured for individual keyword tables and keywords. This allows monitoring for a file to be restricted to the file active time, while allowing keyword tables to be enabled or disabled for active times within this period, and further it allows individual keywords to be enabled and disabled within the table's active time period.

Mandatory: No
Default: No active time is set (keyword tables are always scanned).

files > file > ignoreFilePath

This setting specifies the directory of where the plug-in should look to find ignore files for this monitored file. If this is not set, then the value of the 'defaultIgnoreFilePath' parameter is used instead. This functionality is only available for Gateway2. See ignore file feature for more details.

Mandatory: No

files > file > ignoreFileName

This setting specifies the name of the ignore file for this monitored file. If this is not set, then the value of the 'defaultIgnoreFileName' parameter is used instead. This functionality is only available for Gateway2. See ignore file feature for more details.

Mandatory: No

files > file > groups

This legacy setting specifies a list of user groups which can issue commands on the file. If this setting is not specified, all users have permissions to use commands on a file.

Note: This setting is provided for easy migration for users of gateway 1. As such gateway 1 limitations apply - in particular the command may not run for users that are members of more than one group. Users are recommended to configure the gateway 2 user permissions in preference to this setting.

Mandatory: No

files > file > readPartialLines

This settings controls if partial lines are read and matched against. If it is on (which it is by default) the partial line will be read and matched against the keys.

If the setting is configured to be off then then only complete lines will be considered.

A complete line is one that is terminated a new line.

Mandatory: No
Default: true

Table and key configuration

Each FKM file can be configured with a number of key tables, each of which contains a set of keys to search for in the file. Key tables can be configured specifically for a file in the file definition, or placed as a variable and shared between multiple files.

Key tables can have different associated severities. The severity controls what FKM displays when a match is found for a key in that table. Fail tables are typically checked before warning tables, although this can be controlled using the reorderKeywordTables setting.

files > file > tables

The tables setting specifies the keyword tables to use for this file. Lines from the file are scanned for the first matching keyword in the keyword tables, which will trigger a new row in the dataview. The file status will also change to the table severity.

Mandatory: No

files > file > tables > table

Specifies a single keyword table to use for the file.

Mandatory: No

files > file > tables > table > severity

Specifies the severity of this table for the file. The severity controls the resulting file status when a keyword in this table is detected. It may also control which order the tables are checked in, depending upon the value of the reorderKeywordTables setting.

Possible values are as follows:

SeverityDescription
failA "fail" state is produced for any matching keys. This corresponds with a severity of critical (and appears red), if using the suggested rules. Fail tables are checked before warning tables by default.
warningA "warning" state is produced for any matching keys in a warning table.

Mandatory: Yes

files > file > tables > table > keyTable

The key table setting contains the actual table definition (the keywords). This setting can either reference an FKM table defined in the "static variables" section of the gateway setup, or a table can be defined here directly.

See the fkmTable setting for a full description of keyword configuration options.

Mandatory: Yes

files > file > tables > table > activeTime

The activeTime setting references an activeTime definition from elsewhere in the gateway setup. When FKM checks a file for keywords, the activeTime for the keyword table is also checked. If the time is inactive, then the keyword table referencing this time is skipped (no keys defined within the table are checked for in the file).

This setting can be used to configure a file with different sets of keywords, allowing different conditions to be monitored during different periods of the day.

This setting can be used in conjunction with the keyword-level activeTime. If the time is active, then the keyword's activeTime is further checked for scanning.

Inactive keyword tables can optionally be scanned for any clear-keys in the table using the checkInactiveClearKeys plug-in setting.

Mandatory: No
Default: No active time is set (the keyword table is always active).

files > file > failTable

The fail table setting specifies an optional fail table of keys for the file. Any file lines which contain a key defined in this table will cause the file status to change to FAIL.

This setting has been deprecated in favour of the more general table setting. Please configure a table with a severity of "fail" rather than use this setting.

Mandatory: No

files > file > warningTable

The warning table setting specifies an optional table of warning keys for the file. Any file lines which contain a key defined in this table will cause the file status to change to WARNING.

This setting has been deprecated in favour of the more general table setting. Please configure a table with a severity of "warning" rather than use this setting.

Mandatory: No

fkmTable > keys

This setting defines a set of keys to make up an FKM key table. This table will only be accessible for the specific file it is being configured for. To share a table definition between files, configure a table as a static variable and reference it using the fkmTable setting.

Mandatory: No

fkmTable > keys > key

Defines a single key in a set of keys.

Mandatory: No

fkmTable > keys > key > setKey

A set key defines a key to search for. If this key matches, a trigger will be created.

Mandatory: No

fkmTable > keys > key > setKey > match

A match set key specifies some text which must appear in the file line to cause a match.

Mandatory: No

fkmTable > keyearchString > key > setKey > match > searchString

Specifies the string literal or regular expression to search for in the file line.

The search string may also contain a date expansion, which will be replaced with the formatted date on the first sample of each day. If the search string is a regex, then the expansion will be performed before the string is interpreted as a regex. Date expansions can be controlled using the expandDatesInKeywords plug-in setting.

Mandatory: Yes

fkmTable > keys > key > setKey > match > rules

Specifies the match mode to be used when matching.

ModeDescription
BASICBasic matching searches the file line for the search string using case insensitive comparison.
REGEXP

Regular expression matching searches the file line for text matching the regular expression.

Note: The regular expression does not need to specify a pattern that matches the whole file line if not required. Doing so will reduce the matching speed and hence plug-in performance.

REGEXP_IGNORE_CASEThis option selects regular expression matching (as above) but performs case-insensitive matching (i.e. the case is ignored).

Mandatory: No
Default: BASIC

fkmTable > keys > key > setKey > updated

If an updated key is added to a key set, then this will trigger when the file is updated or changed in any way (including the creation of a new file with the same name). This can be used for example, to ensure that a system configuration file does not change.

If an updated key has been specified in a key table, then any notUpdatedIn keys will be ignored.

Mandatory: No

fkmTable > keys > key > setKey > notUpdatedIn

The notUpdatedIn key type is the inverse of the updated key above. This key can be used to alert users if the associated file has not been updated for a period of time. The value of this setting specifies this period as a number of seconds.

Mandatory: No

fkmTable > keys > key > clearKey

A clear key specifies an additional match for this key. If a file line matches the match key (creating a trigger) and a file line later match this clear key, the created trigger will be automatically removed.

Mandatory: No

fkmTable > keys > key > clearKey > match

A match clear key specifies some text which must appear in the file line to cause a match.

Mandatory: No

fkmTable > keys > key > clearKey > match > searchString

Specifies the string literal or regular expression to search for in the file line.

Search strings can refer to specific parts of the matching text to clear specific conditions. See Using dollar references and capture groups.

Mandatory: Yes

fkmTable > keys > key > clearKey > match > rules

Specifies whether the searchString will be matched using case-insensitive matching (BASIC) or regular expressions (REGEXP). See the match key rules setting for more information.

Mandatory: No
Default: BASIC

fkmTable > keys > key > clearKey > mode

The mode setting controls what rows are cleared when a clear key match is found. This setting overrides the plug-in default value (as specified by the defaultClearMode setting) for a particular key.

ModeDescription
latestThe latest matching trigger row is cleared by the clear key.
allAll trigger rows created by this key are cleared by the clear key.

Mandatory: No
Default: latest

fkmTable > keys > key > clearTime

This setting controls the length of time a trigger row will remain in the dataview after it is first detected. The setting value specifies the number of seconds the row will remain. If this setting is not specified the trigger row will remain in the view until manually accepted by the user, or is removed as part of accepting (or clearing) a file.

Mandatory: No
Default: 0 seconds (trigger row is never removed)

fkmTable > keys > key > message

Specifies an optional message which is displayed in the triggerDetails column of the created trigger row (in addition to the normal trigger details).

The message can refer to specific parts of the matching text to provide additional information. See Using dollar references and capture groups.

Mandatory: No

fkmTable > keys > key > tags

This setting specifies start and end tags which can be used to parse the triggerDetails output for a line matching this key. This can be helpful for extracting useful information from a long file line.

Tags specified at key level override those specified in the plug-in tags setting. The parseTriggerDetails setting must be enabled for this to take effect.

Mandatory: No

fkmTable > keys > key > extractors

This section allows you to specify a list of extractors for your keyword. An extractor is a regex pattern which is applied to the file line after the line is found to match the keyword.

The extractor regex is then matched against the file line and used to extract a piece of text, which is displayed in a dataview column against the trigger row created for the key. These columns can give hints to users of AC2 as to important parts of a message, and are also passed to action scripts if an action fires for that row.

Mandatory: No

fkmTable > keys > key > extractors > extractor > name

This setting sets the name of the extractor - this name is also used as the column name in FKM and so must not be the same as any existing FKM columns. The name should also be different to any other extractors defined in the key, but the same name can be used across multiple keys.

Mandatory: Yes

fkmTable > keys > key > extractors > extractor > regex

Specifies the regex pattern used to extract part of the file line. This regex pattern must contain a grouping (parentheses), which will then be used as the extracted value.

e.g. For the extractor "Connectionerror#([0-9]*)" the extracted part of the message is the part which matches the parenthesised part of the pattern "[0-9]*". Given the file line "Connection error #2058 - check queue manager name", the extracted string is then "2058".

Mandatory: Yes

fkmTable > keys > key > severity

This severity setting allows the user to override the severity of a table for a particular key definition. For example using this setting you could configure a "warning" key inside a table which is defined with a "fail" severity (i.e. a fail table). If this setting is not specified then the key inherits the table severity.

Possible values are described below:

SeverityDescription
failText found to match this key is triggered with a "fail" severity.
warningText found to match this key is triggered with a "warning" severity.

Mandatory: No
Default: Key inherits the table severity if setting is not specified.

fkmTable > keys > key > activeTime

The activeTime setting references an activeTime definition from elsewhere in the gateway setup. This time controls whether a keyword defined in the keyword table for a file is enabled or disabled.

If the activeTime for the file-level and keyword table-level is active or not configured, then the time for the keyword is scanned. If the time is inactive then file lines are not scanned for the keyword (which includes set-key and ignore-key).

Mandatory: No
Default: No active time is set (keyword is always active).

fkmTable > keys > ignoreKey

An ignore key works in the same was as a match key. However rather than creating a trigger row when the key is detected, an ignore key silently ignores the line.

Ignore keys are typically used to filter out file lines which would otherwise match a key and create a trigger. For example, a server log may contain several lines starting "Failed to …" where some of these messages are innocuous. An ignore key could be used to ignore the known messages, and a match key configured to catch all other failures.

As keys in a key table are checked against a file line in order of definition, an ignore key must be specified earlier in the table than the key(s) which it is protecting.

Note: Ignore keys will have no effect if continue trigger scan is set.

Mandatory: No

fkmTable > keys > ignoreKey > searchString

Specifies the string literal or regular expression to search for in the file line.

Mandatory: Yes

fkmTable > keys > ignoreKey > rules

Specifies whether the searchString will be matched using case-insensitive matching (BASIC) or regular expressions (REGEXP). See the match key rules setting for more information.

Mandatory: No
Default: BASIC

fkmTable > keys > ignoreKey > activeTime

The activeTime setting references an activeTime definition from elsewhere in the gateway setup. This time controls whether a keyword defined in the keyword table for a file is enabled or disabled.

If the activeTime for the file-level and keyword table-level is active or not configured, then the time for the keyword is scanned. If the time is inactive then file lines are not scanned for the keyword (which includes set-key and ignore-key).

Mandatory: No
Default: No active time is set (keyword is always active).

Display configuration

The settings described in this section affect how data is displayed by FKM in the published dataview. Values in the dataview are transmitted to gateway in this form, and so changes to display settings will also alter the data that gateway receives (and so possibly the result of rule evaluations).

display

This section is used to configure display-related settings. These settings change how data is displayed by FKM in the published dataview, and so affects the whole plug-in rather than a particular file.

Mandatory: No

display > columns

The columns setting allows users to configure the list of columns displayed by FKM in the dataview. The contents of these columns are described in more detail in the example view table legend above.

Possible values are as follows:

ColumnDescription
statusFile status (OK, WARNING, FAIL, NOT_FOUND, or HEARTBEAT_NOT_FOUND).
permissionsFile permissions (read write execute).
lastModificationTimeTime the file was last modified.
fileSizeCurrent file size.
updateRateCurrent update rate (rate of growth).
triggerDetailsDetails of detected trigger.
secondsSinceLastTriggerNumber of seconds since a trigger was last detected.
triggerCountNumber of triggers detected.
filenameFull name of the file (for files with wildcard names).
absolutePathFull path to the file (including the filename).
secondsSinceLastModifiedNumber of seconds since the file was last modified.

Note: The name column is always displayed as the first column in the dataview.

Mandatory: No
Default: status, permissions, lastModificationTime, fileSize, updateRate, triggerDetails, filename.

display > triggerMode

The trigger mode describes how multiple triggers are displayed by FKM. Trigger rows in a dataview always appear with the name indented, underneath the file row.

ModeDescription
SINGLEIn single trigger mode, FKM will only show one trigger row per key, per file. This means that if the same key appears twice (or more) in a file then only the details for the latest-detected line matching that key will be shown.
SINGLE_GROUPED_MESSAGE

Single trigger mode, where the triggers are grouped by the message. In this mode the names of trigger rows are displayed as <file>#<message>, where message is taken from the message setting of the key definition.

When using this option, it is recommended to keep the message brief to aid display in ActiveConsole.

MULTIPLEIn multiple trigger mode, FKM will show a new trigger row for each detected key. Detected keys for each file are then indexed by increasing number starting at 0. Later numbers indicate later detected keys.
MULTIPLE_GROUPED_TRIGGER

Multiple trigger mode, where the triggers are grouped by the match key. In this mode the names of trigger rows are displayed in the format <file>#<type>-<key>-<number> (e.g. app.log#fail-error filling order-0024).

This causes the trigger to be sorted on the key which generated the line, and so show up in groups.


Mandatory: No
Default: SINGLE

display > lastTriggerInStatus

When FKM detects a new trigger, the file status is to include the file line of the latest-detected trigger. This setting enables users to disable this behaviour (by setting the value to false), so that the file status is displayed only as FAIL or WARNING.

Mandatory: No
Default: true

display > notFoundMessage

When a file could not be opened, FKM changes the status to NOT_FOUND and also displays an additional information message on why the file could not be opened. Typically this is because the file does not exist, but can sometimes be due to other errors such as insufficient permissions. These additional messages can be disabled by changing this setting to false.

Mandatory: No
Default: true

display > triggerMessages

If a message has been configured for a key, the triggerDetails column of the trigger row for this key will display the text <message>(<line>) where line is the line of the file in which the key was detected. Setting the value of this setting to false will omit the message text from this column.

Mandatory: No
Default: true

display > showLastModificationTimeInSeconds

The last modification time as displayed in the lastModificationTime column is shown in a human-readable format. Setting this setting to true will show this time as the number of seconds since Jan 1 1970 (aka Unix time) which allows for numerical comparisons in rules.

Mandatory: No
Default: false

display > showSecondsSinceLastTrigger

Adds the secondsSinceLastTrigger column to the list of columns displayed by default. This column can also be displayed by setting it explicitly using the display columns setting.

The behaviour of this column can be affected by the Trigger Count Mode setting.

Mandatory: No
Default: false

display > showControlCharsAsSpaces

When monitoring binary file, the contents of a file line can sometimes contain non-printing binary (control) characters. If a key is detected on this line the triggerDetails column will display the line but any control characters will not be displayed, leading to a compacted line which can be hard to read. This is particularly relevant for files containing FIX messages.

Enabling this setting will cause FKM to replace all control characters with spaces when data is published in a dataview. This is done after the file line has been scanned for trigger keys. Control characters are also replaced when using the "View File" and "View File near Trigger" right-click menu commands so that the output appears as expected.

Whitespace characters such as spaces, tabs or newline characters are not counted as control characters for the purposes of replacement.

Mandatory: No
Default: false

display > showControlCharsAsChar

This setting is similar to the showControlCharsAsSpaces above, however it allows the user to configure the character which will be used to replace non-printing control characters. Characters are replaced prior to the file line being displayed in the FKM dataview, and also in the results of any "view file" right-click menu command options.

Characters can be specified by entering a single replacement character. Alternatively, it can also be specified using the hexadecimal character code in the form 0xHH where HH is a hexadecimal number. E.g. 0x20 specifies the space character. A list of characters and their codes can be found on the ASCII table website.

Whitespace characters such as spaces, tabs or newline characters are not counted as control characters for the purposes of replacement.

Mandatory: No
Default: no characters are replaced

display > triggerCountMode

The trigger count mode setting controls the contents displayed in the triggerCount and secondsSinceLastTrigger columns. This setting only takes effect if the triggerMode setting is set to MULTIPLE_GROUPED_TRIGGER or MULTIPLE.

The following values can be specified for this setting:

ModeDescription
SUM

The triggerCount column shows the sum of the active trigger rows (i.e. displayed in the dataview) for that file.

The secondsSinceLastTrigger column will show the seconds since the last trigger row was generated (i.e. displayed in the dataview) for that file.

CUMULATIVE_TOTAL

The triggerCount column shows the cumulative total of all conditions detected for the file, regardless of whether the trigger was ever displayed in the dataview. (i.e. This count also includes trigger rows which were not displayed because the max. condition count was reached).

The count is reset when the Netprobe or plug-in is restarted, if the "acceptFile" command is executed for the file, or if the user-configured clear time for the file is reached.

The secondsSinceLastTrigger column will show the seconds since the last trigger - regardless of whether that trigger is displayed or not.


Mandatory: No
Default: SUM

display > useFullPathInRowNames

If set, causes the full path of the file to be used in the rowName. This prevents duplicate rows when monitoring files of the same name in different directories using wildcard filenames, with the wildcardMonitorAllMatches setting enabled. By default, only filenames are used as row names when displaying wildcard matches with wildcardMonitorAllMatches enabled.

Mandatory: No
Default: false

display > fileSizeDisplayMode

This setting controls how the fileSize column in the Dataview is formatted. If left un-specified the fileSize column is formatted in kilobytes, otherwise the chosen unit is used.

The following values can be specified for this setting:

ModeDescription
BYTESThe fileSize column is formatted in bytes, e.g., "50 b".
KILOBYTESThe fileSize column is formatted in kilobytes, e.g., "2.0 Kb".

Mandatory: No
Default: KILOBYTES

File scan settings

The settings described in this section control various options which affect how FKM will scan the monitored log files.

isPCREMode

This setting determines whether we are using Perl Compatible Regular Expressions (http://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions). If this setting is specified, the system's regex library is not used.

Mandatory: No
Default: false

maxSamplesLagging

This setting determines how many samples a file can lag for before the file is ignored as updating too fast. A file is counted as lagging if the last line processed for the file in a sample is not (currently) the last line in the file. This will typically occur because the limit of lines to process has been reached (see maxLinesProcessed below).

If a file is lagging for more than the maximum number of samples, it will then be ignored until a user manually accepts the file. An alert to this effect is displayed in the status column for the file.

Mandatory: No
Default: 20

maxLinesProcessed

This setting controls how many lines (per file) will be processed in a single sample. This works in conjunction with the maxSamplesLagging setting (above) to determine if a file is updating too fast.

Mandatory: No
Default: 20000

excessiveUpdatesTimeout

If a file is updating at a very fast rate, this can be an indication that a process is malfunctioning. FKM reads a maximum of 20,000 lines per sample. If more than this limit is written to the file for 20 consecutive samples, then processing of this file stops and the message "WARNING: FKM stopped on this file - excessive update rate detected." is displayed in the status column for that file.

It is possible by enabling this setting to automatically accept an "excessive update rate" error. When this option is enabled and FKM detects a file to be growing too rapidly, it skips to the end of a file and generates a condition (as if a keyword was detected) warning the user of this error. This condition will then be removed after the specified period of time. If you do not wish the condition to be removed unless manually removed, set the timeout to 0.

Mandatory: No
Default: unset
Units: seconds

maxConditionsPerSample

This setting controls how many trigger rows (conditions) are recorded in a single sample. This is used primarily in multiple trigger mode (see triggerMode above) to limit the number of triggers which will be created. Triggers created after this limit is reached are displayed in the next sample.

Mandatory: No
Default: 1000

maxConditionsPerFile

This setting controls how many trigger rows (conditions) are recorded per file. This is used primarily in multiple trigger mode (see triggerMode above) to limit the number of triggers which will be created. Triggers created after this limit is reached are lost.

Mandatory: No
Default: 1000

maxConditionsPerKey

This setting controls how many trigger rows (conditions) are recorded per file, for a particular key which generated them. This is used primarily in multiple trigger mode and single grouped message mode (see triggerModeabove) to limit the number of triggers which will be created.

This setting gives finer-grained control than the maxConditionsPerFile setting, since it ensures that a lot of one type of detected key cannot prevent a different key from being displayed.

If a new trigger arrives after this limit has been reached, the oldest trigger for the key will be removed, and replaced with the new trigger.

Mandatory: No
Default: 1000

maxConditionID

This setting controls the numbering of trigger rows (conditions) when using multiple trigger mode (see triggerMode above). Successive triggers are numbered in increasing order, until this limit is reached at which point numbering starts again from 0. Numbering is also reset when accepting a file.

Mandatory: No
Default: 10000

checkIgnoreFiles

Setting this setting to true instructs FKM plug-in to check monitored files for the presence of an ignore file, which is required when using the ignore file feature. This feature is disabled by default, since it increases CPU usage by a small (but unnecessary for most users) amount.

Mandatory: No
Default: false

defaultIgnoreFilePath

By default the netprobe looks in the current working directory for ignore files. This option allows the user to configure an alternate location. This functionality is only available for Gateway2.

Mandatory: No
Default: .

defaultIgnoreFileName

Specifies the default ignore file to reference for all files monitored by the sampler. This functionality is only available for Gateway2.

Mandatory: No

continueTriggerScan

By default FKM will stop scanning a file line for matching keys as soon as the first match is found, at which point a trigger is created. By enabling this option, FKM will match a file line against every configured key and display a trigger for each one that matched. This also therefore means that ignore keys will have no effect.

This option should only be used when absolutely required, as it will increase the processing requirements of the FKM plug-in (and hence increase CPU usage).

Mandatory: No
Default: false

singleTriggerCleartimes

In single trigger mode, enabling this option will cause the triggerCount column to display a total count of triggers currently detected, for the key associated with that trigger row.

This count will also be affected by a clearTime configured for that key, so that as a keys are cleared this count decreases, which is not the case if this setting is disabled.

Mandatory: No
Default: false

wildcardMonitorAllMatches

This setting controls how FKM treats files containing wildcard characters (* and ?). By default only the latest file (see wildcardMatchTime setting below) will be monitored. By enabling this option all files matching the pattern will be monitored.

When matching all files, new file rows are created for each matching file found. Settings for these files are coped from the wild-carded file definition. These rows are removed when the file is no longer found to match the pattern, which can happen if the file is deleted or if the date changes and the filename contains a <today> expansion.

Mandatory: No
Default: false

wildcardMatchTime

This setting controls which file timestamp is used to determine the file to monitor, when a filename is configured that contains wildcard characters (* and ?). Possible values are as follows:

TimeEffect
changed

In Unix, the changed time is updated when a file inode is updated, which occurs when a file is created, moved, copied, or the file permissions are changed.

This is the default FKM setting since most processes monitored by FKM tend to roll-over log files by creating a new file and using this for logging. In addition some backup utilities alter the modification time during backup, which can interfere with monitoring if this time is checked.

Note: The value of changed time for Windows and Unix is not the same. In Windows, the changed time is the same with creation time. It does not change even if the status of the file changes.

modifiedThe modified time is updated when the content of a file is changed. This time may be preferred over the changed time if monitored log files will be renamed or their permissions changed.

Mandatory: No
Default: changed

tags

This setting defines trigger parsing tags used in conjunction with the parseTriggerDetails setting. If trigger parsing is enabled, then the text displayed in the triggerDetails column is parsed according to the startTag and endTag settings. This feature can be used to reduce the file line displayed, allowing the user to quickly focus on the important information.

If a startTag has been configured and is contained within the line, the result will be the text following the first instance of the startTag (if found) - the text from the start to the first startTag (inclusive) will be removed.

An endTag works similarly, except that the text from the last instance of an endTag (if found) until the end of the line is removed.

For example:

StartTagEndTagFile lineResult
[]Error opening file [no permissions]no permissions
occurred:A fatal problem occurred: out of memoryout of memory
occurred:A fatal problem caused the program to exit.A fatal problem caused the program to exit.
""

Event filter failed with query

SELECT * from _InstanceModified
WHERE Instance "Win32_Process"
AND Load > 50
SELECT * from _InstanceModified
WHERE Instance "Win32_Process"
AND Load > 50

Either or both of these tags can be overridden by tags in a key definition for more specific parsing.

Mandatory: No

parseTriggerDetails

This setting controls whether the values that appear in the triggerDetails column will be parsed using start and end tags. These tags can be defined either globally for the FKM plug-in instance (see tags above), or selectively for specific keys via the key tags setting.

Mandatory: No
Default: false

wrapViewFileNearTriggerLines

This option controls the wrapping of lines in the output of a "view file near trigger" command.

When enabled, line wrapping will be performed when a line reaches approx. 170 characters in length. If disabled, lines will be displayed in AC2 at their full length.

Mandatory: No
Default: True (to maintain expected behaviour)

reorderKeywordTables

By default, file lines are checked for external ignore keys, then keywords from any fail tables, and finally keywords from warning tables. This is done by reordering the keyword tables for a file to be in this order.

The reorderKeywordTables setting controls whether this reordering is performed. If disabled (set to false) the keyword tables will be checked in the order they are defined in the file configuration.

Mandatory: No
Default: true

checkInactiveClearKeys

This setting controls whether clear keys inside an inactive keyword table are checked against a file.

A keyword table is made up of several keywords types; keys, ignore keys, and clear keys. An activeTime can be configured on a file, keyword table or on a keyword itself.

For a keyword: When this time is inactive, the keyword will not be scanned.

For a keyword table: When this time is inactive, then the whole table is not used for scanning.

For a file: When this time is inactive, no file content will be scanned.

If this option is enabled, then only the active clear keys in an inactive keyword table will still be checked. Inactive keywords will not be checked.

Mandatory: No
Default: false

defaultClearMode

The default clear mode specifies how clear keys operate on a plug-in global basis. All clear keys will use this behaviour, unless specifically overridden for the key by the clearKey mode setting.

ModeDescription
latestThe latest matching trigger row is cleared by the clear key.
allAll trigger rows created by this key are cleared by the clear key.

Mandatory: No
Default: latest

expandDatesInKeywords

FKM keywords may be configured with a date expansion string, e.g. <today>. This string updated each day with the current date. This feature can be controlled by means of this setting.

Mandatory: No
Default: true (dates are expanded)

monitoredDays

This setting allows the FKM to resolve date expansion codes used in file names based only on certain days of the week. For example, this can be set to resolve date codes based only on weekdays, i.e. yesterday resolves to last Friday if the current day is a Monday or a weekend, and tomorrow resolves to next Monday if the current day is a Friday or a weekend. Check the appropriate day boxes to mark them as monitored. The today code always resolves to the current day, even if the current day is not marked as monitored.

Note: This setting is only used for resolving file names with date codes. It does not affect the monitoring of the plug-in on a certain day. See Date generation for more details on using date expansion codes in file names.

Mandatory: No
Default: Every day

internalTextEncoding

The internal text encoding is used by FKM when reading Unicode files. The value of this setting is passed to the iconv library (used for Unicode conversion) as the target encoding for text conversion. It is not recommended to change the value of this setting unless advised to do so by ITRS Support.

Mandatory: No
Default: "//TRANSLIT"

ignoreIfNotInActiveTime

Allows a user to suppress updates to the STATUS column for a file if the file is outside the configured activetime if this option has been enabled.

Mandatory: No
Default: false

defaultFileActiveTime

Specifies a default for the file active time setting. Files with no individual file active time specified will use this setting, files that do specify an active time override this setting.

Mandatory: No

extendedNTEventLogOutput

If set, FKM will output the event text using an extended format containing additional fields for each event, rather than just the defaults. The fields output are prefixed with the field name in extended mode, but not in default mode.

The mapping of the fields Geneos logs to the Event Viewer Windows application is as follows:

GeneosExtended?Prior to OS Vista maps toOS Vista and above maps to
DateNoDateLogged
TypeNoTypeLevel
SourceNoSourceSource
EventIDYesEvent IDEvent ID
UserYesUserUser
CategoryYesCategoryTask Category
ComputerYesComputerComputer
DescriptionNoDescriptionText field in the General tab

Example:

Date:07/11/2011 13:02:32 Type:Information event Source
Source:MSSQL$EXPRESS_2008_X86 EventID:26059 User:N/A Category:Server
Computer:ITRSPC139.ldn.itrs Description:The SQL Server Network Interface
library successfully registered the Service Principal Name (SPN) [
MSSQLSvc/ITRSPC139.ldn.itrs:EXPRESS_2008_X86 ] for the SQL Server
service.

These additional fields will also be present in the triggerDetails column.

If this option is not enabled the output would be in this format:

Mon Nov 07 13:02:32  INFO  MSSQL$EXPRESS_2008_X86    The SQL Server Network Interface
library successfully registered the Service Principal Name (SPN)
[ MSSQLSvc/ITRSPC139.ldn.itrs:EXPRESS_2008_X86 ] for the SQL Server service.
Mandatory: No
Default: False

lockFilePath

By default the netprobe looks in the current working directory for sampler and netprobe lock files. This option allows the user to configure an alternate location shared by both types of lock files. This option though does not apply to single lock files (see Suspending File Sampling).

Mandatory: No
Default: .

Additional details

Date generation

FKM file definitions can be configured to generate a filename using the current date and time. The target filename is generated every sample, and if a file exists which matches this name the file will be monitored by FKM (once the current file has been processed to the end).

Filenames can be generated using one of five date codes; yesterday, today, tomorrow, previous_monitored_day, andnext_monitored_day. These are replaced in the filename using the appropriate date.

For example, if the current date is 22 August, 2018, then the following will be produced:

FilenameGenerated name
app<yesterday>.logapp20180821.log
app<today>.logapp20180822.log
app<tomorrow>.logapp20180823.log
app<previous_monitored_day>.logapp20180821.log
app<next_monitored_day>.logapp20180823.log

The output format for dates can be controlled by placing format codes in the date tag. Examples of this usage are shown below.

FilenameGenerated name
app<today %d-%m-%Y>.logapp22-08-2008.log
app<today %d%b%y>.logapp22Aug08.log
app<tomorrow %d_%m_%Y>.logapp23_08_2008.log

The following formatting codes can be used with this feature.

CodeMeaning
%aAbbreviated weekday name. (e.g. Wed)
%AFull weekday name (e.g. Wednesday)
%bAbbreviated month name. (e.g. Mar)
%BFull month name (e.g. March)
%cDate and time representation appropriate for the current locale.
%dDay of month as a decimal number (01 - 31).
%HHour in 24-hour clock format (00 - 23).
%IHour in 12-hour clock format (01 - 12).
%jDay of year as a decimal number (001 - 366).
%mMonth as a decimal number (01 - 12).
%MMinutes as a decimal number (00 - 59).
%pCurrent locale's AM / PM indicator for 12-hour clock.
%SSeconds as a decimal number (00 - 61).
%UWeek of the year as a decimal number, with Sunday as the first day. (00 - 53).
%wWeekday as a decimal number (0 - 6, with Sunday as 0).
%WWeek of the year as a decimal number, with Monday as the first day. (00 - 53).
%xDate representation appropriate for current locale.
%XTime representation appropriate for current locale.
%yYear without century, as a decimal number (00 - 99).
%YYear with century, as a decimal number (e.g. 2008).
%z, %ZTime-zone name or abbreviation (e.g. GMT or PST); no characters are shown if the time-zone is unknown.

Note: It is possible but not recommended to use a seconds (%S) or minutes (%M) time format code in a filename. This is because the generated filename will contain the time at which FKM performed a sample, which is not guaranteed to occur at an exact number of seconds apart.

Monitoring files containing binary data

Some log files may contain a mixture of text and binary data. This may cause a problem monitoring the file if the binary data contains a NUL character (ASCII 0), as the file line is truncated at the first occurrence of this character.

FKM can read these lines correctly, provided it knows the file contains binary data. This is slightly more CPU intensive than ordinary reading of pure text-files, and so is not enabled by default. Files can be marked as binary using the file contentType setting.

Note: As of gateway 2 it is no longer possible to set the file contentType setting using the FKM table. This must now always be set on the file.

In addition, the showControlCharsAsSpaces display setting may also be useful when monitoring binary files. This setting replaces control characters (non-printing characters) with spaces which can help to spread out FKM output making it easier to read.

Unicode files

FKM can monitor Unicode files, by using the iconv library (available on most Unix boxes by default) to convert the text from Unicode to the native system encoding. Because of this conversion, Unicode characters which cannot be represented by the native encoding will be skipped, and are therefore not available in FKM for keyword scanning or viewing.

To use this feature configure the file contentType setting to the encoding of the file. If you do not know the encoding FKM can attempt to detect this for you. Users can also specify the iconv encoding name directly, rather than using the drop-down menu to select an option.

Ignore files feature

Ignore files provide a mechanism for configuring ignore keys for an FKM file externally to the gateway setup. This allows users to dynamically ignore known problems (perhaps on a single machine) without reconfiguring the plug-in.

FKM will check for an ignore file once per sample, for each file. If the ignore file has been created (or the last modification time altered) the ignore file will be read. This file should contain a number of ignore keys, one key per file line. Ignore keys can be written as string literals or regular expressions. To specify regular expressions in an ignore file and differentiate them from string literals, they must be prefixed by "$$$RE " for case-sensitive expressions, or "$$$NCRE " if the case should be ignored.

ex.

$$$RE KEY_\d\d$

This ignores strings with "KEY_<two-digit number>" at the end, such as. "KEY_01"

$$$NCRE KEY_\d\d$

Using $$$NCRE ignores the case of "KEY", so "key_01" would also be ignored.

Ignore keys are processed before keys defined in a fail or warning table. If the ignore file is removed, all ignore keys from that file will also be removed.

The steps to configure this feature are below:

  1. Enable the ignore files feature by enabling the checkIgnoreFiles setting.
  2. Set the ignore file name to look up:
    1. Using file alias - Configure an FKM file you wish to monitor with an alias that is different to the filename. This alias then forms the base of the filename for the ignore file., with .ignore as the file extension (E.g. If the alias is myAlias then the expected ignore filename becomes myAlias.ignore).
    2. Set ignore file name directly using ignoreFileName to specify an ignore file for a monitored file, or defaultIgnoreFileName to specify a default ignore file for an entire sampler.
  3. Create an ignore file with the appropriate name in the Netprobe working directory, and add any desired ignore keys to the file, one per line.
  4. FKM will detect when this file is created, updated or deleted. All previously added ignore keywords will be removed and the file contents re-read on these events. A message indicating this will be shown in the Netprobe log file.

Note: It is possible to specify alternate locations for a plug-in to search in to locate ignore files. See defaultIgnoreFilePath and ignoreFilePath for more details.

Regular Expressions

Perl Compatible Regular Expressions (PCRE) can be used if isPCREMode is selected, please see isPCREMode for how to enable it. Using PCRE allows for more powerful and succinct regexs to be written. Examples are presented below,

PCREPOSIXBehaviour
\d[[:digit:]]Matches a digit.
[a-z][[:lower:]]Matches a lowercase letter.
[A-Z][[:upper:]]Matches an uppercase letter.

A great source for common Regular Expressions is http://www.regular-expressions.info/.

Some online tools which may also be helpful are http://www.regexpal.com or http://www.internetofficer.com/seo-tool/regex-tester.

If isPCREMode isn't enabled Regular Expressions in FKM use the POSIX extended regular expression syntax, and is typically implemented by system libraries. More information about these expressions can be found at Wikipedia or from the command line by typing "man7 regex".

A regular expression specifies a pattern of text to match, which can appear anywhere in the file line. This behaviour can be altered by using the special anchor characters ^ and $ (see below). Unless using these characters, it is not necessary to specify a pattern which matches the whole file line, since this will reduce matching speed.

Once a regular expression has been configured, it is highly recommended that the expression be tested by echoing the intended match text into a monitored file, to ensure that a match is detected.

Regular expressions match sequences of literal characters exactly. A character is a literal character if it is not a special character below.

Special CharactersBehaviour
\

Escape character. Use this to turn a special character into a literal.

E.g. \\ matches the character \, and \? matches the character ?.

.The dot character matches any single character. This is typically used with the asterisk to match any sequence of text, by using .*
[ ]

Brackets indicate a range of possible values which will match a single character. For example, the range [a-z] will match a single lower-case character in the alphabet.

Ranges can contain several characters in sequence, or several ranges. E.g. [abcA-Z0-9] will match the lower-case character a, b or c, as well as any upper-case alphabet character or digit.

Ranges can also be negated, by placing the ^ character at the start of a range. Thus [^0-9] will match any single character which is not a digit.

*

The asterisk character indicates that the preceding character or pattern can occur in the pattern any number of times (including never).

E.g. The pattern aa*b will match strings ab, aab, aaab, aaaab, etc…

The asterisk pattern can be applied not just to a single character, but a range of characters or a bracketed expression. E.g. [0-9]* will match a sequence of digits (including no digits).

+The plus character is similar to the asterisk above, but specifies that the preceding character or pattern must occur at least once.
?The question character is similar to plus and asterisk above, and specifies that the preceding character or pattern does not occur, or occurs only once.
{x,y}Braces indicate that the preceding character or pattern can occur at least x times to at most y times. If x and y are the same (i.e. the pattern must occur exactly x times) then the abbreviated syntax {x} can be used.
|The pipe character indicates alternation. This allows regular expressions to express an OR relationship. E.g. A pattern a(b|c) will match the text ab or ac.
( )Parentheses allow grouping of patterns in regular expressions. These groupings are typically so that the special characters above apply to a particular part of a pattern.
^

This anchor character allows a pattern to match a particular part of a file line, rather than appear anywhere in the line. The ^ character should appear at the start of the pattern, and indicates that the pattern must match at the start of the line.

e.g. ^hi will match the text "hithere", but not "thisway".

$This anchor character is similar to the caret (^) above, but matches the end of a line rather than the start.

Some example regular expressions are listed below.

Expression:end$
Matches: A file line which ends with the word "end".
Expression:^starts
Matches: A file line starting with the word "starts".
Expression:^[A-Z]\*word[^A-Z]\*i
Matches: A line starting with a (possibly empty) sequence of capital letters, then "word" followed by a (possibly empty) sequence of characters with no capital letters, followed by an "i".
Expression:...[0-9]
Matches: A line containing any three characters and then a digit.
Expression:X.[.][0-9]+
Matches: A line containing an X followed by any single character, then a dot and at least one digit.

Multi Line Variables In Actions

Outputting multi line messages stored in environment variables are not supported by any of the built-in echo commands for Windows, Solaris and Linux. To work around this issue you could use the following examples to output multi line messages from an environment variable.

Windows

VBScript has been used for this example as it is present in Windows 2000 and later.

Option Explicit

Dim objWindowsShell
Dim objEnvironment

Set objWindowsShell = WScript.CreateObject("WScript.Shell")

For Each objEnvironment In objWindowsShell.Environment("PROCESS")
        WScript.Echo objEnvironment
Next

Set objWindowsShell = Nothing
Solaris

Solaris

Note: The " marks are necessary around the variable to interpret it as a multi line string.

#!/bin/sh

/usr/bin/echo _ACTION         = "${_ACTION}"
/usr/bin/echo _SEVERITY       = "${_SEVERITY}"
/usr/bin/echo _VARIABLEPATH   = "${_VARIABLEPATH}"
/usr/bin/echo _GATEWAY        = "${_GATEWAY}"
/usr/bin/echo _PROBE          = "${_PROBE}"
/usr/bin/echo _NETPROBE_HOST  = "${_NETPROBE_HOST}"
/usr/bin/echo _MANAGED_ENTITY = "${_MANAGED_ENTITY}"
/usr/bin/echo _SAMPLER        = "${_SAMPLER}"
/usr/bin/echo _DATAVIEW       = "${_DATAVIEW}"
/usr/bin/echo _VARIABLE       = "${_VARIABLE}"
/usr/bin/echo _REPEATCOUNT    = "${_REPEATCOUNT}"
/usr/bin/echo _VALUE          = "${_VALUE}"

Linux

#!/bin/sh

/bin/echo _ACTION         = "${_ACTION}"
/bin/echo _SEVERITY       = "${_SEVERITY}"
/bin/echo _VARIABLEPATH   = "${_VARIABLEPATH}"
/bin/echo _GATEWAY        = "${_GATEWAY}"
/bin/echo _PROBE          = "${_PROBE}"
/bin/echo _NETPROBE_HOST  = "${_NETPROBE_HOST}"
/bin/echo _MANAGED_ENTITY = "${_MANAGED_ENTITY}"
/bin/echo _SAMPLER        = "${_SAMPLER}"
/bin/echo _DATAVIEW       = "${_DATAVIEW}"
/bin/echo _VARIABLE       = "${_VARIABLE}"
/bin/echo _REPEATCOUNT    = "${_REPEATCOUNT}"
/bin/echo _VALUE          = "${_VALUE}"

Using dollar references and capture groups

The set key search string can be a regular expression. In a regular expression, you can use parentheses to denote a numbered sub-expression, called a capturing group or capture group. Capture group zero denotes the entire matching text, capture group one is the first parenthesised expression, and so on.

The clear key search string and message settings can refer to capture groups in the set key regular expression to include text from the set key result. This is achieved using dollar references, in the form of $<number> or ${<number>}:

  • $1
  • $2
  • ${3}

An example for clear keys follows.

Suppose that your monitored file contained messages that looked something like:

Error machine A: Some details about the error
...
Error machine B: Some details about the error

Your set key search string could look like:

Errormachine(\w+)

And your clear key search string could look like:

Fixed machine ${1}

This allows you to clear errors specific to results from a particular match. If you have errors reported on machines A, B, and C when the matching message for machine A is received, your error condition for machine A will be cleared.

Be sure when writing your clear key search strings or messages that the dollar reference number actually matches a capture group in the set key search string regular expression. Otherwise, your clear key or message may not match.

Suspending File Sampling

FKM file access and sampling can be temporarily suspended to allow users to perform cleanup or housekeeping of monitored files without encountering possible file access conflicts with the plugin. This is done through the use of "lock files", which may correspond to suspending the sampling of a single file, an entire FKM sampler, or all FKM samplers configured in a netprobe at once. FKM checks for the existence of lock files on every sample. When the plugin detects a lock file, it suspends its operation based on the scope of the lock. File operations remain suspended until the lock file is removed. The plugin then resumes sampling based on where it left off before the lock was applied. This behavior is similar to when active times are used to deactivate and reactivate a plugin.

Lock File Name Format and Usage

Lock files follow specific naming formats depending on their intended scope. They all use the ".geneos-lock" extension to differentiate themselves from other files. The user is responsible for creating and destroying the lock files accordingly.

To suspend the sampling of individual files, a lock file must be created using the name of the target file as the base name, followed by the extension.

Ex. For a file named example.log, the corresponding lock file should be named example.log.geneos-lock

The user must create the lock file in the same directory as the target file to ensure that FKM matches the lock file to the correct target file. When a file is locked, the status field for that file is updated. The lock file can contain the name of the lock creator/owner, which would be displayed in the status message.

fkm15

If the lock file is empty, the status would read "SUSPENDED: Sampling locked by unknown user" instead.

To suspend the sampling of a FKM sampler, a lock file must be created with the format <sampler name>_fkm.geneos-lock.

Ex. For a FKM sampler named "Log Sampler", the corresponding lock file should be named "LogSampler_fkm.geneos-lock"

By default the user must create the sampler lock file in the current working directory of the netprobe. The user though has an option to set a different path where the plugin should look for the lock file. The Fkm lock file path setting is located in the Advanced tab of the probe settings section in the gateway setup. When this setting is used, All FKM samplers defined in the probe will look for sampler and netprobe lock files in the specified path.

fkm16

When a sampler is locked, the sampling status headline is updated. Other fields in the view remain as they are from the last sample. The sampler lock file can contain the name of the lock creator/owner, which would be displayed in the status message. If the file is empty, "unknown user" would be displayed by default, as described earlier.

fkm17

To suspend the sampling of all FKM samplers configured in a netprobe, a lock file must be created with the format netprobe_<port number>_fkm.geneos-lock, with the port number being used to identify the target netprobe.

Ex. For a netprobe using port number 7036, the corresponding lock file should be named netprobe_7036_fkm.geneos-lock

As with sampler lock files, the user must create the netprobe lock file in the current working directory of the netprobe by default, but has an option to set a different path through the Fkm lock filepath setting. When a netprobe is locked, the views for all FKM samplers in the netprobe are updated the same way as when a single FKM sampler is locked.

Extended Audit Details

FKM provides extended audit details if this feature is enabled in the gateway. For more information regarding the general extended audit details mechanism, see the section on "Extended Audit Details" in the gateway reference guide.

Commands

The following commands executed on the FKM sampler dataview will result in extended audit details being provided:

  • All Snooze related commands.
  • All User-assignment related commands.
  • All FKM specific commands (accept, clear, etc.)

Contents

The audit details will consist of information about the triggers that pertain to a particular command execution.

For each trigger, the trigger message and the original file line will be provided as values. With reference to the audit details format, each trigger will be a separate item, with each item having two field-value pairs for the message and file line respectively. E.g.:

ItemFieldValue
myfile.log#warning12messageOverflow
myfile.log#warning12line10:30:20 Warning: possible overflow….
myfile.log#warning14messageOverflow
myfile.log#warning14line10:30:25 Warning: overflow….

Targets

The set of triggers that information is provided on will depend on the execution target:

TargetInformation will be provided on…
Trigger row (a row that represents a single trigger under a given file)The particular trigger represented by the row.
File row (a row that represents a particular file)All current triggers pertaining to that file. (This means that if there are currently no triggers for a given file, then no extended audit details will be reported against that file.)

Special Case: 'Accept file' and 'Accept this file' commands

In this case information will be provided about all the triggers under the particular files, regardless of whether the command was executed on a file or trigger row.

Special Case: Single Grouped Message trigger mode

Under this mode, for each trigger row, information about each actual trigger that pertains to the visible row will be provided as audit details. The set of triggers in this case will be the same as shown in the output of the Trigger Details command executed against that trigger row. See Trigger Details Command for more information.

Note: Similar to the Trigger Details command, the number of trigger lines provided as audit details will be limited by the maxConditionsPerKey setting. In situations where large numbers of triggers can be active at any given time, it may be practical to reduce the amount of extended audit detail recorded against auditable events by lowering the value of this setting, especially considering the fact that, under single grouped message trigger mode, the amount of audit details collected by running a command against any given trigger row is not immediately obvious.