docs icinga org latest en db model html

7/27/2019 Docs Icinga Org Latest en Db Model HTML

1/39

pdfcrowd comopen in browser PRO version Are you a developer? Try out the HTML to PDF API

12.5. IDOUtils Database Model

Prev Chapter 12. IDOUtils Next

12.5. IDOUtils Database Model12.5.1. Central Tables

12.5.2. Debugging Tables

12.5.3. Historical Tables

12.5.4. Current Status Tables

12.5.5. Configuration Tables

This documentation is based o n the NDOUtils database model do cumentation by Ethan Galstad and a ltered to fit the changes neces sary in IDOUtils.

Introduction

This documentation is still in flux, and there are undoub tably errors present, so take e verything you find here w ith a grain of salt. If you have s uggestions , changes, etc. for the documentation, please let us kno w.

Important

Although we too k care to be accurate there may be alterations in the current code which aren't reflected here so if in doubt please take a look at the actual code.

Note

The data types and field lenghts mentioned throughout the following documentation show the definitions for MySQL. Oracle and PostgreSQL use other data types and field lengths.

Table Names

The IDOUtils addon a llows use rs to specify a custom prefix to each table n ame in the databa se. By default, this prefix is set to "icinga_" in ido2db.cfg. The tables documented he re are listed without a ny prefix.

Note

Due to limitations in Oracle the length of table na mes cannot exceed 30 characters so

The name of one table has been shortened: serviceescalation_contactgroups -> serviceescalationcontactgroups

The table prefix is ignored

Keys

Every table has a primary key (designate d as "P K"). Most tables ha ve a unique key consisting of on e ("UK") or more columns ("UKn" wherea s n sho ws the position in the key). Some tables ha ve a non-unique key ("NK")

which may be composed of several columns as well ("NKn").

There are a lot of tables containing different information so the des cription is divided into five parts:

Central Tables
http://pdfcrowd.com/http://pdfcrowd.com/redirect/?url=http%3a%2f%2fdocs.icinga.org%2flatest%2fen%2fdb_model.html&id=ma-130812091545-57918dfbhttp://pdfcrowd.com/customize/http://pdfcrowd.com/html-to-pdf-api/?ref=pdfhttp://docs.icinga.org/latest/en/db_example-configs.htmlhttp://docs.icinga.org/latest/en/db_changes.html


2/39


Debugging Tables

Historical Tables

Current Status Tables

Configuration Tables

12.5.1. Central TablesThere are two " core" or "central" tables, described below , that are referenced by nearly every table in the databa se. Read below for more information.

Table List

instances

objects

Relationship Diagram

Figure 12.14 . Relationship of Central Tables

Instance Table

Description: This table is needed to ensure tha t multiple instances of Icinga can store the ir configuration and sta tus information in the same database . Each instance represen ts a different Icinga installation/process. A

new instance will automatically be created when the user specifies a new instance name (when running one of the IDOUtils components) that does not already exist in the database.

Structure:

Field Type Notes Key

instance_id SERIAL Unique number identifying a distinct instance of Icinga PK

instance_name VARCHAR(64) Instance name, as passed to and used by IDOUtils components

instance_description VARCHAR(128) Optional text describing the instance in more detail

Objects Table

Description: This table is used to s tore all current (and pas t) objects that are (and have be en) defined in your Icinga configuration files. Why are the names of the objects stored in this table a nd not else where? W ell,

when you delete an object definition from your Icinga configuration, that object will no longer appea r in the object tables of the da tabase . Since you're still going to want to be able to run reports for old hos ts, service,

etc., we store the na me of the object here so you're not completely baffled by the reports you get. :-)

Structure:

Field Type Notes Values Key

object_id SERIAL A unique number identifying the object PK

instance_idBIGINT

unsignedA number indicating the instance o f Icinga to w hich the object belongs

objecttype_idBIGINT

unsignedA number indicating wh at type of o bject this is

1 = Host; 2 = Service; 3 = Host group; 4 = Service group; 5 = Host escalation; 6 = Service escalation;

7 = Host de pendency; 8 = Service depende ncy; 9 = Timeperiod; 10 = Contact; 11 = Contact group;

12 = Command; 13 = Extended ho st info (deprecated); 14 = Extended service info (deprecated)

NK1
http://pdfcrowd.com/http://pdfcrowd.com/redirect/?url=http%3a%2f%2fdocs.icinga.org%2flatest%2fen%2fdb_model.html&id=ma-130812091545-57918dfbhttp://pdfcrowd.com/customize/http://pdfcrowd.com/html-to-pdf-api/?ref=pdf


3/39


name1 VARCHAR(128)The first name ass ociated with the ob ject definition, as use d in your Icinga

configuration filesNK2

name2 VARCHAR(128)

The second na me (if any) associated w ith the object definition, as us ed in

your Icinga configuration files. This field is only used for service definitions

which have a host na me (name1 field) and se rvice des cription (name2 field)

NK3

is _a ctive SMALLINT

A number indicating wh ether or no t the object is currently defined in your

Icinga configuration files. If an object definition is removed from your Icinga

configuration files, it w ill remain in this ta ble, but w ill be marked as ina ctive

0 = Inactive; 1 = Active

Relationships:

Field Foreign Key

instance_id instances.instance_id

12.5.2. Debugging TablesThere is currently only one table in the da tabase that is used to hold information that might be use ful for debugging purposes. Read be low for more information.

Table List

conninfo


Figure 12.15. Relationship of Debugging Tables

Conninfo Table

Description: This table is use d to s tore debugg ing information regarding the IDO2DB daemon and the use r agents (e.g. LOG2DB, IDOMOD NEB module, etc.) that connect to it. This information is proba bly only interesting

if you are attempting to debug connection problems.

Structure:


conninfo_id SERIAL Unique number identifying the connection info record PK

instance_idBIGINT

unsignedUnique number identifying the distinct instance of Icinga for which data is being transmitted/processed


4/39


a ge nt_n ame VARCHAR(32) Te xt s tring id en tifyin g th e us er a ge nt tha t is se nd ing da ta to th e IDO 2DB d ae mo n Typica lly "IDO MO D" o r " LO G2IDO "

agent_version VARCHAR(8) Text string identifying the version of the user agent that is sending data

disposition VARCHAR(16) Text string identifying the disposition or type of data that is being sent to the IDO2DB daemon"REALTIME" if being sen t directly from a running Icinga p rocess

or "ARCHIVED" if being sent from a flat file

connect_source VARCHAR(16) Text string identifying the method that the user agent is using to connect to the IDO2DB daemon "TCPSOCKET" or "UNIXSOCKET"

connect_ type VARCHAR(16 )Text string identifying whether this connect wa s a ne w conne ction, or if it was a reconnect due to a n earlier

communications failure between the user age nt and the IDO2DB daemon"INITIAL" or "RECONNECT"

connect_time TIMESTAMP The init ial time the user agent connected to the daemon

disconnect_time TIMESTAMP The time (if any) the user agent disconnect from the daemon

last_checkin_time TIMESTAMPThe time that the u ser agent las t checked in with the daemon to indicate that it w as still alive and sending

data

data_start_time TIMESTAMP The timestamp of the first data that the user agent sent to the daemon

data_end_time TIMESTAMP The timestamp of the last (or latest) data that the user agent sent to the daemon

bytes_processedBIGINT

unsignedThe number of bytes of data that have been sent by the user agent and processed by the daemon

lines_processedBIGINT

unsignedThe number of lines of data that have been sent by the user agent and processed by the daemon

entries_processedBIGINT

unsignedThe number of data entries that have been sent by the user agent and processed by the daemon

Relationships:

Field Foreign Key


12.5.3. Historical TablesHistorical Data Tables

There are several tables in the databa se w hich are used to ho ld "historical" information about Icinga and the hos ts/services it is monitoring or was monitoring at some point in the pa st. Keep in mind that historical items

may not necessarily be "old" - they could have occurred 5 seconds ago, so the information used w ithin these tables could/shou ld be used w hen reporting current status information. Links to hos ts/services w hich no

