`CheckLogFile`
File for checking log files and various other forms of updating text files

# `CheckLogFile` — CheckLogFile

File for checking log files and various other forms of updating text files

Queries (Overview):

A list of all available queries (check commands)

Command | Description
--- | ---
`check_logfile` | Check for errors in log file or generic pattern matching in text files.

Aliases (Overview):

A list of all short hand aliases for queries (check commands)

Command | Description
--- | ---
checklogfile | Alias for: `check_logfile`

Commands (Overview):

TODO: Add a list of all external commands (this is not check commands)

Configuration (Overview):

Common Keys:

Path / Section | Key | Description
--- | --- | ---
`/settings/logfile/real-time` | `enabled` | REAL TIME CHECKING

## Queries

A quick reference for all available queries (check commands) in the CheckLogFile module.

### `check_logfile`

`CheckLogFile` `check_logfile`
Check for errors in log file or generic pattern matching in text files.

Usage:

Option | Default Value | Description
--- | --- | ---
`help` | N/A | Show help screen (this screen)
`help-pb` | N/A | Show help screen as a protocol buffer payload
`show-default` | N/A | Show default values for a given command
`help-short` | N/A | Show help screen (short format).
`debug` | N/A | Show debugging information in the log
`show-all` | N/A | Show debugging information in the log
`filter` |  | Filter which marks interesting items.
`warning` |  | Filter which marks items which generates a warning state.
`warn` |  | Short alias for warning
`critical` |  | Filter which marks items which generates a critical state.
`crit` |  | Short alias for critical.
`ok` |  | Filter which marks items which generates an ok state.
`empty-state` | ignored | Return status to use when nothing matched filter.
`perf-config` |  | Performance data generation configuration
`top-syntax` | ${count}/${total} (${problem_list}) | Top level syntax.
`ok-syntax` |  | ok syntax.
`empty-syntax` | %(status): Nothing found | Empty syntax.
`detail-syntax` | ${column1} | Detail level syntax.
`perf-syntax` | ${column1} | Performance alias syntax.
`line-split` | n | Character string used to split a file into several lines (default n)
`column-split` | t | Character string to split a line into several columns (default t)
`split` |  | Alias for split-column
`file` |  | File to read (can be specified multiple times to check multiple files.
`files` |  | A comma separated list of files to scan (same as file except a list)

#### Arguments

`help` (CheckLogFile, check_logfile)
  Show help screen (this screen)

`help-pb` (CheckLogFile, check_logfile)
  Show help screen as a protocol buffer payload

`show-default` (CheckLogFile, check_logfile)
  Show default values for a given command

`help-short` (CheckLogFile, check_logfile)
  Show help screen (short format).

`debug` (CheckLogFile, check_logfile)
  Show debugging information in the log

`show-all` (CheckLogFile, check_logfile)
  Show debugging information in the log

`filter` (CheckLogFile, check_logfile)
  Filter which marks interesting items.
  Interesting items are items which will be included in the check.
  They do not denote warning or critical state but they are checked use this to filter out unwanted items.
  Available options:

  column1 column2 column3 column4 column5 column6 column7 column8 column9 file filename line column() Syntax: column(<coulmn number>) count total ok_count warn_count crit_count problem_count list ok_list warn_list crit_list problem_list detail_list status ================================

`warning` (CheckLogFile, check_logfile)
  Filter which marks items which generates a warning state.
  If anything matches this filter the return status will be escalated to warning.
  Available options:

  column1 column2 column3 column4 column5 column6 column7 column8 column9 file filename line column() Syntax: column(<coulmn number>) count total ok_count warn_count crit_count problem_count list ok_list warn_list crit_list problem_list detail_list status ================================

`warn` (CheckLogFile, check_logfile)
  Short alias for warning

`critical` (CheckLogFile, check_logfile)
  Filter which marks items which generates a critical state.
  If anything matches this filter the return status will be escalated to critical.
  Available options:

  column1 column2 column3 column4 column5 column6 column7 column8 column9 file filename line column() Syntax: column(<coulmn number>) count total ok_count warn_count crit_count problem_count list ok_list warn_list crit_list problem_list detail_list status ================================

`crit` (CheckLogFile, check_logfile)
  Short alias for critical.

`ok` (CheckLogFile, check_logfile)
  Filter which marks items which generates an ok state.
  If anything matches this any previous state for this item will be reset to ok.
  Available options:

  column1 column2 column3 column4 column5 column6 column7 column8 column9 file filename line column() Syntax: column(<coulmn number>) count total ok_count warn_count crit_count problem_count list ok_list warn_list crit_list problem_list detail_list status ================================

`empty-state` (CheckLogFile, check_logfile)
  Return status to use when nothing matched filter.
  If no filter is specified this will never happen unless the file is empty.

`perf-config` (CheckLogFile, check_logfile)
  Performance data generation configuration
  TODO: obj ( key: value; key: value) obj (key:valuer;key:value)

`top-syntax` (CheckLogFile, check_logfile)
  Top level syntax.
  Used to format the message to return can include strings as well as special keywords such as:

  Key | Value
  %(column1) | The value in the first column
  %(column2) | The value in the second column
  %(column3) | The value in the third column
  %(column4) | The value in the 4:th column
  %(column5) | The value in the 5:th column
  %(column6) | The value in the 6:th column
  %(column7) | The value in the 7:th column
  %(column8) | The value in the 8:th column
  %(column9) | The value in the 9:th column
  %(file) | The name of the file
  %(filename) | The name of the file
  %(line) | Match the content of an entire line
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`ok-syntax` (CheckLogFile, check_logfile)
  ok syntax.
  DEPRECATED! This is the syntax for when an ok result is returned.
  This value will not be used if your syntax contains %(list) or %(count).

`empty-syntax` (CheckLogFile, check_logfile)
  Empty syntax.
  DEPRECATED! This is the syntax for when nothing matches the filter.
  Possible values are:

  Key | Value
  %(column1) | The value in the first column
  %(column2) | The value in the second column
  %(column3) | The value in the third column
  %(column4) | The value in the 4:th column
  %(column5) | The value in the 5:th column
  %(column6) | The value in the 6:th column
  %(column7) | The value in the 7:th column
  %(column8) | The value in the 8:th column
  %(column9) | The value in the 9:th column
  %(file) | The name of the file
  %(filename) | The name of the file
  %(line) | Match the content of an entire line
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`detail-syntax` (CheckLogFile, check_logfile)
  Detail level syntax.
  This is the syntax of each item in the list of top-syntax (see above).
  Possible values are:

  Key | Value
  %(column1) | The value in the first column
  %(column2) | The value in the second column
  %(column3) | The value in the third column
  %(column4) | The value in the 4:th column
  %(column5) | The value in the 5:th column
  %(column6) | The value in the 6:th column
  %(column7) | The value in the 7:th column
  %(column8) | The value in the 8:th column
  %(column9) | The value in the 9:th column
  %(file) | The name of the file
  %(filename) | The name of the file
  %(line) | Match the content of an entire line
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`perf-syntax` (CheckLogFile, check_logfile)
  Performance alias syntax.
  This is the syntax for the base names of the performance data.
  Possible values are:

  Key | Value
  %(column1) | The value in the first column
  %(column2) | The value in the second column
  %(column3) | The value in the third column
  %(column4) | The value in the 4:th column
  %(column5) | The value in the 5:th column
  %(column6) | The value in the 6:th column
  %(column7) | The value in the 7:th column
  %(column8) | The value in the 8:th column
  %(column9) | The value in the 9:th column
  %(file) | The name of the file
  %(filename) | The name of the file
  %(line) | Match the content of an entire line
  ${count} | Number of items matching the filter
  ${total} | Total number of items
  ${ok_count} | Number of items matched the ok criteria
  ${warn_count} | Number of items matched the warning criteria
  ${crit_count} | Number of items matched the critical criteria
  ${problem_count} | Number of items matched either warning or critical criteria
  ${list} | A list of all items which matched the filter
  ${ok_list} | A list of all items which matched the ok criteria
  ${warn_list} | A list of all items which matched the warning criteria
  ${crit_list} | A list of all items which matched the critical criteria
  ${problem_list} | A list of all items which matched either the critical or the warning criteria
  ${detail_list} | A special list with critical, then warning and fainally ok
  ${status} | The returned status (OK/WARN/CRIT/UNKNOWN)

`line-split` (CheckLogFile, check_logfile)
  Character string used to split a file into several lines (default n)

`column-split` (CheckLogFile, check_logfile)
  Character string to split a line into several columns (default t)

`split` (CheckLogFile, check_logfile)
  Alias for split-column

`file` (CheckLogFile, check_logfile)
  File to read (can be specified multiple times to check multiple files.
  Notice that specifying multiple files will create an aggregate set it will not check each file individually.
  In other words if one file contains an error the entire check will result in error or if you check the count it is the global count which is used.

`files` (CheckLogFile, check_logfile)
  A comma separated list of files to scan (same as file except a list)

### / settings/ logfile

`/settings/logfile` (CheckLogFile)

LOG FILE SECTION

> Section for log file checker

> Sample:

>     # LOG FILE SECTION
>     # Section for log file checker
>     [/settings/logfile]

### … / real-time

`/settings/logfile/real-time` (CheckLogFile)

CONFIGURE REALTIME CHECKING

> A set of options to configure the real time checks

> Key | Default Value | Description
> --- | --- | ---
> `enabled` | 0 | REAL TIME CHECKING

> Sample:

>     # CONFIGURE REALTIME CHECKING
>     # A set of options to configure the real time checks
>     [/settings/logfile/real-time]
>     enabled=0

> `enabled` (CheckLogFile, /settings/logfile/real-time)

>   REAL TIME CHECKING

>   Spawns a background thread which waits for file changes.

>   Path: /settings/logfile/real-time

>   Key: enabled

>   Default value: 0

>   Used by: `CheckLogFile`

>   Sample:

>       [/settings/logfile/real-time]
>       # REAL TIME CHECKING
>       enabled=0

### … / real-time / checks

`/settings/logfile/real-time/checks` (CheckLogFile)

REALTIME FILTERS

> A set of filters to use in real-time mode

> Sample:

>     # REALTIME FILTERS
>     # A set of filters to use in real-time mode
>     [/settings/logfile/real-time/checks]

comments powered by Disqus