Shinken Manual
About
About Shinken
Feature comparison between Shinken and Nagios
Shinken notable innovations
The project Vision
Feature selection and release cycle
Release code names
Getting Started
Advice for Beginners
Quickstart Installation Guides
Installations
Upgrading Shinken
Monitoring Windows Machines
Monitoring GNU/Linux & Unix Machines
Monitoring Network Printers
Monitoring Routers and Switches
Monitoring Publicly Available Services
Nagios/Shinken Plugins
Introduction
What Are Plugins?
Shinken integrated data acquisition modules
Plugins As An Abstraction Layer
What Plugins Are Available?
Obtaining Plugins
How Do I Use Plugin X?
Plugin API
Configuring Shinken
Configuration Overview
Main Configuration File Options
Object Configuration Overview
Object Definitions
Custom Object Variables
Main advanced configuration
Running Shinken
Verifying Your Configuration
Starting and Stopping Shinken
The Basics
Setting up a basic Shinken Configuration
Nagios/Shinken Plugins
Understanding Macros and How They Work
Standard Macros in Shinken
Host Checks
Service Checks
Active Checks
Passive Checks
State Types
Time Periods
Determining Status and Reachability of Network Hosts
Notifications
Active data acquisition modules
Network dependencies
Logical dependencies
Update Shinken
Medium
Business rules
Monitoring a DMZ
Shinken High Availability
Mixed GNU/linux AND Windows pollers
Notifications and escalations
The Notification Ways, AKA mail 24x7, SMS only the night for a same contact
Passive data acquisition
Advanced Topics
External Commands
Event Handlers
Volatile Services
Service and Host Freshness Checks
Distributed Monitoring
Redundant and Failover Network Monitoring
Detection and Handling of State Flapping
Notification Escalations
On-Call Rotations
Monitoring Service and Host Clusters
Host and Service Dependencies
State Stalking
Performance Data
Scheduled Downtime
Adaptive Monitoring
Predictive Dependency Checks
Cached Checks
Passive Host State Translation
Service and Host Check Scheduling
Object Inheritance
Advanced tricks
Business rules
Migrating from Nagios to Shinken
Multi layer discovery
Multiple action urls
Aggregation rule
Scaling Shinken for large deployments
Defining advanced service dependencies
Shinken’s distributed architecture
Shinken’s distributed architecture with realms
Macro modulations
Shinken and Android
Send sms by gateway
Triggers
Unused nagios parameters
Advanced discovery with Shinken
Discovery with Shinken
Config
Host Definition
Host Group Definition
Service Definition
Service Group Definition
Contact Definition
Contact Group Definition
Time Period Definition
Command Definition
Service Dependency Definition
Service Escalation Definition
Host Dependency Definition
Host Escalation Definition
Extended Host Information Definition
Extended Service Information Definition
Notification Way Definition
Realm Definition
Arbiter Definition
Scheduler Definition
Poller Definition
Reactionner Definition
Broker Definition
Shinken Architecture
Arbiter supervision of Shinken processes
Advanced architectures
How are commands and configurations managed in Shinken
Problems and impacts correlation management
Problems and impacts correlation management
Shinken Architecture
Troubleshooting
FAQ - Shinken troubleshooting
Integration With Other Software
Integration Overview
SNMP Trap Integration
TCP Wrappers Integration
Thruk
Nagios CGI UI
Thruk interface
Use Shinken with ...
Use Shinken with Centreon
Use Shinken with Graphite
Use Shinken with Multisite
Use Shinken with Nagvis
Use Shinken with Old CGI and VShell
Use Shinken with PNP4Nagios
Use Shinken with Thruk
Use Shinken with WebUI
Security and Performance Tuning
Security Considerations
Tuning Shinken For Maximum Performance
Scaling a Shinken installation
Shinken performance statistics
How to monitor ...
Monitoring an Asterisk server
check_wmi_plus.pl for shinken on windows
Monitoring Active Directory
Monitoring a DHCP server
Monitoring Microsoft Exchange
Monitoring a IIS server
Monitoring Linux Devices
Monitoring Linux Devices
Monitoring a Linux via a Local Agent
Monitoring a Linux via SNMP
Monitoring Publicly Available Services
Monitoring a printer
Monitoring Network Devices
Monitoring Windows Devices
Monitoring Microsoft Mssql server
Monitoring MySQL
Monitoring VMware Machines
Monitoring Microsoft Mssql server
Monitoring MySQL
Monitoring Publicly Available Services
Monitoring an Oracle database server
Monitoring a printer
Monitoring Network Devices
Monitoring VMware Machines
Monitoring Windows witn NSClient++
Monitoring Windows Devices
How to contribute
Shinken packs
Shinken modules and Shinken packs
Help the Shinken project
Getting Help and Ways to Contribute
Shinken Package Manager
Development
Shinken Programming Guidelines
Test Driven Development
Nagios Plugin API
Developing Shinken Daemon Modules
Hacking the Shinken Code
Shinken modules
Amazon AWS/EC2 import
Amazon AWS/EC2 import
The distributed retention modules
How to enable and use Livestatus module
Exporting data for reporting
Monitoring Linux System with Glances and checkglances.py
Shinken GLPI integration
Ip Tag module
Ubuntu Landscape import
Shinken Livestatus API
NSCA module
Retention troubleshooting
NRPE Module
Extending Shinken
Broker modules
TSCA (Thrift Service Check Acceptor)
VMWare Arbiter module
Web Service Module
SNMP module
WebUI module
Reference
shinken
shinken Package
clients Package
daemons Package
discovery Package
misc Package
objects Package
webui Package
Shinken Manual
Docs
»
Shinken modules
Edit on GitHub
Shinken modules
ΒΆ
This part must be splitted and sent in all module repositories
Amazon AWS/EC2 import
Description
Prerequisites
Configuring the Landscape import module
Configuring the Arbiter module
Generated hosts
Amazon AWS/EC2 import
Description
Prerequisites
Configuring the Landscape import module
Configuring the Arbiter module
Generated hosts
The distributed retention modules
Non distributed retention modules
MongoDB
Memcached
Redis
How to enable and use Livestatus module
Define the Livestatus module
Enable the Livestatus module
Disable human readable logs
Exporting data for reporting
raw_socket module
Why export reporting data
Reporting module using Splunk
Raw_socket log format
Raw_socket module availability
Monitoring Linux System with Glances and checkglances.py
How does it work
Install glances
Install checkglances.py
Install the glances pack
What will be monitored ?
Shinken GLPI integration
Requirements
Enabling GLPI Shinken module
Ip Tag module
Why tag a host based on it’s IP address?
Ip_tag module
Add value instead of setting it
Name resolution
Ubuntu Landscape import
Description
Prerequisites
Configuring the Landscape import module
Configuring the Arbiter module
Shinken Livestatus API
Overview
What is it
Why use it
What can I do with it?
How does it work
What software uses Livestatus to interact with Shinken
Installing Livestatus
How to enable Livestatus
NSCA module
Retention troubleshooting
NRPE Module
What is it
How to define it
Extending Shinken
Introduction
Broker modules
Core modules
simple_log: get all logs into one file
Syslog - Send all logs to a local syslog server
Lightweight forwarder to Splunk
Livestatus API Module - Thruk, Nagvis and Multisite Web frontends
Livestatus Module
Livestatus module - Logstore Sqlite
Livestatus module - Logstore MongoDB
Livestatus module - Logstore Null
Network Based Modules - Graphite graphing
graphite_perfdata: exports check result performance data to Graphite
SQL Based Modules - PNP4Nagios Graphing
npcdmod: export perfdatas to a PNP interface
SQL Based Modules - Frontend Centreon2
ndodb_mysql: Export to a NDO Mysql database
File based Legacy modules - perfdata export
service_perfdata: export service perfdatas to a flat file
host_perfdata: export host perfdatas to a flat file
Legacy File based Modules - Old CGI or VShell
status_dat: export status into a flat file
Deprecated or unsupported modules
SQL Based MerlinDB
SQL based ndodb_oracle - Icinga web frontend using NDO Oracle
CouchDB: Export to a Couchdb database
TSCA (Thrift Service Check Acceptor)
What is thrift ?
Installation
Server side
Samples clients
Ruby
Python
java
VMWare Arbiter module
How it works
How to define it
Web Service Module
Configuring the Web Service Module
Using the Web Service Module
SNMP module
Shinken integrated SNMP Module
SnmpBooster Download Install and Configure
Downloads
Requirements
Installation
Configuration
How to define the SnmpBooster module in the Shinken daemons
Arbiter daemon configuration
Scheduler daemon configuration
Poller daemon configuration
SnmpBooster Module declaration
How to define a Host and Service
Step 1
Step 2
Here is an example configuration of the config.ini file
Shinken integrated SNMP Module
Overview
What is it
Design specification summary
genDevConfig Plugins - Compatibility status with SnmpBooster
SnmpBooster reference dictionary
SnmpBooster.ini dictionary
DATASOURCE DICTIONARY
DSTEMPLATE DICTIONNARY
TRIGGER DICTIONNARY
TRIGGERGROUP DICTIONNARY
MAP DICTIONNARY
SnmpBooster.ini example configuration
SnmpBooster.ini configuring SNMP Datasources
SnmpBooster.ini configuring SNMP DSTEMPLATES
SnmpBooster.ini setting triggers/thresholds
Shinken integrated SNMP Module
Overview
What is it
Why use it
How does it work
Shinken Integration
Performance
Limitations
Design specification
Data model
Installation and configuration
Reference Dictionnary
Troubleshooting
Graph templates
SnmpBooster Troubleshooting
Check your config
Software version consistency
Software version requirements
Validate your check command arguments
Validate connectivity
Performance
Faulty Template
Log files
memcache persistence
Common errors returned by SnmpBooster in the log file
Memcached Notes
WebUI module
WebUI integration with Shinken
How does the WebUI function globally ?
What is a WebUI User?
To create a new page?
Templates
Call Python objects in your templates
Which javascript lib are you using?
What to do?
WebUI search syntax
WebUI SSL Certification
Read the Docs
v: documentation
Versions
latest
documentation
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.