longer exist in the Icinga configuration are maintained due to references for these previous objects existing in the objects table - this is by design.

Table List

acknowledgements

commenthistory

contactnotifications

dbversion

downtimehistory

eventhandlers

externalcommands

flappinghistory

hostchecks

logentries

notifications

processevents

servicechecks


5/39


statehistory

systemcommands

timedevents

slahistory


Notes: For clarity, the instances table (to which all these ta bles are related) is not s hown. There are 17 histo rical tables, so plea se excuse the mess. :-)

Figure 12.16 . Relationship of Historical Tables


6/39


Acknowledgements Table

Table Description: This table is used to s tore host a nd service acknowledgements for historical purposes .

Structure:


acknowledgement_id SERIAL Unique number identifying the acknowledgement record PK

instance_idBIGINT

unsigned

Unique number identifying the distinct instance of Icinga which this entry is

associated with

e ntry_time TIME STAMP Da te an d time the ackno wle dge me nt w as e nte re d

e ntry_time _u se c INT Micro se co nd po rtio n o f a ckno wle dge me nt e ntry time

acknowledgement_type SMALLINT Ind icates whether this is a host or service acknowledgement 0 = Host ack; 1 = Service ack

object_idBIGINT

unsignedThe object id of the host o r service this acknow ledgement applies to

state SMALLINTInteger indicating the state the host or service was in when the

acknowledgement was made

Host acks: 0 = UP; 1 = DOWN; 2 = UNREACHABLE; Service acks: 0 = OK; 1 = WARNING; 2 =

CRTICAL; 3 = UNKNOWN

author_name VARCHAR(64)Text field containing the name of the pe rson wh o made the

acknowledgement

comment_data VARCHAR(255) Text f ield containing notes on the acknowledgement

is_s ticky SMALLINT Indica te s whe ther o r not the acknow ledgement is cons idered " sticky" 0 = Not s ticky; 1 = Sticky

persistent_comment SMALLINTIndicates whether or not the comment associated with the

acknowledgement is persistent0 = Not persistent; 1 = Persistent

notify_contacts SMALLINTIndicates whether or not contacts are to be notified of the

acknowledgement0 = Don't notify; 1 = Notify

e nd_time TIMESTAMP Date and time the ackno wledge ment w as de leted

Relationships:

Field Foreign Key


object_id objects.object_id

Commenthistory Table


7/39


Table Description: This table is use d to sto re historical host and service comments. Current comments will also ap pear in this table, but it is recommended to use the comments table to retrieve a list of current host and

service comments.

Structure:


commenthistory_id SERIAL Unique number identifying the comment record PK

instance_id BIGINT unsigned Unique number identifying the distinct instance of Icinga which this entry is associated with UK1

e ntry_time TIMESTAMP Date and time the co mme nt w as entered

e ntry_time _use c INT Micros eco nd portio n of co mme nt entry time

comment_type SMALLINT Indicates whether this is a host or service comment 1 = Host comment; 2 = Service comment

entry_type SMALLINT Indicates how this comment came to be entered 1 = User; 2 = Scheduled downtime; 3 = Flapping; 4 = Acknowledgement

object_id BIGINT unsigned The object id of the host or service this acknowledgement applies to

comment_time TIMESTAMP Date and time associated with the comment UK2

Internal_comment_id BIGINT unsigned The comment ID internal to the Icinga daemon, which may no longer be valid or present UK3

author_name VARCHAR(64) Text field containing the name of the person who made the comment

comment_data VARCHAR(255) Text f ield containing the comment

is_persistent SMALLINT Indicates whether or not the comment is persistent 0 = Not persistent; 1 = Persistent

comment_source SMALLINT Indicates the source of the comment 0 = Internal (Icinga); 1 = External (user)

expires SMALLINT Indicates whether or not the comment expires 0 = Doesn't expire; 1 = Expires

exp iration_time TIMESTAMP Date and time at which the comment exp ires

deletion_time TIMESTAMP Date and t ime (if any) when the comment was deleted

dele tion_ time_usec INT Microsecond time (if any) when the comment was de le ted

Relationships:

Field Foreign Key



Contactnotifications Table

Description: This table is used to s tore a historical record of host and se rvice notifications that have bee n sent ou t to individual contacts.

Structure:


contactnotification_id SERIAL Unique number identifying the record PK


notification_id BIGINT unsigned The id of the notification this record is associated with

contact_object_id BIGINT unsigned The object id of the contact this notification was send to UK2

start_time TIMESTAMP The date/time the notification to this contact was started UK3

start_time_usec INT The microsecond portion of the time the notification started UK4

e nd _time TIMESTAMP Th e da te /time the no tifica tio n to th is co nta ct end ed

e nd _time _us ec INT Th e micro se co nd p ortio n o f th e time the no tifica tio n e nd ed

Dbversion Table

Description: This table is use d to s tore version information about the DB.

Structure:


8/39



dbversion_id SERIAL Unique number identifying the record PK

name VARCHAR(10) Name of the database UK

version VARCHAR(10) Version number of the database

Relationships:

Field Foreign Key

instance_id instances.inst ance_id

notification_id notifications.notification_id

contact_object_id objects.object_id

Contactnotificationmethods Table

Description: This table is used to s tore a historical record of commands (methods) that were us ed to contact individuals about hos t and se rvice problems and recoveries.

Structure:


contactnotificationmethod_id INT Unique number identifying the record PK

instance_id BIGINT unsigned Unique number identifying the dist inct instance of Icinga which this entry is associated with UK1

contactnotification_id INT The id of the contact notification this record is associated with UK2

start_time TIMESTAMP The date/time the notification command started UK3

start_time_usec INT The microsecond portion of the time the notification command started UK4

end_time TIMESTAMP The date/time the notification command ended

end_time_usec INT The microsecond portion of the time the notification command endedco mma nd_o bje ct_id INT The id o f th e co mma nd tha t w as u se d fo r the no tifica tio n co mma nd

co mma nd_a rgs VARC HAR The a rgu me nts th at w ere p as se d to th e no tifica tio n co mma nd

Relationships:

Field Foreign Key

insta nce _id ins ta nce s.ins ta nce_id

contactnotification_id contactnotifications.contactnotification_id

command_object_id objects.object_id

Downtimehistory Table

Description: This table is used to s tore a historical record of scheduled host a nd service downtime

Structure:


downtimehistory_id SERIAL Unique number identifying the record PK

instance_idBIGINT

unsignedUnique number identifying the distinct instance of Icinga which this entry is associated with UK1

downtime_type SMALLINT A number identifying what type of scheduled downt ime th is is1 = Service downtime; 2 =

Host downtime

object_idBIGINT

unsignedThe object id of the host or service this scheduled downtime is associated with UK2

entry_time TIMESTAMP The date/time the scheduled downtime was entered/submitted UK3

author_name VARCHAR(64) The name of the person who scheduled this downtime


9/39

df d mi b PRO i Are you a developer? Try out the HTML to PDF API

comment_data VARCHAR(255) A comment, as entered by the author, associated with the scheduled downtime

internal_downtime_idBIGINT

unsignedA number (internal to the Icinga daemon) associated with the scheduled downtime UK4

triggered_by_idBIGINT

unsigned

The id of another schedu led down time entry that scheduled d owntime is optionally triggered by. Non-triggered downtimes will have a value

of 0 in this field

is_fixed SMALLINTA number indicating whe ther or not this scheduled do wntime is fixed (i.e. its start and e nd times are exactly what they are listed below as)

or if it is flexible

0 = Flexible (Not fixed); 1 =

Fixed

duration SMALLINTThe number of seconds tha t the scheduled do wntime should last. This is only used by Icinga is the dow ntime is flexible. If the dow ntime is

fixed, this value sho uld reflect the difference betwe en the s tart and end times

scheduled_start_time TIMESTAMPThe date/time the scheduled downtime is sup posed to start. If this is a flexible (non-fixed) dow ntime, this refers to the earliest poss ible time

that the downtime can start

scheduled_end_time TIMESTAMPThe date/time the sche duled dow ntime is supposed to end. If this is a flexible (non-fixed) downtime, this refers to the last poss ible time that

