Interface ProcessCheckResultParams

See

doc/12-icinga2-api.md L1064-L1117

interface ProcessCheckResultParams {
    check_command?: string | string[];
    check_source?: number;
    execution_end?: number;
    execution_start?: number;
    exit_status: HostState | ServiceState;
    filter: string;
    performance_data?: string | string[];
    plugin_output: string;
    ttl?: number;
    type: "Host" | "Service";
}

Properties

check_command? check_source? execution_end? execution_start? exit_status filter performance_data? plugin_output ttl? type

Properties

Optional check_command

check_command?: string | string[]

The first entry should be the check commands path, then one entry for each command line option followed by an entry for each of its argument. Alternativly a single string can be used.

Optional check_source

check_source?: number

Usually the name of the command_endpoint

Optional execution_end

execution_end?: number

The timestamp where a script/process ended its execution. This timestamp is used in features to determine e.g. the metric timestamp.

Optional execution_start

execution_start?: number

The timestamp where a script/process started its execution.

exit_status

exit_status: HostState | ServiceState

For services: 0=OK, 1=WARNING, 2=CRITICAL, 3=UNKNOWN, for hosts: 0=UP, 1=DOWN.

filter

filter: string

host.name=="icinga2-master1.localdomain" && service.name=="passive-ping"

Optional performance_data

performance_data?: string | string[]

The performance data as array of strings. The raw performance data string can be used too.

plugin_output

plugin_output: string

One or more lines of the plugin main output. Does not contain the performance data.

Optional ttl

ttl?: number

Time-to-live duration in seconds for this check result. The next expected check result is now + ttl where freshness checks are executed.

type

type: "Host" | "Service"

Settings

Member Visibility

Theme

On This Page