Page History

service shinken-arbiter restart

define scheduler {
    [...]
    modules                   Module 1, Module 2, Module 3, MongodbRetention
    [...]
}

service shinken-arbiter restart

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

#================================================================================
# MongodbRetention
#================================================================================
# Daemons that can load this module:
#  - Scheduler
# This module save scheduler retention data (element state and scheduling)
# into a mongodb server
#================================================================================

define module {

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

    # ─── Module name [ Must be unique ]                                                      [ MANDATORY ] ───
    # ───                                                                                                   ───
    module_name                                         MongodbRetention

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

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

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

    # ─── MongoDB uri definition . You can find the mongodb uri syntax at                                   ───
    # ─── https://docs.mongodb.com/manual/reference/connection-string/                                      ───
    #                                                                       

Il est conseillé de n'avoir plusieurs modules de rétention que dans le cas d'une migration.

Exemple : passage d'une base de données base1 à une base2, on aura un module MongodbRetention avec la base1, un autre avec la base2, on désactivera alors le premier module pour le prochain redémarrage.

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

    # ─────────────────  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                                              ───
    # ───                                                                                                   ───
    # mongodb_retention__database__uri                    mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains retention data                                                            ───
    #                                                                                                       ───
    #           Default : shinken                                                                           ───
    # ───                                                                                                   ───
    # mongodb_retention__database__name                   shinken   

    # ─── username/password to authenticate to MongoDB.                                            			───
    # ─── Both parameters must be provided for authentication to function correctly.                        ───
    # ───                                                                                                   ───
    # scheduler__module_mongodb_retention__database__username

    # ───                                                                                                   ───
    # scheduler__module_mongodb_retention__database__password 

    # ─── Allow localhost MongoDB uri.                                                                      ───
    # ─── By security, the localhost URI is banned as it is a configuration error if you have multiple      ───
    # ─── Schedulers in the same realm ( all Schedulers must save retention in the same database ).         ───
    # ─── But in case, your retentions are using a MongoDB cluster,                                         ───
    # ─── activate this option to bypass the security ( targeting the local mongos )                        ───
    #                                                                                                       ───
    #           ...     : Enable  => 1 ( allow localhost mongo uri )                                        ───
    #           Default : Disable => 0 ( localhost will be forbidden if there are multiple Schedulers )     ───
    # ───                                                                                                   ───
    # mongodb_retention__database__bypass_banning_localhost_uri 0

    # ─── SSH tunnel activation to secure your mongodb connection                                           ───
    # ─── That will allow all mongodb to be encrypted & authenticated with SSH                              ───
    #                                                                                                       ───
    #           ...     : Enable  => 1 ( enable ssh tunnel )                                                ───
    #           Default : Disable => 0 ( disable ssh tunnel )                                               ───
    #                                                                                                       ───
    # mongodb_retention__database__use_ssh_tunnel         0

    # ─── If the SSH connection goes wrong, then retry use_ssh_retry_failure time before_shinken_inactive   ───
    #                                                                                                       ───
    #           Default : 1 ( try )                                                                         ───
    #                                                                                                       ───
    # mongodb_retention__database__use_ssh_retry_failure  1

    # ─── SSH user to connect to the mongodb server.                                                        ───
    #                                                                                                       ───
    #           Default : shinken                                                                           ───
    #                                                                                                       ───
    # mongodb_retention__database__ssh_user               shinken

    # ─── SSH keyfile to connect to the mongodb server.                                                     ───
    #                                                                                                       ───
    #           Default : ~shinken/.ssh/id_rsa                                                              ───
    #                                                                                                       ───
    # mongodb_retention__database__ssh_keyfile            ~shinken/.ssh/id_rsa

    # ─── SSH Timeout used to test if the SSH tunnel is viable or not, in seconds.                          ───
    #                                                                                                       ───
    #           Default : 10 ( seconds )                                                                    ───
    #                                                                                                       ───
    # mongodb_retention__database__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                                               ───
    #                                                                                                       ───
    #           Default : 5 ( try )                                                                         ───
    #                                                                                                       ───
    # mongodb_retention__database__retry_connection_X_times_before_considering_an_error 5

    # ─── Time between each try                                                                             ───
    #                                                                                                       ───
    #           Default : 5 ( seconds )                                                                     ───
    #                                                                                                       ───
    # mongodb_retention__database__wait_X_seconds_before_reconnect 5

    # ─── NOTE: Change these values only if you have a MongoDB cluster and you change the                   ───
    # ───       heartbeatTimeoutSecs of your MongoDB replica set                                            ───
    # ───       The value of mongodb_retention__database__wait_X_seconds_before_reconnect *                 ───
    # ───       mongodb_retention__database__retry_connection_X_times_before_considering_an_error must be   ───
    # ───       higher than heartbeatTimeoutSecs in the rs.conf(); of your MongoDB replica set.             ───

Primaire : nom de MongoDB pour désigner un serveur maître, le serveur sur lequel il est possible de faire des requêtes d'écriture dans la base. 

Élection : processus de MongoDB pour choisir un nouveau membre Primaire si le membre Primaire devient inaccessible 

Voir la page Haute disponibilité de la base MongoDB (mise en place d'un cluster)

Il est conseillé de ne pas modifier ces valeurs.

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────    WORKER CONFIGURATION    ──────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── The retention save will spawn process workers (max to 4) and such process can fail (timeout)      ───
    # ───                                                                                                   ───
    # ─── Worker timeout: Global time for your workers to work. If a worker still runs after worker_timeout ───
    # ─── seconds (and so numerous try)), then it will be killed and the error will be raised               ───
    # ─── into your monitoring                                                                              ───
    #                                                                                                       ───
    #           Default : 120 ( seconds )                                                                   ───
    #                                                                                                       ───
    # worker_timeout                                      120

    # ─── Worker try timeout: Time for a one try data save. If one worker process still runs after          ───
    # ─── worker_one_try_timeout seconds, it will be killed and a new worker process will be spawn          ───
    # ─── to replace it                                                                                     ───
    # ─── NOTE: it must be lower than the worker_timeout                                                    ───
    #                                                                                                       ───
    #           Default : 30 ( seconds )                                                                    ───
    #                                                                                                       ───
    # worker_one_try_timeout                              30

    # ─── Max number of workers: if you want to limit the number of workers launched, you can change        ───
    # ─── this parameter.By default the number of workers will be the number of CPUs                        ───
    # ─── but no more than max_number_of_workers                                                            ───
    #                                                                                                       ───
    #           Default : 4 ( workers )                                                                     ───
    #                                                                                                       ───
    # max_number_of_workers                               4

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────    MEMORY PROTECTION    ───────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Are the module worker process are waiting for enough memory to be available before being launch.  ───
    #                                                                                                       ───
    #           ...     : 0 ( Disable )                                                                     ───
    #           Default : 1 ( Enable )                                                                      ───
    #                                                                                                       ───
    # scheduler__retention_mongo__enable_sub_processes_memory_usage_protection 1

    # ─── The sub process memory usage protection can have a system reserved memory that won't be used by   ───
    # ─── theses sub process when launched                                                                  ───
    #                                                                                                       ───
    #           Default : 0 ( no reserved memory )                                                          ───
    # ───       Example : 10  (means 10% of the total memory is reserved for the system)                    ───
    #                                                                                                       ───
    # scheduler__retention_mongo__sub_process_memory_usage_system_reserved_memory 0

    # ─── If a sub process cannot be started because of the protection, how many seconds it will be retry   ───
    # ─── and wait that the system memory is freed until it fail to start                                   ───
    #                                                                                                       ───
    #           Default : 5 ( seconds )                                                                     ───
    #                                                                                                       ───
    # scheduler__retention_mongo__sub_processes_memory_usage_protection_max_retry_time 5

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ─────────────────────────────────────    INTERNAL OPTIONS    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ───       /!\ INTERNAL : DO NOT EDIT FOLLOWING PARAMETER WITHOUT YOUR DEDICATED SUPPORT               ───
    # ───                                                                                                   ───
    # ─── Number of day we conserve retention data, after this time, we will delete data.                   ───
    #                                                                                                       ───
    #           Default : 7 ( days )                                                                        ───
    # ───                                                                                                   ───
    # nb_of_max_retention_day                             7

    # ─── Maximum number of elements load in one chunk pass.                                                ───
    #                                                                                                       ───
    #           Default : 1000                                                                              ───
    # ───                                                                                                   ───
    # size_chunk_to_load                                  1000

    # ─── Maximum number of elements delete in one chunk pass.                                              ───
    #                                                                                                       ───
    #           Default : 1000                                                                              ───
    # ───                                                                                                   ───
    # size_chunk_to_delete                                1000

    # ─── Timeout for the execution of each chunk retention request.                                        ───
    #                                                                                                       ───
    #           Default : 300                                                                               ───
    # ───                                                                                                   ───
    # scheduler__retention_mongo__load_retention_chunk_timeout 300

    # ─── Elements whose serialized size exceeds this threshold will generate a warning                     ───
    #                                                                                                       ───
    #           Default : 10000 ( Kilobytes )                                                               ───
    # ───                                                                                                   ───
    # scheduler__retention_mongo__oversized_element_warning_threshold__size 10000

    # ─── Elements whose serialized size exceeds this threshold will generate an error                      ───
    #                                                                                                       ───
    #           Default : 16000 ( Kilobytes )                                                               ───
    # ───                                                                                                   ───
    # scheduler__retention_mongo__oversized_element_error_threshold__size 16000 

Cette partie ne doit pas être modifiée sans le support.