the downtime can start

was_started SMALLINTNumber indicated whe ther or not the sched uled dow ntime wa s started. Some flexible dow ntimes may never actually start if the hos t/service

they are associated with never enter a problem state

0 = Was not sta rted; 1 =

Was started

actual_start_time TIMESTAMP The date/time the scheduled downtime was actually started (if applicable)

actua l_star t_ time_usec INT Microsecond port ion of the actual start time

actual_end_t ime TIMESTAMP The date/t ime the scheduled downtime actually ended

actual_end_t ime_usec INT Microsecond portion of the actual end t ime

was_cancelled SMALLINT Number indicat ing whether or not the scheduled downtime was cancelled before it ended normally0 = Not cancelled; 1 =

Cancelled early

Relationships:

Field Foreign Key


o bje ct_id o bje cts .o bje ct_id

triggered_by_id [downtimehistory.]down timehistory_id

Eventhandlers Table

Description: This table is used to s tore a historical record of host and se rvice event ha ndlers that have be en run. NOTE: This table is usua lly trimmed periodically by the IDO2DB daemon, as it wo uld otherwise grow to an

enormous size.

Structure:


eventhandler_id SERIAL Unique number identifying the record PK

instance_idBIGINT

unsigned

Unique number identifying the distinct instance of Icinga which

this entry is associated withUK1

eventhandler_type SMALLINT A number indicating what type of event handler this is0 = Host event ha ndler; 1 = Service event hand ler; 2 = Global host e vent handler; 3 = Global service

event handler

object_idBIGINT

unsigned

The object id of the host or service associated with this event

handlerUK2

state SMALLINTNumber indicating the state o f host or service when the event

handler was run.

For host event ha ndlers: 0 = UP; 1 = DOWN; 2 = UNREACHABLE; For service event ha ndlers:; 0 = OK; 1

= WARNING; 2 = CRITICAL; 3 = UNKNOWN

state_type SMALLINTNumber indicating the state type o f the host or se rvice whe n the

event handler was run0 = SOFT state; 1 = HARD state

start_time TIMESTAMP The date/time the event handler started UK3

s ta rt_time _us ec INT Th e micro se co nd p ortio n o f th e time th e e ve nt h an dle r s ta rte d UK4

e nd_time TIMESTAMP The da te /time the eve nt ha ndle r e nde d

e nd _time _us ec INT Th e micro se co nd po rtio n o f th e time th e e ve nt ha ndle r e nde d


10/39

df di b PRO i Are you a developer? Try out the HTML to PDF API

command_object_idBIGINT

unsignedThe id of the command that w as run

command_args VARCHAR(255) Arguments to the event handler command that was run

command_line VARCHAR(1024) Fully expanded command line of the event handler that was run

time out SMALLINT Time out va lue in s econds fo r the e ve nt handle r

e arly_time ou t SMALLINTNumber indicating whether or no t the event han dler command

timed ou t0 = Did NOT time out. 1 = Timed out

execution_time DOUBLE Time in seconds that the event hand ler command was running

re tu rn_code SMALL INT The re tu rn code va lue from the event hand le r command

output VARCHAR(255)The first line of te xt output (if any) from the event ha ndler

command

Relationships:

Field Foreign Key

in sta nce _id in sta nce s.in sta nce _id



Externalcommands Table

Description: This table is used to s tore a historical record of external commands that have be en process ed by the Icinga daemon.

Structure:


externalcommand_id SERIAL Unique number identifying the record PK

instance_id BIGINT unsigned Unique number identifying the distinct instance of Icinga which this entry is associated with

entry_ time TIMESTAMP The date /time the exte rnal command was p rocessed

command_type SMALLINT A number indicating what type of external command this is. Each external command has its own type or "id" See Icinga source code

command_name VARCHAR(128) The name of the command that was processed

command_args VARCHAR(255) Optional arguments that were specified with the command.

Relationships:

Field Foreign Key


Flappinghistory Table

Table Description: This table is used to s tore a historical record of host and s ervice flapping events.

Structure:


flappinghistory_id SERIAL Unique number identifying the record PK

instance_idBIGINT

unsignedUnique number identifying the distinct instance of Icinga which this entry is as sociated w ith

e ve nt_time TIMESTAMP Th e da te /time o f the fla ppin g e ve nt

event_ time_usec INT The microsecond portion o f the t ime of the flapp ing event

event_ type SMALL INT The type o f flapp ing event indica ted by th is re co rd1000 = Flapping started; 1001 = Flapping

stopped


11/39

df di b PRO i A d l ? T t th HTML t PDF API

reason SMALLINTNumber indicating the rea son (if any) that the ho st or se rvice stopp ed flapping. This is only valid if this records is a flapping

stopped event (see event_type field)

1 = Flapping stop ped no rmally 2 = Flapping

was disabled

flapping_type SMALLINT Number indicating whether this flapping event relates to a host or service 0 = Host 1 = Service

object_idBIGINT

unsignedThe id of the host or service associated with the flapping event

percent_state_change DOUBLE The percent state change of the host or service at the time of the event

low_threshold DOUBLE The low flapping percent state change threshold (as configured in Icinga) of the host or service

high_threshold DOUBLE The high flapping percent state change threshold (as configured in Icinga) of the host or service

comment_time TIMESTAMP The date/t ime of the comment associated with the flapping event

internal_comment_idBIGINT

unsignedThe number (internal to the Icinga daemon) of the comment associated w ith the flapping event.

Relationships:

Field Foreign Key



Hostchecks Table

Description: This table is used to store a historical record of "raw" and "processed" host checks. What's the difference between raw and processed host checks? Raw checks are the raw results from a host check

command that ge ts executed. Icinga must do some processing o n the raw host check results before it can dete rmine the real sta te of the hos t. Host checks (plugins) cannot directly determine whether a h ost is DOWN

or UNREACHABLE - only Icinga can do that. In fact, host che cks return the same s tatus code s as service checks (OK, WARNING, UNKNOWN, or CRITICAL). Icinga processes the raw host check result to determine the true

state o f the hos t (UP, DOWN, or UNREACHABLE). These "proces sed" che cks contain the the true state of the ho st. NOTE: This table is us ually trimmed periodically by the IDO2DB daemon, as it would o therwise g row to

an enormous size.

Structure:


hostcheck_id SERIAL Unique number identifying the record PK

instance_idBIGINT


host_object_idBIGINT

unsignedThe id of the host this check applies to UK2

check_ type SMALL INT Number indica ting whe ther t his is an act ive o r passive check0 = Active check 1 = Passive

check

is_raw_check SMALLINT Number indicat ing whether this is a " raw" or "processed" host check0 = Processed check; 1 = Raw

check

current_check_attempt SMALLINT Current check attempt of the host

max_check_attempts SMALLINT Max check attempts (as defined in Icinga) for the host

state SMALLINT Current state of the host

For raw checks: 0 = UP 1 =DOWN/UNREACHABLE; For

processed che cks: 0 = UP 1 =

DOWN 2 = UNREACHABLE

state_type SMALLINT Number indicating whether the host is in a soft or hard state 0 = SOFT state 1 = HARD state

start_time TIMESTAMP The date/time the host check was started UK3

start_time_usec INT Microsecond portion of the time the host check was started UK4

e nd_time TIMESTAMP The date/time the hos t che ck w as completed

e nd_time _us ec INT Micro se co nd po rtion of the time the ho st che ck wa s co mple te d


unsignedThe id of the command that was us ed to perform the host check

command_args VARCHAR(255) The arguments that were passed to the host check command


12/39df di b PRO i A d l ? T t th HTML t PDF API

command_line VARCHAR(1024) The fully expanded command line that was used to check the host

time out SMALLINT Number o f s econds be fo re the ho st check co mma nd would time out

early_ timeout SMALLINT Number indicat ing whether or not the host check t imed out early0 = Did NOT timeout 1 = Timed

out

e xe cutio n_time DO UBLE Nu mb er of se co nds it to ok to e xe cu te th e ho st ch eck

