#===============================================================================
# event manager
#===============================================================================
# Modules that can load this module:
# - WebUI (to display events data to the users)
# This module read event from database to show you in the WebUI
#===============================================================================
define module {
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
#======== │ -------------------------------------- Module identity ========= -------------------------------------- │ #
# --- Module name. [ Must be unique ] [ MANDATORY ] ---
module_name event-manager-reader
# --- Module type (to load module code). Do not edit. [ Do not edit ] [ MANDATORY ] ---
module_type event_container
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ------------------------------------ Database connection ------------------------------------ │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ================= DatabaseMongoDB parameters connection =================
# mongodb--- MongoDB uri definition . forYou connectingcan tofind the mongodb database. You can find the mongodb uri uri syntax at ---
# syntax--- at https://docs.mongodb.com/manual/reference/connection-string/ ---
# >>> Default : mongodb://localhost/?w=1&fsync=false ---
# uri mongodb://localhost/?w=1&fsync=false
# --- Which database contains events data ---
# >>> Default : shinken ---
# database event_container
# If you want--- SSH tunnel activation to securize your mongodb connection you can enable the ssh use_ssh_tunnel that will ---
# --- That will allow all mongodb to be encrypted & authentificated with SSH ---
# --- Enable : 1 ( enable ssh tunnel ) ---
# Should use a SSH>>> Disable : 0 ( disable ssh tunnel ) ( Default 0=False)) ---
# use_ssh_tunnel 0
# --- If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive ---
# >>> Enable : 1 ( with ssh tunnel ) ( Default ) ---
# --- Disable : 1 0 ( direct connection ) ---
# use_ssh_retry_failure 1
# --- SSH user/keyfile in order to connect to the mongodb server. ---
# >>> Default : shinken ---
# ssh_user shinken
# --- SSH keyfile to connect to the mongodb server. ---
# >>> Default : ~shinken/.ssh/id_rsa
# ssh_keyfile ~shinken/.ssh/id_rsa---
# Which--- databaseSSH isTimeout used to store events data
database test if the SSH tunnel is viable or not, in seconds. ---
# >>> Default : 10 ( seconds ) ---
event_container # ssh_tunnel_timeout 10
# =========== Visualisation UI=== AutoReconnect Management ==============
# --- When MongoDB require you to reconnect ( For example, It can occur when a new PRIMARY is elected ---
# --- in a MongoDB cluster ), it will raised the MongoDB AutoReconnect exception. ---
# --- ---
# --- How many try to reconnect before module go in error ---
# >>> Default : 4 ( try ) ---
# auto_reconnect_max_try 4
# --- Time between each try ---
# >>> Default : 3 ( seconds ) ---
# auto_reconnect_sleep_between_try 3
# --- NOTE: Change these values only if you have a MongoDB cluster and you change the ---
# --- heartbeatTimeoutSecs of your MongoDB replica set ---
# --- The value of auto_reconnect_max_try * auto_reconnect_sleep_between_try must be higher than ---
# --- heartbeatTimeoutSecs in the rs.conf(); of your MongoDB replica set. ---
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ------------------------------------- Visualisation UI -------------------------------------- │ #
# --- Specify the max retries when the Visualisation UI can't communicate with ---
# --- the event_manager_reader during export. ---
# --- The value cannot be 0. ---
# >>> Default : 2 ( try ) ---
# broker__module_webui__module_event_manager_reader__events_export__max_retry 2
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
#======== │ ------------------------------------- INTERNAL options =========
#INTERNAL -------------------------------------- │ #
# --- INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT ---
# ==--- time of inactivation of the broker before considering that shinken is inactive (in sec) == ---
# #timetime_before_shinken_inactive 30
}
|