Page History

define broker { 
	...
    modules                   Module 1, Module 2, Module 3, Livestatus
    ...
}

service shinken-arbiter restart

#===============================================================================
# Livestatus
#===============================================================================
# Daemons that can load this module:
# - broker
# This module open a TCP API that can be query by external tools like Nagios
# UIs (Thruk or NagVis)
#===============================================================================


define module {

# Shinken Enterprise. Lines added by import core. Do not remove it, it's used by Shinken Enterprise to update your objects if you re-import them.
    _SE_UUID             core-module-6e1beab85adc11e5a4ea080027f08538
    _SE_UUID_HASH        bc47ca0c63c8b7cf1a3f3ca1d3c3b79f
# End of Shinken Enterprise part

    #======== Module identity =========
    # Module name. Must be unique
    module_name               Livestatus

    # Module type (to load module code). Do not edit.
    module_type               livestatus

    #======== Listening address =========
    # host: IP address to listen to.
    #       note: * = all interfaces.
    host                      *

    # port to listen
    port                      50000

    # socket: file path of a unix socket. If set, will listen this socket for query
    #socket                   /var/lib/shinken/live

    #======== Security =========
    # The livestatus protocol allows to set AuthUser: in the query to filter results
    # for a specific user (if the user is a notification contact of hosts/checks)
    # The remote_user_case_sensitive parameter allows to set if the user name should
    # be checked in a case sensitive mode or in case insensitive mode.
    # 0 : Do not look at case when filtering by user name
    # 1 : [default] Look at the case when filtering by user name
    remote_user_case_sensitive        1

    #====== Debug logging =======
    # Enable only for debugging this module
    #debug                    /var/log/shinken/livestatus.debug

    # If set to 1, log queryes. Note: it's very verbose
    #debug_queries            0

}

define module {
    ...
    host                              *
    port                              50000
    remote_user_case_sensitive        1
    #debug                            /var/log/shinken/livestatus.debug
    #debug_queries                    0
    ...
}

yum install nc

echo 'GET hosts' | nc 127.0.0.1 50000

LQL - pronounced "Liquel" as in "liquid" - is a simple language for telling Livestatus what data you want and how it should be formatted. It does much the same as SQL but does it in another, simpler way. Its syntax reflects (but is not compatible to) HTTP.

Each query consists of:

• A command consisting of the word GET and the name of a table.
• An arbitrary number of header lines consisting of a keyword, a colon and arguments.
• An empty line or the end of transmission (i.e. the client closes the sending direction of the socket)

All keywords including GET are case sensitive. Lines are terminated by single linefeeds (no <CR>). The current version of Livestatus implements the following tables:

• hosts - your Nagios hosts
• services - your Nagios services, joined with all data from hosts
• hostgroups - your Nagios hostgroups
• servicegroups - your Nagios servicegroups
• contactgroups - your Nagios contact groups
• servicesbygroup - all services grouped by service groups
• servicesbyhostgroup - all services grouped by host groups
• hostsbygroup - all hosts group by host groups
• contacts - your Nagios contacts
• commands - your defined Nagios commands
• timeperiods - time period definitions (currently only name and alias)
• downtimes - all scheduled host and service downtimes, joined with data from hosts and services.
• comments - all host and service comments
• log - a transparent access to the nagios logfiles (include archived ones)ones
• status - general performance and status information. This table contains exactly one dataset.
• columns - a complete list of all tables and columns available via Livestatus, including descriptions!
• statehist - 1.2.1i2 sla statistics for hosts and services, joined with data from hosts, services and log.

Like in an SQL database all tables consist of a number of columns. If you query the table without any parameters, you retrieve all available columns in alphabetical order. The first line of the answer contains the names of the columns. Please note that the available columns will change from version to version. Thus you should not depend on a certain order of the columns!

nc 127.0.0.1 50000 < hosts.lql

nc 127.0.0.1 50000 < hosts.lql >> hosts.csv

printf 'GET hosts' | nc 127.0.0.1 50000 >> hosts.csv

GET services
Columns: host_name description state
Filter: state = 2
Filter: in_notification_period = 1

test [copy];check-dummy-critical;2
test [copy];check-loop-custom;2
test [copy];check-loop-simple;2
test;check-dummy-critical;2
test;check-random-py;2

GET services
Columns: host_name description contacts
AuthUser: toto