latency DOUBLE

Number of seconds the ho st check was "late " in being executed. Scheduled hos t checks can have a latency, but on-demand checks will

have a laten cy of 0. Latency is the difference betwe en the time the check was s cheduled to be executed and the time it was actually

executed. For pass ive checks it is the different betwe en the timestamp on the pa ssive host che ck result (submitted through the

external command file) and the time the passive check result was processed by Icinga

re tu rn _co de SMALLINT The re tu rn co de fro m th e h os t ch eck co mma nd

output VARCHAR(255) Sta tus t ext output from the hos t check command (firs t line)

lo ng _o utpu t TEXT Sta tu s te xt o utpu t fro m th e ho st ch eck co mma nd (co ns ecu tive line s)

perfdata TEXT Optional performance data returned from the host check command.

Relationships:

Field Foreign Key


host_object_id objects.object_ id


Logentries Table

Description: This table is use d to s tore a histo rical record of entries from the Icinga log.

Structure:


logentry_id SERIAL Unique number identifying the record PK

instance_idBIGINT


logentry_time TIMESTAMPThe date/time ass ociated with the log e ntry. This is NOT necessarily the same as the d ate/time that Icinga wrote the log entry to the log file

(see below)

entry_ time TIMESTAMP The date /time that Icinga wro te th is log ent ry to the log file

entry_ time_usec INT The microsecond portion o f the t ime t ha t Icinga wro te t his log entry

lo ge ntry_type INT A numbe r indica ting w hat ge nera l type of lo g e ntry this isSee Icinga source

code

logent ry_data VARCHAR(255) The log entry that was writ ten out to the log file

re altime _d ata SMALLINT A nu mb er us ed inte rna lly by th e IDO2DB da emo n

inferred_data_extracted SMALLINT A number used internally by the IDO2DB daemon.

Relationships:

Field Foreign Key


Notifications Table

Description: This table is used to s tore a historical record of host and se rvice notifications that have bee n sent ou t. For each notification, one or more contacts receive notification messa ges. These conta ct notifications

are stored in the con tactnotifications table.

Structure:

i ld l


13/39df di b PRO i

Are you a developer? Try out the HTML to PDF API


notification_id SERIAL Unique number identifying the record PK

instance_idBIGINT

unsigned

Unique number identifying the distinct instance of

Icinga which this entry is associated w ithUK1

notification_type SMALLINTNumber indicating whe ther this is a host or s ervice

notification0 = Host notification 1 = Service notification

notification_reaso n SMALLINTNumber indicating the type o f or reason for the

notification

0 = Normal notification; 1 = Problem acknowledge ment; 2 = Flapping started; 3 = Flapping s topped; 4 = Flapping

was disabled; 5 = Downtime started; 6 = Downtime ended; 7 = Downtime was cancelled; 99 = Custom notification

object_idBIGINT

unsignedThe id of the host or service this notification applies to UK2

start_time TIMESTAMP The date/time the notification was started UK3

start_t ime_usec INT

Microsecond portion of the time the notification wa s

started UK4

e nd _time TIME STAMP The da te /time the no tifica tio n e nd ed

end_time_usec INT Microsecond portion o f the time the notifica tion ended

state SMALLINTNumber indicating the state o f the host or se rvice

when the notification was sent out.

For Host Notifications: 0 = UP; 1 = DOWN; 2 = CRITICAL; For Service Notifications: 0 = OK; 1 = WARNING; 2 =

CRITICAL; 3 = UNKNOWN

output VARCHAR(255)The current plugin (text) output of the host o r service

when the notification was se nt out (first line)

long_output TEXTThe current plugin (text) output of the host o r service

when the notification was sent out (consecutive lines)

escalated SMALLINTNumber indicating whether o r not this notification wa s

escalated or not0 = NOT escalated; 1 = Escalated

contacts_notified SMALLINTNumber of contacts that were notified about the host

or service as pa rt of this notification.

Relationships:

Field Foreign Key



Processevents Table

Description: This table is use d to s tore a histo rical record of Icinga process events (program starts, restarts, shutdo wns, etc.).

Structure:


processevent_id SERIAL Unique number identifying the record PK

instance_idBIGINT

unsigned


this entry is associated with

event_type SMALLINT Number indicat ing the type of process event that occurred.100 = Process start; 101 = Process da emonized; 102 = Process restart; 103 = Process s hutdow n; 104 =

Prelaunch; 105 = Event loop start; 106 = Event loop en d

event_time TIMESTAMP The date/t ime that the event occurred

event_time_usec INT The microsecond port ion of the time the event occurred

pro ce ss _id INT Th e cu rre nt pro ce ss ID (P ID) o f the Icin ga da emo n

program_name VARCHAR(16) "Icinga"

program_version VARCHAR(20) Version of Icinga that is running (e.g. "1.0")

program_date VARCHAR(10) Release date of Icinga

Relationships:


14/39df di b PRO iAre you a developer? Try out the HTML to PDF API

Field Foreign Key


Servicechecks Table

Description: This table is use d to s tore a histo rical record of se rvice checks that h ave bee n performed. NOTE: This table is us ually trimmed pe riodically by the IDO2DB daemon, as it wo uld otherwise grow to an eno rmous

size.

Structure:


servicecheck_id SERIAL Unique number identifying the record PK

instance_idBIGINT

unsigned Unique number identifying the distinct instance of Icinga which this entry is associated with UK1

service_object_idBIGINT

unsignedThe id of the service this record refers to UK2

check_ type SMALL INT Number indica ting whe ther t his was an act ive o r a pass ive se rvice check0 = Active check;

1 = Passive check

current_check_attempt SMALLINT Number indicating the current check attempt for the service

max_check_attempts SMALLINT Number indicating the max number of check attempts for the service

state SMALLINT Number indicating the current state of the service

0 = OK 1 =

WARNING; 2 =

CRITICAL; 3 =

UNKNOWN

s ta te _type SMALLINT Nu mb er in dica ting the cu rre nt s ta te type of the se rvice0 = SOFT state; 1

= HARD state

start_time TIMESTAMP The date/time the service check was started UK3

start_time_usec INT Microsecond portion of the time the service check was started UK4

end_time TIMESTAMP The date/time the service check ended

e nd_time _us ec INT Micro se co nd po rtion of the time the se rvice che ck ende d


unsignedThe id of the command that was run to p erform the se rvice check

command_args VARCHAR(255) The arguments passed to the command that was run to perform the service check

command_line VARCHAR(1024) The fully expanded command line that was executed to perform the service check

time ou t SMALLINT Nu mb er of s eco nds be fo re th e s ervice ch eck co mma nd wa s s ch ed ule d to time ou t

early_ timeout SMALLINT Number indicat ing whether or not the serv ice check t imed out

0 = Did NOT

timeout 1 = Timed

out

execu tion_ time DOUBLE Number of se conds it took to execu te the se rvice check command

latency DOUBLE

Number of seconds the s ervice check was "late" in being executed. For active checks this is the difference betwee n the scheduled service check time

and the time the check actually occurred. For passive checks this is the difference betwe en the timestamp on the pa ssive check result (submitted

through the external command file) and the time the pas sive check result was picked up by the Icinga daemon for process ing

re tu rn _co de SMALLINT The re tu rn co de fro m th e s ervice ch eck co mma nd

output VARCHAR(255) The status output that was returned from the service check command (fi rst line)

long_out pu t TEXT The s ta tus out pu t t ha t was re tu rned from the service check command (consecu tive lines )

pe rfda ta TEXT Optio na l performance da ta tha t w as returne d fro m the service check command

Relationships:

Field Foreign Key


service object id objects object id


15/39df di b PRO iAre you a developer? Try out the HTML to PDF API

service_object_id objects.object_id


Statehistory Table

Description: This table is used to s tore a historical record of host and se rvice state changes.

Structure:


statehistory_id SERIAL Unique number identifying the record PK

instance_idBIGINT

unsigned


this entry is associated with

