blob: 33236e53fe201cff4754f4358d000e1985e69a72 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
Configuration Format
====================
The configuration format is based on YAML.
YAML is a human friendly data serialization standard for all programming languages.
It is an easy way to define data in a hierarchy, and still being able to view and modify it as a human.
For details on the format see [yaml.org](http://yaml.org/).
The configuration is structured in a hierarchical object structure like:
root object -> children (array) -> objects -> more children
Every node is unique in the tree, but names can be repeated. An Icinga objects can be inserted multiple times.
## Example
Best to understand it is to start with an example.
```yaml
name: View Name
children:
- name: Section 1
children:
- name: Tile 1
children:
- host: localhost
- host: localhost
service: disk
- host: localhost
service: ssh
- name: Tile 2
- hostgroup: linux-servers
- name: Tile 3
- name: Section 2
- name: Tile 1
- name: Tile 2
- name: 'Tile 3: The return of long names' # some values should be quoted
```
## Layers
The first three layers have a special meaning for the view.
1. Root Node - defines the name of the view
2. Sections - defines the sections in the tile view
3. Tiles - builds tiles in the tile view
Everything below is only visible via the tree view, and every Icinga node should be below the 3rd level.
## Nodes
Every node is an object in YAML, while the object attribute `children` is an array of all children objects
for that node.
Indention does matter as far as it defines the levels and structure of the objects. (Please use no soft tabs!)
Every node can have multiple attributes, they are partially validated, and unknown keys just get ignored.
### Name nodes
Default node type is a simple named node that gets status from deeper nodes.
The root node itself has also only a name, but can contain options mentioned below.
Attributes:
* `name: Test` user readable name of the object
### Icinga Host
Brings in the host state of an individual Icinga host.
Attributes:
* `host: localhost` hostname in Icinga
* `type: host` (optional - detected by key attribute)
### Icinga Service
Brings in the service state of an individual Icinga service.
Attributes:
* `host: localhost` hostname in Icinga
* `service: servicename` servicename in Icinga
* `type: service` (optional - detected by key attribute)
### Icinga Hostgroup
Brings in the hostgroup summary state.
Attributes:
* `hostgroup: linux-servers` hostname in Icinga
* `type: hostgroup` (optional - detected by key attribute)
## Options
Additional options are available to control status behavior of
the respective view.
* `host_never_unhandled` (boolean) Controls the host not being displayed as an unhandled problem. See [behavior](02-Behavior.md#host-always-handled) (Default: false)
* `notification_periods` (boolean) Controls checking notification_period to be in_period. See [behavior](02-Behavior.md#enabling-notification-period) (Default: false)
These options are just set on the root node:
```yaml
name: Test Config with Options
host_never_unhandled: true
children:
- name: Section 1
```
## Examples
Here is a longer example from a testing configuration
```yaml
name: Test
children:
- name: Single Objects
children:
- name: OK
children:
- host: host_ok
- host: host_ok
service: s_ok
- host: host_s_soft
- host: host_s_soft
service: s_critical_soft
- name: DOWN
children:
- host: host_down
- host: host_down
service: s_critical
- name: CRITICAL
children:
- host: host_s_critical
- host: host_s_critical
service: s_critical
- name: WARNING
children:
- host: host_s_warning
- host: host_s_warning
service: s_warning
- name: Single Objects Handled
children:
- name: CRITICAL handled
children:
- host: host_s_critical_handled
- host: host_s_critical_handled
service: s_critical_handled
- name: WARNING handled
children:
- host: host_s_warning_handled
- host: host_s_warning_handled
service: s_warning_handled
- name: Hostgroups
children:
- name: OK
children:
- hostgroup: HG_OK
- hostgroup: HG_SOFT
- name: DOWN
children:
- hostgroup: HG_DOWN
- name: CRITICAL
children:
- hostgroup: HG_CRITICAL
- name: WARNING
children:
- hostgroup: HG_WARNING
- name: TLV Missing
children:
- name: Partially missing
children:
- host: host_ok
- name: missing
- name: Missing with problems
children:
- host: host_down
- name: missing
- name: Missing with handled
children:
- host: host_down_handled
- name: missing
- name: Empty
children:
- name: nothing here
- name: Notexisting Object
children:
- host: notexisting
```
|
