Page History

define scheduler {
    [...]
    modules                   MongodbRetention
    [...]
}

service shinken-arbiter restart

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


define module {

    # Shinken Enterprise. Lines added by import core. Do not remove it, it's used by Shinken Enterprise to update your objects if you re-import them.
    _SE_UUID     ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ──────────────────────────────────────    MODULE IDENTITY    ────────────────────────────────────── │ #
    # └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # ─── Module name [ Must be unique ]        core-module-d98ab73a5adb11e5a2df080027f08538
    _SE_UUID_HASH        c8c8f39897b928ee624da45934b38fd9
# End of Shinken Enterprise part

    #======== Module identity =========
    # Module name. Must be unique
    module_name     MongodbRetention

    #[ ModuleMANDATORY type] (to───
 load module code). Do# not─── edit.
    module_type     mongodb_retention


    #======== Mongodb connection =========

    # uri: to connect the mongodb server
    uri                     mongodb://localhost/?safe=false

    #======== IMPORTANT =============
    # Note that if the parameter "use_ssh_tunnel" is set to 1,
    #  the mongodb connection will be launched through a SSH tunnel
    #  opened from the scheduler server to the mongodb server.───
    #module_name It will automatically parse the URI parameter to get the distant server
    #  and will create a SSH tunnel by using either the user defined by the "ssh_user" property
    #  or the shinken user.MongodbRetention

    # The─── Module SSHtype key[ usedDo fornot thisedit is] the one that is automatically generated
    #  at the installation or the key defined by the parameter "ssh_keyfile".
      # You can deploy it by launching on the scheduler server:
    #   ssh-copy-id -i ~shinken/.ssh/id_rsa.pub shinken@MONGODB-SERVER

    # If you want to secure your[ mongodbMANDATORY connection] you───
 can enable the ssh use_ssh_tunnel that will
# ───      # allow all mongodb to be encrypted & authenticated with SSH
    # Should use a SSH tunnel (Default 0=False)
    # use_ssh_tunnel          0

    # If the SSH connection goes wrong, then retry use_ssh_retry_failure time
    # Default: 1
    # use_ssh_retry_failure   1

    # SSH user/keyfile in order to connect to the mongodb server.
    # Default: shinken
    # ssh_user     ───
    module_type       shinken

    # Default: ~shinken/.ssh/id_rsa
    # ssh_keyfile             ~shinken/.ssh/id_rsa

    # Timeout used to test if themongodb_retention

 SSH tunnel is viable# or┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ not#
    # │ ────────────────────────────────────  Default: 2
 DATABASE CONNECTION  # ssh_tunnel_timeout ──────────────────────────────────── │ #
    # 2└─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #

    # Timeout───────────────── for readingMongoDB 5000parameters item in──────────────────────────────────────────────────────────────── second#

    # Default─── valueMongoDB :uri 10s
definition . You can #find mongo_timeoutthe mongodb 10

uri syntax at  # Number of retry if mongo is not accessible
    # Default value : 3
    # mongo_max_connections_retry    3
    # Delay before next retry───
    # Default value : 1s
 ─── https://docs.mongodb.com/manual/reference/connection-string/          # mongo_wait_before_retry 1


    # database: which mongodb database to use
    database        shinken
    ───
    # Advanced option if you are running a cluster mongodb environment
    # replica_set

    # Retention SAVE:
    # 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
    # worker_timeout   120───

    # Worker try timeout: Time for a one try data save. If one worker process still runs after
Default : mongodb://localhost/?w=1&fsync=false             # 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
    # 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 (by default 4)
           # max_number_of_workers   4


    #======== Memory protection =========
    # Are the module worker process are waiting for enough
    # memory to be available before being launch. Default: 1 (enabled)───
    # scheduler_mongodb_retention_mongo_database_enable_sub_processes_memory_usage_protection_uri   1

    # The sub process memory usage protection can have a system reserved memory
    # that won't be used by theses sub process when launched
    # By 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
    # By 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. By default it is 7 days ==
    #nb_of_max_retention_day	    7
    # == maximum number of elements load in one bulk pass ==
    #size_chunk_to_load	        1000
    # == maximum number of elements delete in one bulk pass ==
    #size_chunk_to_delete	 mongodb://localhost/?w=1&fsync=false

    # ─── Which database contains events data                                                               ───
    #                                                                                                       ───
    #           Default : shinken                               1000
}                                                                                        ───
    

 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.             ───

    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ───────────────────────────────────    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 bulk pass.                                                 ───
    #                                                                                                       ───
    #           Default : 1000                                                                              ───
    #                                                                                                       ───
    # size_chunk_to_load                                  1000

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

}

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