s ta te _time TIMESTAMP Th e da te /time th at th e s ta te cha ng e o ccu rre ds ta te_time_usec INT The microsecond portion o f the t ime the s ta te change occurred

object_idBIGINT

unsignedThe id of the host or se rvice object this state cha nge app lies to

state_change SMALLINTNumber indicating whether or no t a state chan ge occurred for

the host o r service0 = No state change; 1 = State change

state SMALLINT Number indicating the current state of the host or serviceFor Hosts: 0 = UP; 1 = DOWN; 2 = UNREACHABLE; For Services: 0 = OK; 1 = WARNING; 2 = CRITICAL; 3 =

UNKNOWN

state_type SMALLINT Number indicating whether the service is in a soft or hard state 0 = SOFT state; 1 = HARD state

current_check_attempt SMALLINTNumber indicating the current check attempt for the hos t or

service

max_check_attempts SMALLINTNumber indicating the max check attempts (as configured in

Icinga) for the ho st or se rvice

last_state SMALLINT Number indicating the last state (whe ther hard or soft) of thehost o r service (if available) For Hosts: -1 = unavailable; 0 = UP; 1 = DOWN; 2 = UNREACHABLE; For Services: -1 = unavailable; 0 =OK; 1 = WARNING; 2 = CRITICAL; 3 = UNKNOWN

la st_hard_sta te SMALLINTNumber indicating the las t hard state of the ho st or se rvice (if

available)

For Hosts: -1 = unavailable; 0 = UP; 1 = DOWN; 2 = UNREACHABLE; For Services: -1 unavailable; 0 = OK;

1 = WARNING; 2 = CRITICAL

output VARCHAR(255)The current plugin/status output of the host o r service (first

line)

long_output TEXTThe current plugin/status ou tput of the host o r service

(consecutive lines)

Relationships:

Field Foreign Key



Systemcommands Table

Description: This table is use d to s tore a histo rical record of system commands that a re run by the Icinga dae mon. Note that each event handler, notification, OCSP command, etc. requires that Icinga e xecute a syste m

command. NOTE: This table is usually trimmed periodically by the IDO2DB daemon, as it wo uld otherwise grow to an eno rmous size.

Structure:


systemcommand_id SERIAL Unique number identifying the record PK


start_time TIMESTAMP The date/time the command was executed UK2

start_time_usec INT The microsecond portion of the time the command was executed UK3

e nd time TIME STAMP The da te /time the co mma nd fin is he d e xe cu tin g


16/39

Are you a developer? Try out the HTML to PDF API

e nd _time TIME STAMP The da te /time the co mma nd fin is he d e xe cu tin g

end_time_usec INT The microsecond portion o f the time the command fin ished execu ting

command_line VARCHAR(1024) Fully expanded command line that was executed

time out SMALLINT Number of se co nds be fo re the co mma nd sho uld time out

early_timeout SMALLINT Number indicating w hether or not the command timed out early 0 = Did NOT timeout; 1 = Timed out

execu tion_ time DOUBLE Number of se conds it took to execu te the command

return_code SMALLINT Return code of the command

output VARCHAR(255) F irst line of text output (if ava ilable) that was returned from the command

long_out pu t TEXT Consecu tive lines o f text ou tput (if ava ilable ) that we re re tu rned from t he command

Relationships:

Field Foreign Key


Timedevents Table

Description: This table is used to s tore a historical record of timed events that the Icinga process ha ndled. Timed events a re internal to the Icinga daemon and u sed to initiate service checks, host checks, status file

updates, e tc. They are at the heart of wha t Icinga does and how it ope rates. NOTE: This table is usua lly trimmed periodically by the IDO2DB daemon, as it wo uld otherwise grow to an eno rmous size.

Structure:


systemcommand_id SERIAL Unique number identifying the record PK

instance_idBIGINT


event_type SMALLINT Number indicating the type of event that was run See Icinga source code UK2

queued_time TIMESTAMP The date/t ime the event was added to the event queue

queued_time_usec INT Microsecond por tion of the time the event was added to the event queue

e ve nt_time TIME STAMP Th e da te /time th e e ve nt wa s h and le d

event_ time_usec INT Microsecond portion o f the t ime the event was hand led

scheduled_time TIMESTAMP The date/time the event was scheduled to be handled/run UK3

recurring_event SMALLINT Number indicating whether or not the event is a recurring one or a one-time event0 = One-time event; 1 = Recurring

event

object_idBIGINT

unsigned

The id of the host or se rvice that the e vent applies to. Not all events ap ply to hosts or se rvices - in these cas es the value o f this field

will be 0.UK4

delet ion_t ime TIMESTAMP The date/t ime the event was deleted/removed from the event queue

delet ion_t ime_usec INT Microsecond port ion of the time the event was removed from the event queue

Relationships:

Field Foreign Key



SLA-History Table

Description: This table is use d to kee p track of host/service availability statistics in a sep arate history table. A configuration flag (enable_sla) is use d to en able/disable SLA data collection; it defaults to 0 (disabled).

Note

This table is introduced w ith Icinga 1.6.


17/39

pdfcrowd.comopen in browser PRO version Are you a developer? Try out the HTML to PDF API

g

Structure:


slahistory_id SERIAL unique ID for a SLA history entry PK

instance_idBIGINT

unsignedIcinga instance ID

start_time TIMESTAMP Time interval for the history entry (default '0000-00-00 00:00:00')

end_t ime TIMESTAMP Time interva l for the h istory ent ry (default '0000-00-00 00:00:00' )

acknowledge ment_time TIMESTAMP Time the state was acknowledged (default NULL)

object_idBIGINT

unsignedThe host/service ID this history entry is related to (default 0)

state SMALLINT Number indicating the state of host or serviceFor hosts: 0 = UP; 1 = DOWN; 2 = UNREACHABLE; For services:; 0 =

OK; 1 = WARNING; 2 = CRITICAL; 3 = UNKNOWN

state_type SMALLINT Number indicating the state type of the host or service 0 = SOFT state; 1 = HARD state

scheduled_downtime TINYINT(1)whethe r the whole time interval was in schedu led down time (a history entry are split into several

entries if only a fraction of the time interval was in s cheduled dow ntime)

Relationships:

Field Foreign Key



12.5.4. Current Status TablesThere are several tables in the database which are used to hold current status information on the Icinga process and all hosts and services that it is monitoring. Entries in these tables are cleared whenever the Icinga

daemon (belonging to the s ame instance) (re)starts

Table List

comments

customvariablestatus

hoststatus

programstatus

runtimevariables

scheduleddowntime

servicestatus

contactstatus

timedeventqueue

Relationship DiagramNotes: To reduce clutter, the links to the instances table (to which all these tables are related) is not show n.

Figure 12.17 . Relationship of Current Status Tables


18/39


Comments Table

Description: This table is use d to s tore current host a nd service comments. Historical comments can be found in the commenthistory table.

Structure:


19/39



comment_id SERIAL Unique number identifying the comment record PK


e ntry_time TIMESTAMP Da te and time the co mme nt was entere d

e ntry_time _use c INT Micro se co nd portio n of co mme nt entry time

comment_type SMALLINT Indicates whether this is a host or service comment 1 = Host comment; 2 = Service comment

entry_type SMALLINT Indicates how this comment came to be entered 1 = User; 2 = Scheduled downtime; 3 = Flapping; 4 = Acknowledgement

object_id BIGINT unsigned The object id of the host or service this acknowledgement applies to

comment_time TIMESTAMP Date and time associated with the comment UK2

internal_comment_id INT The comment ID internal to the Icinga daemon UK3

author_name VARCHAR(64) Text field containing the name of the person who made the comment

comment_data VARCHAR(255) Text field containing the comment

is_persistent SMALLINT Indicates whether or not the comment is persistent 0 = Not persistent; 1 = Persistent

comment_source SMALLINT Indicates the source of the comment 0 =internal (Icinga); 1 = External (user)

expires SMALLINT Indicates whether or not the comment expires 0 = Doesn't expire; 1 = Expires

exp iration_time TIMESTAMP Date and time at which the comment exp ires.

Relationships:

Field Foreign Key



