Description

Les collecteurs sont des sources qui permettent de collecter des informations depuis plusieurs origines.

Ces collecteurs peuvent être importés automatiquement à intervalles définis, ou bien manuellement.

Il existe plusieurs modules collecteurs disponibles par défaut :

  • cfg-file-import : Ce collecteur importe des définitions d'éléments Shinken à partir de fichiers .cfg
  • ldap-import : La source d'import ldap permet d'importer des données d'un service Active Directory ou OpenLDAP ( selon son paramétrage ).
  • synchronizer_collector_vmware : Cette source collecte les données d'un vCenter VMware ou d'un ESX VMware.
  • discovery : La source discovery scanne le réseau avec nmap afin de détecter des éléments et de collecter leurs données associées.

Ajouter de Collecteur

Les fichiers des collecteurs sont définis dans le dossier /etc/shinken/sources/.

Il doit y avoir un fichier cfg par source.



HIDE_UNTIL_001.0_V02_08_02

#===============================================================================
# Daemons that can load this source:
# - synchronizer
#===============================================================================
 
define source {
    source_name                 collector_name
    enabled                     0
    order                       19
    module_type                 collector_module_type
 
    description                 This source is about loading the default Shinken Enterprise packs
 
    # The list of properties to be used as sync_keys in addition to the item name. Properties not managed by Shinken can be added here.
    # properties_used_as_synckey        address
 
    # Properties which can be defined in the items from the source but which Shinken will not import.
    # not_stored_properties  

    # synchronizer__collector__import_scheduling_mode: Decide the way to automatically import sources.
    # There is currently three modes of automatic import : manual, interval, hours
    # - manual   : (default) Disable the automatic import. Can only import manually.
    # - interval : Imports the sources each X minutes where X is the value of synchronizer__collector__import_scheduling_mode_definition
    # - hours    : Imports the sources at a given list of hours. The list of hours is the value of the key synchronizer__collector__import_scheduling_mode_definition
    #              The list should contains only values like this : XX:YY where XX is the hour and YY the minutes. Both MUST be 2 digits long, 08:05 is correct and 1:2 is not.
    #              Example of valid list: 12:30, 20:20, 05:01
    synchronizer__collector__import_scheduling_mode                 interval
 
    # synchronizer__collector__import_scheduling_mode_definition: Definition of the automatic import mode. Its value depends on the
    # synchronizer__collector__import_scheduling_mode key described above.
    synchronizer__collector__import_scheduling_mode_definition      5
}   



#===============================================================================
# Daemons that can load this source:
# - synchronizer
#===============================================================================

define source {
    source_name		            collector_name
    enabled                     0
    order		                19
    import_interval	            5
    module_type     	        collector_module_type

    description		            This source is about loading the default Shinken Enterprise packs

    # The list of properties to be used as sync_keys in addition to the item name. Properties not managed by Shinken can be added here.
    # properties_used_as_synckey        address

    # Properties which can be defined in the items from the source but which Shinken will not import.
    # not_stored_properties
} 


Détails des sections composants le fichier de configuration

Identification du module de source

Chaque collecteur possède sa propre identité, celle-ci est définie par les paramètres suivants :



NomTypeDéfautCommentaire


source_name


Texte

Chaîne de caractères composée de lettres, de chiffres et des caractères _  et -

  • Doit être unique 
  • Doit commencer par une lettre.
  • D'une longueur maximum à 40 caractères
  • Ne doit pas contenir le caractère "$"


module_type 


Texte
Correspond au type de module collecteur de la source ( permet au Synchronizer de charger le code logiciel correspondant ).


Intervalle d'import et ordre de la source


HIDE_UNTIL_001.0_V02_08_02

NomTypeDéfautCommentaire


order


Nombre10

L'ordre de la source dans l'interface de configuration ( A un impact dans la fusion des données lors des imports de sources ).

  • Un nombre
  • Voir la page du Synchronizer pour plus d'information au sujet des fusions. 

Remarque : Si vous changez l'ordre depuis l'interface ( page d’accueil ), le fichier .cfg sera mis à jour.


synchronizer__collector__import_scheduling_mode


Textemanual

Ce paramètre désigne le mode d'import automatique de la source.

Il peut avoir les valeurs suivantes :





NomDescription
manualL'import ne se fera que manuellement
intervalL'import se fera automatiquement à l'intervalle désigné dans le paramètre synchronizer__collector__import_scheduling_mode_definition
hoursL'import se fera chaque jour à une (ou plusieurs) heure précisée(s) dans le paramètre synchronizer__collector__import_scheduling_mode_definition



synchronizer__collector__import_scheduling_mode_definition


Texte5

Ce paramètre défini le moment où l'import automatique sera fait. Sa valeur déprendra du paramètre synchronizer__collector__import_scheduling_mode :

  • interval : Un entier représentant le nombre de minutes entre chaque import automatique.
  • hours : Une liste d'heures au format HH:MM ( format 24h ). L'ordre des heures n'importe pas.
    • Exemple : 08:00, 12:30, 23:05







NomTypeDéfautCommentaire


import_interval


Nombre0

Délai écoulé entre les imports automatiques de la source.
Si 0, l'import de la source ne sera jamais exécuté automatiquement.


order


Nombre10

L'ordre de la source dans l'interface de configuration ( A un impact dans la fusion des données lors des imports de sources ).

  • Un nombre
  • Voir la page du Synchronizer pour plus d'information au sujet des fusions. 

Remarque : Si vous changez l'ordre depuis l'interface ( page d’accueil ), le fichier .cfg sera mis à jour.


Propriétés des éléments Shinken collectés


NomTypeDéfautCommentaire


properties_used_as_synckey


Texteaddress

Défini la liste de propriétés Shinken qui seront utilisées en plus du nom et du SE_UUID de l'élément pour générer les clés de synchronisation (sync_key).

Ce paramètre est optionnel. Si ce paramètre n'est pas présent, sa valeur par défaut vaut "address".


not_stored_properties


Texte

Ce paramètre permet de définir une ou plusieurs propriétés des éléments qui ne seront pas importés dans Shinken. Cela peut être utile pour exclure un paramètre ou bien utiliser des paramètres personnalisés utiles pour la gestion de vos fichiers .cfg