Shinken Documentation Release 2.4 Shinken Team August 14, 2015 Contents 1 About 1 1.1 About Shinken..............................................2 2 Getting Started 5 2.1 Advice for Beginners...........................................6 2.2 Installations................................................7 2.3 Upgrading Shinken............................................ 11 3 Configuring Shinken 13 3.1 Configuration Overview......................................... 14 3.2 Main Configuration File (shinken.cfg) Options............................. 15 3.3 Object Configuration Overview..................................... 23 3.4 Object Definitions............................................ 25 3.5 Custom Object Variables......................................... 26 3.6 Main advanced configuration...................................... 28 4 Running Shinken 49 4.1 Verifying Your Configuration...................................... 50 4.2 Starting and Stopping Shinken...................................... 50 5 The Basics 53 5.1 Setting up a basic Shinken Configuration................................ 54 5.2 Monitoring Plugins............................................ 59 5.3 Understanding Macros and How They Work.............................. 61 5.4 Standard Macros in Shinken....................................... 65 69subsubsection*.137 70subsubsection*.183 72subsubsection*.236 73subsubsection*.262 5.5 Host Checks............................................... 79 5.6 Service Checks.............................................. 81 5.7 Active Checks.............................................. 82 5.8 Passive Checks.............................................. 83 5.9 State Types................................................ 86 5.10 Time Periods............................................... 88 5.11 Determining Status and Reachability of Network Hosts......................... 90 5.12 Notifications............................................... 96 5.13 Active data acquisition modules..................................... 100 i 5.14 Setup Network and logical dependencies in Shinken.......................... 101 5.15 Update Shinken............................................. 108 6 Medium 111 6.1 Business rules.............................................. 112 6.2 Monitoring a DMZ............................................ 120 6.3 Shinken High Availability........................................ 121 6.4 Mixed GNU/linux AND Windows pollers................................ 123 6.5 Notifications and escalations....................................... 124 6.6 The Notification Ways, AKA mail 24x7, SMS only the night for a same contact............ 128 6.7 Passive data acquisition......................................... 129 6.8 Snapshots................................................. 131 7 Advanced Topics 133 7.1 External Commands........................................... 134 7.2 Event Handlers.............................................. 135 7.3 Volatile Services............................................. 139 7.4 Service and Host Freshness Checks................................... 141 7.5 Distributed Monitoring.......................................... 143 7.6 Redundant and Failover Network Monitoring.............................. 152 7.7 Detection and Handling of State Flapping................................ 152 7.8 Notification Escalations......................................... 155 7.9 On-Call Rotations............................................ 161 7.10 Monitoring Service and Host Clusters.................................. 165 7.11 Host and Service Dependencies..................................... 165 7.12 State Stalking............................................... 171 7.13 Performance Data............................................ 172 7.14 Scheduled Downtime........................................... 175 7.15 Adaptive Monitoring........................................... 176 7.16 Predictive Dependency Checks..................................... 177 7.17 Cached Checks.............................................. 179 7.18 Passive Host State Translation...................................... 183 7.19 Service and Host Check Scheduling................................... 183 7.20 Object Inheritance............................................ 184 7.21 Advanced tricks............................................. 195 7.22 Migrating from Nagios to Shinken.................................... 202 7.23 Multi layer discovery........................................... 202 7.24 Multiple action urls............................................ 205 7.25 Aggregation rule............................................. 205 7.26 Scaling Shinken for large deployments................................. 207 7.27 Defining advanced service dependencies................................ 211 7.28 Shinken’s distributed architecture.................................... 216 7.29 Shinken’s distributed architecture with realms.............................. 218 7.30 Businessimpact modulations....................................... 221 7.31 Check modulations............................................ 222 7.32 Macro modulations............................................ 222 7.33 Result modulations............................................ 223 7.34 Shinken and Android........................................... 224 7.35 Send sms by gateway........................................... 226 7.36 Triggers.................................................. 228 7.37 Unused nagios parameters........................................ 229 7.38 Advanced discovery with Shinken.................................... 236 7.39 Discovery with Shinken......................................... 239 ii 8 Config 243 8.1 Host Definition.............................................. 244 8.2 Host Group Definition.......................................... 251 8.3 Service Definition............................................ 252 8.4 Service Group Definition......................................... 260 8.5 Contact Definition............................................ 261 8.6 Contact Group Definition........................................ 265 8.7 Time Period Definition.......................................... 265 8.8 Command Definition........................................... 267 8.9 Service Dependency Definition..................................... 269 8.10 Service Escalation Definition...................................... 271 8.11 Host Dependency Definition....................................... 273 8.12 Host Escalation Definition........................................ 274 8.13 Extended Host Information Definition.................................. 276 8.14 Extended Service Information Definition................................ 278 8.15 Notification Way Definition....................................... 280 8.16 Realm Definition............................................. 281 8.17 Arbiter Definition............................................ 282 8.18 Scheduler Definition........................................... 284 8.19 Poller Definition............................................. 285 8.20 Reactionner Definition.......................................... 286 8.21 Broker Definition............................................. 288 9 Shinken Architecture 291 9.1 Arbiter supervision of Shinken processes................................ 292 9.2 Advanced architectures.......................................... 294 9.3 How are commands and configurations managed in Shinken...................... 300 9.4 Problems and impacts correlation management............................. 302 9.5 Shinken Architecture........................................... 303 10 Troubleshooting 309 10.1 FAQ - Shinken troubleshooting..................................... 310 11 Integration With Other Software 313 11.1 Integration Overview........................................... 314 11.2 SNMP Trap Integration......................................... 315 11.3 TCP Wrappers Integration........................................ 316 11.4 Use Shinken with Thruk......................................... 318 11.5 Nagios CGI UI.............................................. 320 11.6 Thruk interface.............................................. 321 11.7 Use Shinken with .............................................. 322 11.8 Use Shinken with Centreon....................................... 327 11.9 Use Shinken with Graphite........................................ 329 11.10 Use Shinken with Multisite....................................... 332 11.11 Use Shinken with Nagvis........................................ 334 11.12 Use Shinken with Old CGI and VShell................................. 335 11.13 Use Shinken with PNP4Nagios..................................... 336 11.14 Use Shinken with WebUI........................................ 338 12 Security and Performance Tuning 343 12.1 Security Considerations......................................... 344 12.2 Tuning Shinken For Maximum Performance.............................. 347 12.3 Scaling a Shinken installation...................................... 348 12.4 Shinken performance statistics...................................... 348 12.5 Graphing Performance Info With MRTG and nagiostats........................ 349 iii 13 How to monitor ... 351 13.1 Monitoring Active Directory....................................... 352 13.2 Monitoring Asterisk servers....................................... 354 13.3 Monitoring DHCP servers........................................ 356 13.4 Monitoring IIS servers.........................................