Customvariablestatus Table

Description: This table is used to s tore the current state/values of all custom host, service, and contact variables. Custom variables a re only support in Icinga or Nagios 3.x and higher, so this table w ill be empty for

Nagios 2.x.

Structure:


customvariablestatus_id SERIAL Unique number identifying the record PK

instance_idBIGINT


object_idBIGINT

unsignedThe object id of the host or service this acknowledgement applies to UK1

status_update_time TIMESTAMP Date and time the status of the custom variable was last updated

has_been_modified SMALLINTIndiciates w hether the value of the cus tom variable has bee n modified (during runtime) from its original value in the

config files

0 = Has not been modified; 1 = Has bee n

modified

va rname VARCHAR(255 ) Text fie ld cont ain ing t he name of the custom va riableUK2,

NK

varva lue VARCHAR(255 ) Text fie ld cont ain ing t he va lue o f the custom va riable

Relationships:

Field Foreign Key



Hoststatus Table


20/39


Description: This table is used to s tore the current status of ho sts that are b eing monitored.

Structure:


hoststatus_id SERIAL Unique number identifying the record PK

instance_idBIGINT


host_object_idBIGINT

unsignedThe object id of the host this status entry is associated with U1

status _update_time TIMESTAMP Date and time the status data w as updated

output VARCHAR(255) Plugin output from the latest host check (first line)long_output TEXT Plugin output from the latest host check (consecutive lines)

perfdata TEXT Performance data from the latest host check

current_state SMALLINT Number indicating the current state of the host 0 = UP; 1 = DOWN; 2 = UNREACHABLE

has_been_checked SMALLINT Number indicating whether or not the host has been checked yet 0 = Not checked; 1 = Checked

should_be_ scheduled SMALLINT Number indica ting whe ther or no t checks shou ld be regu la rly s cheduled fo r t his host 0 = Not s cheduled; 1 = Scheduled

current_check_attempt SMALLINTNumber indicating the current check attempt of the h ost. This is only interesting during soft

host states

max_check_attempts SMALLINTNumber indicating how many maximum check attempts will be made to determine the ha rd

state of the host

last_check TIMESTAMP Time the host was last checked

next_check TIMESTAMPThe host is scheduled to be checked next. Will be set to the epoch if the host is not scheduled

for another check

check_type SMALLINT Number indicating if the last host check was an active or passive check 0 = Active; 1 = Passive

last_state_change TIMESTAMPTime the host last had a hard or soft state change. Will be set to the epoch if the host has not

changed state

la st_hard_sta te _cha nge TIMESTAMPThe host last had a hard state change. Will be setup to the epoch if the host has not changed

state

last_time_up TIMESTAMP Time the host was last in an UP state (if ever)

last_time_down TIMESTAMP Time the host w as last in a DOWN state (if ever)

last_ time_unreachab le TIMESTAMP Time the host was last in an UNREACHABLE state (if ever)

state_type SMALLINT Number indicating the type of state the host is in 0 = SOFT state; 1 = HARD state

la st_n otifica tio n TIMESTAMP Time a n otifica tio n w as la st s ent o ut fo r th e ho st (if e ve r)

n ext_n otifica tio n TIMESTAMP Ne xt po ss ib le time th at a no tifica tio n ca n be s en t o ut fo r the ho st

no_more_notifications SMALLINTNumber indicating whether or no t more notifications can be s ent out ab out the current host

problem0 = Send no tifications; 1 = Do not send notifications

n otifica tio ns _e na ble d SMALLINT Nu mbe r ind ica tin g w he th er o r no t no tifica tio ns are en ab le d fo r th is ho st 0 = No tifica tio ns dis ab le d; 1 = No tifica tio ns ena ble d

problem_has_been_acknowledged SMALLINT Number indicat ing whether or not the current host problem has been acknowledged 0 = Not acknowledged; 1 = Acknowledged

a cknow le dge me nt_type SMALLINT Numbe r indica ting the type of acknow le dgeme nt asso ciate d w ith the ho st 0 = None; 1 = No rma l; 2 = Sticky

current_notifi cation_number SMALLINTNumber indicating the current notification number for the current host problem. This number

gets reset to 0 when the host recovers

pa ssive_checks _e na bled SMALLINT Numbe r indica ting whe ther or no t pa ss ive che cks are ena ble d fo r this hos t 0 = Dis abled; 1 = Ena bled

a ctive_che cks _e nabled SMALLINT Numbe r indica ting w he ther or no t active che cks are e na bled fo r this hos t 0 = Dis abled; 1 = Ena bled

event_handler_enabled SMALLINT Number indicating w hether or not the host's event handler is enabled 0 = Disabled; 1 = Enabled

fla p_dete ctio n_enable d SMALLINT Numbe r indica ting w he ther or no t fla p de tectio n is enable d for this ho st 0 = Dis abled; 1 = Ena bled

is_flapping SMALLINT Number indicating whether or not the host is currently flapping 0 = Not flapping; 1 = Flapping

percent_state_change DOUBLENumber indicating the current percent state change (a measure of stability/volatility) for the

host


21/39


host

latency DOUBLENumber of seconds that the host check was "late" in being executed. The different between

the checks scheduled time and the time it was a ctually checked

execution_time DOUBLE Number of seconds it took to perform the last check of the host

scheduled_downt ime_depth SMALLINT Number ind icating how many periods of scheduled0 = Not in scheduled do wtime downtime are currently active

for this host; >0 = In scheduled dow ntime

fa ilu re_p rediction_enab led SMALLINTNumber indicating whe ther or not failure prediction (not yet implemented) is ena bled for this

host0 = Disabled; 1 = Enabled

process_performance_data SMALLINT Number indicating whether or not performance data should be processed for this host 0 = Disabled; 1 = Enab led

obsess_over_host SMALLINT Number indicating whether or not this host should be obsessed over 0 = Do not obsess; 1 = Obsess

modified_host_attributes INTNumber indicating which attributes o f the host have be en modified during runtime. Used b y

the retention data routines

event_handler VARCHAR The current event handler command associated with the host

check_command VARCHAR The current check command associated w ith the host

check_interval DOUBLE Number of seconds between normal checks of the host

retry_interval DOUBLE Number of seconds between retry checks of the host

check_timeperiod_object_idBIGINT

unsigned

Unique number of the timeperiod object currently used for de termining times the hos t can be

checked

Relationships:

Field Foreign Key

insta nce _id ins tance s.ins ta nce_id

hos t_obje ct_ id obje cts .obje ct_ id

timeperiod_object_id objects.object_id

Programstatus Table

Description: This table s tored sta tus information on the currently (or previously) running Icinga process/daemon.

Structure:


programstatus_id SERIAL Unique number identifying the record PK

in sta nce _id BIGINT un sig ne d Uniq ue n umb er id en tifyin g the d is tinct ins ta nce o f Icin ga w hich th is e ntry is a ss ocia te d w ith U1

s ta tus _u pd ate _time TIMESTAMP Da te a nd time the s ta tus o f the pro ce ss w as la st upd ate d

pro gra m_s ta rt_time TIMESTAMP Da te and time the Icin ga pro ce ss wa s s ta rte d

p rogram_end_t ime TIMESTAMP Date and time the Icinga process as s topped (if cu rrent ly no t runn ing)

is_currently_running SMALLINT Indicates whether or not the Icinga process is currently running 0 = Process is not running; 1 = Process is running

process_id BIGINT unsigned The processed ID (PID) of the Icinga process

daemon_mode SMALLINT Indicates whether Icinga is running as a foreground process or a daemon 0 = Foreground process; 1 = Daemon

last_command_check TIMESTAMP Date and t ime the Ic inga process last checked externa l commands

la st_lo g_ro ta tio n TIMESTAMP Da te a nd time the lo g file w as la st ro ta te d (if a t a ll)

notifications_enabled SMALLINT Indicates whether or not notifications are enabled 0 = Disabled; 1 = Enabled

active_service_checks_enabled SMALLINT Indicates whether or not active service checks are enabled 0 = Disabled; 1 = Enabled

