Page History

S'il y a plusieurs modules broker-module-livedata présents dans l'architecture, il ne faut pas oublier d'activer le module de type livedata_module_sla_provider dans la configuration de chacune d'elles.

# CFG_FORMAT_VERSION 1 ( SHINKEN : DON'T TOUCH THIS LINE )

#================================================================================
# livedata_module_sla_provider
#================================================================================
# Modules that can load this module:
# - broker-module-livedata (to add new route to this module)
# This module is an API providing information on SLA of monitored elements
#================================================================================

define module {

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    MODULE IDENTITY    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Module name [ Must be unique ]                                           livedata-module-sla-provider

    # ─── Module type [ Do not edit ]                                                         [ MANDATORY ] ───
    # ───                                                                                                   ───
    module_type                                         livedata_module_sla_provider

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────    DATABASE CONNECTION    ──────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─────────────────  MongoDB parameters  ────────────────────────────────────────────────────────────────── 

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                [ MANDATORY ] ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/                                          ───
    #                                                     ───
    module_name                                         livedata-module-sla-provider

    # ───
 Module type [ Do not edit #]           Default : mongodb://localhost/?w=1&fsync=false                                             [ MANDATORY ] ───
    #   ───                                                                                                    ───
    # livedata_module_sla_provider__database__uritype         mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains sla data                      livedata_module_sla_provider

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────    DATABASE CONNECTION    ──────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─────────────────  MongoDB parameters       ─────────────────────────────────────────────────────────────────── #

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                   ───
    #    ─── https://docs.mongodb.com/manual/reference/connection-string/                                      ───
    #     ───
    #           Default : shinken                                                                           ───
    #  ───
    #           Default : mongodb://localhost/?w=1&fsync=false                                              ───
    #   ───                               ───
    # livedata_module_sla_provider__database__name        shinken

    # ─── SSH tunnel activation to secure your mongodb connection                                           ───
    # ─── That will allow all mongodb to be encrypted & authenticated with SSH          broker__module_livedata__module_sla_provider__database__uri mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains sla data                    ───
    #                                          ───
    #                                                         ───
    #           Default : 0 => Disable ( disable ssh tunnel )                      ───
    #           Default :    shinken     ───
    #           ...     : 1 => Enable  ( enable ssh tunnel )                                                ───
    #  ───                                                                                                     ───
    # broker__module_livedata__module_sla_provider__usedatabase_ssh_tunnel        0name shinken

    # ─── SSH userusername/password to connectauthenticate to theMongoDB. mongodb server.                                                   ───
    # ───
 Both parameters must #be provided for authentication to function correctly.                        ───
    # ───                                                                    ───
    #           Default : shinken              ───
    # broker__module_livedata__module_sla_provider__database__username

    # ───                                                   ───
    #                                            ───
    # broker__module_livedata__module_sla_provider__database__password

    # ─── SSH tunnel activation to secure your mongodb connection                                           ───
    # livedata_module_sla_provider__ssh_user              shinken
─── That will allow all mongodb to be encrypted & authenticated with SSH                              ───
    #   ───    SSH keyfile to connect to the mongodb server.                                                     ───
    #                                ───
    #           Default : 0 => Disable ( disable ssh tunnel )                                               ───
    #           Default : ~shinken/.ssh/id_rsa...     : 1 => Enable  ( enable ssh tunnel )                                                ───
    #    ───                                                                                                   ───
    # broker__module_livedata__module_sla_provider__use_ssh_keyfiletunnel 0

    # ─── SSH user to connect  ~shinken/.ssh/id_rsa

to the mongodb server.              # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
    #                                                                                                       ───
    #           Default : 10shinken     ( seconds )                                                                    ───
    #    ───                                                                                                   ───
    # broker__module_livedata__module_sla_provider__ssh_tunnel_timeout    10user shinken

    # ───────────────── SSH AutoReconnectkeyfile Managementto connect ───────────────────────────────────────────────────────────────to 

the mongodb server.  # ─── 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 : ~shinken/.ssh/id_rsa                                                              ───
    # ───          Default : 4 ( number of try )                                                               ───
    #               ───
    # broker__module_livedata__module_sla_provider__ssh_keyfile ~shinken/.ssh/id_rsa

    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
    #                                ───
    # livedata_module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4

    # ─── Time between each try                                                        ───
    #           Default : 10 ( seconds ) ───
    #                                                               ───
    # ───                                   ───
    #           Default : 3 ( seconds )                                            ───
    # broker__module_livedata__module_sla_provider__ssh_tunnel_timeout 10

    # ──────────────  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                                    ───
    # livedata_module_sla_provider__database__wait_X_seconds_before_reconnect 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          Default : 4 ( number of try )                                                               ───
    # ───       retry_connection_X_times_before_considering_an_error * wait_X_seconds_before_reconnect      ───
    # ───       must be higher than heartbeatTimeoutSecs in the rs.conf(); of your MongoDB replica set.              ───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    SLA CALCULATION    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── No_data periods ( "Missing data" and "Shinken inactive" status )                                  ───
    #    broker__module_livedata__module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4

    # ─── Time between each try                                                                             ───
    #         ───
    #           Default : include => Only status is considered. "Missing data" and "Shinken inactive"       ───
    #                                status are counted negatively in the SLA.                  ───
    #        ───
   Default #: 3 ( seconds )       ...     : exclude => No_data are not counted from SLA considered period.                    ───
    #           ...     : ok      => No_data are considered as UP periods.───
    # ───                                     ───
    #                                                          ───
    # broker__module_livedata__module_sla_provider__database__wait_X_seconds_before_reconnect 3

    # ─── NOTE: Change these values only if you have a MongoDB cluster and you change the                   ───
    # livedata_module_sla_provider__no_data_period  ───       heartbeatTimeoutSecs of your MongoDB replica set       include

}

    # ─────────────────  MongoDB parameters  ──────────────────────────────────────────────────────────────── #

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                   ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/                                      ───
    #                                                                                                       ───
    #           Default : mongodb://localhost/?w=1&fsync=false                                              ───
    # ───                                                                                                   ───
    # broker__module_livedata__module_sla_provider__database__uri mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains sla data                

	# ──────────────  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 ( number of try )                                                               ───
    #                                                                                                       ───
    # broker__module_livedata__module_sla_provider__database__retry_connection_X_times_before_considering_an_error 4
 
    # ─── Time between each try                                                                             ───
    #                                                                                                       ───
    #           Default : 3 ( seconds )                                                                     ───
    #                                                                                                       ───
    # broker__module_livedata__module_sla_provider__database__wait_X_seconds_before_reconnect 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                                                                                ───
    # ───       retry_connection_X_times_before_considering_an_error * wait_X_seconds_before_reconnect      ───
    # ───       must be higher than heartbeatTimeoutSecs in the rs.conf(); of your MongoDB replica set.     ───