passive_service_checks_enabled SMALLINT Indicates whether or not passive service checks are enabled 0 = Disabled; 1 = Enabled

active_host_checks_enabled SMALLINT Indicates whether or not active host checks are enabled 0 = Disabled; 1 = Enabled

passive_host_checks_enabled SMALLINT Indicates whether or not passive host checks are enabled 0 = Disabled; 1 = Enabled

event_handlers_enabled SMALLINT Indicates whether or not event handlers are enabled 0 = Disabled; 1 = Enabled

flap_detection_enabled SMALLINT Indicates whether or not flap detection is enabled 0 = Disabled; 1 = Enabled


22/39


failure_prediction_enabled SMALLINT Indicates whether or not failure prediction is enabled 0 = Disabled; 1 = Enabled

process_performance_data SMALLINT Indicates whether or not performance data is enabled/being processed 0 = Disabled; 1 = Enabled

obsess_over_hosts SMALLINT Indicates whether or not hosts are being obsessed over 0 = Disabled; 1 = Enabled

obsess_over_services SMALLINT Indicates whether or not services are being obsessed over 0 = Disabled; 1 = Enabled

modified_host_at tributes INT Indicates what (if any) host-re lated program status var iables have been modif ied during runt ime See Icinga source code for va lues

modif ied_service_attributes INT Indicates what (if any) service-related program status variables have been modif ied during runtime See Icinga source code for values

global_host_event_handler VARCHAR(255) Text field indicating the current global host event handler command that is being used.

global_service_event_handlers VARCHAR(255) Text field indicating the current global service event handler command that is being used

Relationships:

Field Foreign Key


Runtimevariables Table

Table Description: This table is use d to sto re some runtime variables from the Icinga process that may be useful to you. The only variables currently stored in this table are some initial variables calculated at startup, but

more variables may be stored here in future versions.

Structure:


runtimevariable_id SERIAL Unique number identifying the record PK


varname VARCHAR(64) Text field containing the name of the variable UK2

varvalue VARCHAR(255) Text fie ld contain ing the va lue of the variable

Relationships:

Field Foreign Key


Scheduleddowntime Table

Description: This table is use d to s tore current host a nd service dow ntime, which may either be current in effect or scheduled to be gin at a future time. Historical scheduled down time information can be found in the

downtimehistory table.

Structure:


scheduleddowntime_id SERIAL Unique number identifying the record PK

instance_idBIGINT


downtime_type SMALLINT Indicates whether this is a host or serv ice downt ime entry1 = Service downtime; 2 =

Host downtime

object_idBIGINT

unsignedThe object id of the host or service this downtime applies to UK2

entry_time TIMESTAMP Date and time this downtime was entered UK3

author_name VARCHAR(64) Text field containing the name of the person who created this scheduled downtime

comment_data VARCHAR(255) Text field containing information about this scheduled downtime (as entered by the user)

internal_downtime_idBIGINT

unsignedThe ID number (internal to the Icinga daemon) associated with this scheduled downtime entry UK4

triggered_by_idBIGINT

unsigned

The internal Icinga ID number (if any) of another scheduled downtime entry that this do wntime is "triggered" (started) by. If this field is

nonze ro this is a triggered downtime entry otherwise it is not


23/39


unsigned nonze ro, this is a triggered downtime entry, otherwise it is not

is_fixed SMALLINTIndicates whethe r this is a "fixed" scheduled dow ntime entry (that should sta rt and end a t the start and e nd times indicated) or a

"flexible" entry that can start at a variable time

0 = Flexible (not fixed) 1 =

Fixed

duration SMALLINTIndicates the number of seconds that the sched uled dow ntime sho uld last. This is usually only needed if this is "flexible" downtime,

which can start at a variable time, but lasts for the specified duration

scheduled_start_time TIMESTAMPDate and time that the downtime is sche duled to s tart if it is "fixed" dow time. If this is a "flexible" dow ntime entry, this is the first

possible time the downtime can start

scheduled_end_time TIMESTAMPDate and time the d owntime is schedu led to end if it is "fixed" do wntime. If this is a "flexible" downtime entry, this is the last po ssible

time the do wntime can start

was_started SMALLINT Indicates whether or not the downt ime was started (is currently #FIXME)0 = Not started (inactive) 1 =

Started (active)

actual_start_t ime TIMESTAMP Date and t ime the scheduled downtime was actually startedactual_start_t ime_usec INT Microsecond port ion of t ime the scheduled downtime was actually started

Relationships:

Field Foreign Key



Servicestatus Table

Description: This table is use d to s tore current status information for all services that are b eing monitored.

Structure:


servicestatus_id SERIAL Unique number identifying the record PK

instance_idBIGINT


service_object_idBIGINT

unsignedThe id of the service this record is associated with U1

s ta tus _u pd ate _time TIMESTAMP Th e da te /time the s ta tus re co rd w as up da te d

output VARCHAR(255) The text output from the most current service check (first line)

long_output TEXT The text output from the most current service check (consecutive lines)

perfdata TEXT Optional performance data from the most current service check

current_state SMALLINT Number indicating the current state of the service

0 = OK; 1 = WARNING; 2

= CRITICAL; 3 =

UNKNOWN

h as _b ee n_ch ecke d SMALLINT Nu mbe r ind ica tin g w he th er or no t the s ervice ha s b ee n ch ecke d ye t0 = Has NOT beenchecked; 1 = Has bee n

checked

should_be_scheduled SMALLINT Number indicat ing whether or not the service should be scheduled for periodic checks on a regular basis0 = Not scheduled; 1 =

Scheduled

cu rrent_ check_att empt SMALLINT The cu rrent check a ttempt fo r the service

max_check_a ttempts SMALLINT The max check att empts (as configured in Icinga) fo r the se rvice

la st_ch eck TIMESTAMP Th e da te /time the se rvice w as la st ch ecke d. Se t to th e e po ch if the se rvice ha s n ot be en che cke d ye t

next_check TIMESTAMP The date/time the service is scheduled to be checked next

check_type SMALLINT Number indicating whether or not the last service check was active or passive 0 = Active; 1 = Passive

last_state_change TIMESTAMP The date/t ime the service last changed state (if at all). This gets updated for both HARD and SOFT state changes

last_hard_state_change TIMESTAMP The date/t ime the serv ice last changed HARD states (if at al l)

last hard state SMALLINT 0 = OK 1 = WARNING; 2 = CRITICAL; 3 = UNKNOWN


24/39


last_hard_state SMALLINT 0 OK 1 WARNING; 2 CRITICAL; 3 UNKNOWN

la st_time _o k TIMESTAMP The da te /time the se rvice w as la st in a n OK state (if at all)

la st _time_warn ing TIMESTAMP The date /time the service was la st in a WARNING s ta te (if a t a ll)

la st _time_unknown TIMESTAMP The date /time the service was la st in an UNKNOWN sta te (if at all)

la st _time_crit ica l TIMESTAMP The date /time the service was la st in a CRITICAL s ta te (if a t a ll).

state_type SMALLINT Number indicating w hether the service is in a hard or soft state0 = SOFT state; 1 =

HARD

state last_not if icat ion TIMESTAMP The date/t ime that a notification was last sent out for the current service problem (if applicable)

next_notifi cation TIMESTAMP The earliest date/t ime that the next not if ication can be sent out for the current service problem (if app licable)

no_more_not if icat ions SMALLINT Number indicat ing whether or not future notificat ions can be sent out for the current service problem

0 = Do not sen d more

notifications; 1 = Keep

sending no tifications

not ifications_enabled SMALLINT Number indicating whether not if ications are enabled for the serv ice0 = Disabled; 1 =

Enabled

problem_has_been_acknowledged SMALLINT Number indicating whether or not the current status problem has been acknowledged0 = Not acknowledged;

1 = Acknowledge d

acknowledgement_type SMALLINT Number indicating the type of acknowledgement (if any)

0 = No

acknowledgement; 1 =

Normal

acknowledgement; 2 =

Sticky acknowled gement

current_notification_number SMALLINT Number indicating how many notifications have been sent out about the current service problem (if applicable)

passive_checks_enabled SMALLINT Number indicat ing whether or not passive checks are enabled for the service0 = Disabled; 1 =

Enabled

act ive_checks_enabled SMALLINT Number indicating whether or not active checks are enabled for the service0 = Disabled; 1 =

Enabled

event_handler_enab led SMALLINT Number indicating whether or not the service event hand ler is enabled0 = Disabled; 1 =

Enabled

flap_detect ion_enabled SMALLINT Number indicating whether or not flap detect ion is enabled for the service0 = Disabled; 1 =

Enabled

is_flapping SMALLINT Number indicating whether ot not the service is currently flapping0 = Not flapping; 1 =

Flapping

percent_state_change DOUBLE Number indicating the current percent state change (a measure of volatilit y) for the serv ice

latency DOUBLE

Number indicating how "late" the last service check was in being run. For active checks, this is the difference betw een the time the

service was s cheduled to be the checked and the time it was a ctually checked. For passive checks, this is the difference betwee n

the timestamp on the p assive check (submitted via an external command) and the time Icinga processe d the check result.

execution_time DOUBLE Number of seconds it took to run the last service check

execution_time DOUBLE Number of seconds it took to execute the service check

scheduled_downt ime_dep th SMALLINT Number indicating how many periods of sched uled dow ntime are currently in effect for the se rvice. A value of 0 indicates the serviceis not in a period of do wntime

failure_prediction_enabled SMALLINT Number indicating whether or not failure prediction is enabled for the service. This feature has not yet been implemented0 = Disabled; 1 =

Enabled

process_performance_data SMALLINT Number indicat ing whether or not performance data should be processed for the service

0 = Do NOT process

perfdata; 1 = Process

perfdata

obsess_over_serv ice SMALLINT Number indicating whether or not Icinga should obsess of check result s of the serv ice0 = Do NOT obsess ; 1 =

Obsess

modified_service_attributes INT Number indicating what service attributes have been modified during runtime See Icinga source code

event_hand le r VARCHAR(255) The cu rrent event hand le r command that is associa ted w ith the service

check_command VARCHAR(255) The current check command that is used to check the status of the serv ice

norma l_check_in te rva l DOUBLE The cu rrent no rma l check in te rva l fo r the se rvice (in seconds)

re try check in te rva l DOUBLE The cu rrent re try check in te rva l fo r the service (in seconds)


25/39


y_ _ y ( )

check_timeperiod_object_idBIGINT

unsignedThe currently timeperiod that is us ed to dete rmine w hen the s ervice can be checked.

Relationships:

Field Foreign Key


s ervice _o bje ct_id o bje cts .o bje ct_id

check_timeperiod_object_id objects.object_id

Contactstatus Table

Description: This table is used to s tore current status information for all contacts that are be ing used.

Structure:


contactstatus_id SERIAL Unique number identifying the record PK

instance_id BIGINT unsigned Unique number identifying the dist inct instance of Icinga which this entry is associated with

contact_object_id BIGINT unsigned The id of the service this record is associated with U1

s ta tus_updat e_ time TIMESTAMP The da te /time t he s ta tus re co rd was updat ed

hostnotificat ions_enabled SMALLINT Number indicat ing whether or not host not if icat ions are enabled for this contact 0 = Not if icat ions disabled; 1 = Not if icat ions enabled

servicenotifications_enabled SMALLINT Number indicating whether or not service notifications are enabled for this contact 0 = Notifications disabled; 1 = Notifications enabled

la st _hos tnotifica tion TIMESTAMP Time t he la st host no tifica tion was sen t

last_servicenotification TIMESTAMP Time the last service notification was sent

modified_attributes INT Default = 0

modified_host_attributes INT Default = 0

modified_service_attributes INT Default = 0

Relationships:

Field Foreign Key


Timedeventqueue Table

Description: This table is used to s tore all timed events that are in the Icinga event que ue, scheduled to b e executed at a future time. Historical timed events can be found in the timedevents table.

Structure:


timedeventqueue_id SERIAL Unique number identifying the record PK

instance_idBIGINT


event_type SMALLINT Value indicating the type of event UK2

queued_time TIMESTAMP Date and t ime the event was or iginally placed into the timed event queue

queued_time_usec INT Microsecond port ion of t ime the event was queued

scheduled_time TIMESTAMP Date and time the event is scheduled to be executed UK3

recurring_event SMALLINT Indicates whether or not this is a recurr ing event0 = Not recurring; 1 =

Recurring

object_idBIGINT

unsigned

The object id of the host, service, contact, etc. that this scheduled e vent applies to (if applicable). If the even t is not as sociated w ith any particular

object, this field will have a value o f zero (0)UK4


26/39


Relationships:

Field Foreign Key



12.5.5. Configuration Tables

Note

The tables that conta in configuration data have not yet be en fully documented.

There are many tables in the database that are used to store Icinga configuration. Note that the data in these tables represents a read-only output view of the configuration that Icinga was using during its last (or

current) run. Configuration information from these tables is NOT read by the Icinga dae mon in any way, and thus cannot be us ed to configure Icinga.

Table List

commands

configfiles

configfilevariables

contact_addresses

contact_notificationcommands

contactgroup_members

contactgroups

contactnotificationmethods

contacts

customvariables

host_contactgroups

host_contacts

host_parenthosts

hostdependencies

hostescalation_contactgroups

hostescalation_contacts

hostescalations

hostgroup_members

hostgroups

hosts

service_contactgroups

service_contacts

servicedependencies

serviceescalation_contactgroups

serviceescalation contacts


27/39


serviceescalation_contacts

serviceescalations

servicegroup_members

servicegroups

services

timeperiod_timeranges

timeperiods

Figure 12.18. Relationship of Configuration Tables


28/39


Commands Table

Description: .

Structure:


command_id SERIAL Unique number identifying the record PK


config_type SMALLINT UK3

obje ct _id BIGINT uns igned UK2

command_line VARCHAR(1024)


29/39


Configfiles Table

Description: .

Structure:


configfile_id SERIAL Unique number identifying the record PK


co nfigfile _typ e SMALLINT UK2

configfile_path VARCHAR(255) UK3

Configfilevariables Table

Description: .

Structure:


configfilevariable_id SERIAL Unique number identifying the record PK


co nfigfile _id BIGINT un sign ed

varname VARCHAR(64)

varvalue VARCHAR(1024)

Contact_addresses Table

Description: .

Structure:


contact_address_id SERIAL Unique number identifying the record PK


contact_id BIGINT unsigned UK1

address_number SMALLINT UK2

address VARCHAR(255)

Contact_notificationcommands Table

Description: .

Structure:


contact_notficationcommand_id SERIAL Unique number identifying the record PK

instance_id BIGINT uns igned Unique number identifying the distinct instance of Ic inga which this ent ry is associated with

contact_id BIGINT unsigned UK1

notification_type SMALLINT UK2

co mma nd_object_id BIGINT uns igned UK3

command_args VARCHAR(255) UK4

Contactgroup_members Table

Description: .


30/39


Structure:


contactgroup_member_id SERIAL Unique number identifying the record PK

instance_id BIGINT unsigned Unique number identifying the dist inct instance of Icinga which this entry is associated with

co ntactgro up_id BIGINT unsigne d UK1

cont act_ ob je ct_ id BIGINT uns igned UK2

Contactgroups Table

Description: .

Structure:


contactgroup_id SERIAL Unique number identifying the record PK


config_type SMALLINT UK2

contactgroup_object_id BIGINT unsigned UK3

alias VARCHAR(255)

Contactnotificationmethods Table

Description: .

Structure:


contactnotificationmethod_id SERIAL Unique number identifying the record PK


contactnot ificat ion_ id BIGINT uns igned UK2

start_time TIMESTAMP UK3

start_time_usec INT UK4

end_time TIMESTAMP

end_time_usec INT

co mma nd_o bje ct_id BIGINT un sign ed

command_args VARCHAR(255)

Contacts Table

Description: .

Structure:

Fiel

docs icinga org latest en db model html

Documents