Aller au contenu principal

XiVO VoIP Server

Dépendances du connecteur de supervision​

Les connecteurs de supervision suivants sont automatiquement installés lors de l'installation du connecteur XiVO VoIP Server depuis la page Configuration > Gestionnaire de connecteurs de supervision :

Contenu du pack​

Modèles​

Le connecteur de supervision XiVO VoIP Server apporte un modèle d'hôte :

  • App-VoIP-XiVO-custom

Le connecteur apporte les modèles de service suivants (classés selon le modèle d'hôte auquel ils sont rattachés) :

AliasModèle de serviceDescription
XiVO-process-nginxApp-VoIP-XiVO-Process-nginx-customContrôle permettant de vérifier le fonctionnement du processus nginx
XiVO-process-postgresApp-VoIP-XiVO-Process-postgres-customContrôle permettant de vérifier le fonctionnement du processus postgres
XiVO-process-xivo-agentdApp-VoIP-XiVO-Process-xivo-agentd-customContrôle permettant de vérifier le fonctionnement du processus xivo-agentd
XiVO-process-xivo-agidApp-VoIP-XiVO-Process-xivo-agid-customContrôle permettant de vérifier le fonctionnement du processus xivo-agid
XiVO-process-xivo-amidApp-VoIP-XiVO-Process-xivo-amid-customContrôle permettant de vérifier le fonctionnement du processus xivo-amid
XiVO-process-xivo-confgendApp-VoIP-XiVO-Process-xivo-confgend-customContrôle permettant de vérifier le fonctionnement du processus xivo-confgend
XiVO-process-xivo-ctidApp-VoIP-XiVO-Process-xivo-ctid-customContrôle permettant de vérifier le fonctionnement du processus xivo-ctid

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte App-VoIP-XiVO-custom est utilisé.

Métriques & statuts collectés​

Voici le tableau des services pour ce connecteur, détaillant les métriques et statuts rattachés à chaque service.

NomUnité
nbprocN/A
mem_totalB
mem_avgB
cpu_total%

Prérequis​

Configuration SNMP​

L'agent SNMP doit être activé et configuré sur l'équipement. Référez vous à la documentation officielle. Il se peut que votre équipement nécessite qu'une liste d'adresses autorisées à l'interroger soit paramétrée. Veillez à ce que les adresses des collecteurs Centreon y figurent bien.

Flux réseau​

La communication doit être possible sur le port UDP 161 depuis le collecteur Centreon vers la ressource supervisée.

Installer le connecteur de supervision​

Pack​

  1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Gestionnaire de connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :
dnf install centreon-pack-applications-voip-xivo
  1. Quel que soit le type de la licence (online ou offline), installez le connecteur XiVO VoIP Server depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.

Plugin​

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

dnf install centreon-plugin-Operatingsystems-Linux-Snmp

Utiliser le connecteur de supervision​

Utiliser un modèle d'hôte issu du connecteur​

  1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
  2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
  3. Appliquez le modèle d'hôte App-VoIP-XiVO-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
  4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.
MacroDescriptionValeur par défautObligatoire
SNMPEXTRAOPTIONSAny extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Utiliser un modèle de service issu du connecteur​

  1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
  2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.
MacroDescriptionValeur par défautObligatoire
PROCESSNAMEFilter process namenginx
PROCESSPATHFilter process path
PROCESSARGSFilter process arguments
CRITICALCritical threshold of matching processes count5:5
WARNINGWarning threshold of matching processes count
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.
  1. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

Comment puis-je tester le plugin et que signifient les options des commandes ?​

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine). Vous pouvez tester que le connecteur arrive bien à superviser une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins/centreon_linux_snmp.pl \
	--plugin=os::linux::snmp::plugin \
	--mode=processcount \
	--hostname=10.0.0.1 \
	--snmp-version='2c' \
	--snmp-community='my-snmp-community'  \
	--process-name='xivo-sysconfd' \
	--process-path='' \
	--process-args='' \
	--regexp-name \
	--regexp-path \
	--regexp-args \
	--warning='' \
	--critical='1:1'

La commande devrait retourner un message de sortie similaire à :

OK: Number of current processes running: 1 | 'nbproc'=1;;;0; 'mem_total'=63850B;;;0; 'mem_avg'=93737B;;;0; 'cpu_total'=25%;;;0;

Diagnostic des erreurs communes​

Rendez-vous sur la documentation dédiée pour le diagnostic des erreurs communes des plugins Centreon.

Modes disponibles​

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

/usr/lib/centreon/plugins/centreon_linux_snmp.pl \
	--plugin=os::linux::snmp::plugin \
	--list-mode

Le plugin apporte les modes suivants :

ModeModèle de service associé
arp [code]Non utilisé pour ce connecteur de supervision
channel-usage [code]Non utilisé pour ce connecteur de supervision
collection [code]Non utilisé pour ce connecteur de supervision
cpu [code]Non utilisé pour ce connecteur de supervision
cpu-detailed [code]Non utilisé pour ce connecteur de supervision
disk-usage [code]Non utilisé pour ce connecteur de supervision
diskio [code]Non utilisé pour ce connecteur de supervision
expected-content [code]Non utilisé pour ce connecteur de supervision
inodes [code]Non utilisé pour ce connecteur de supervision
interfaces [code]Non utilisé pour ce connecteur de supervision
json-content [code]Non utilisé pour ce connecteur de supervision
list-diskio [code]Non utilisé pour ce connecteur de supervision
list-diskspath [code]Non utilisé pour ce connecteur de supervision
list-interfaces [code]Non utilisé pour ce connecteur de supervision
list-processes [code]Non utilisé pour ce connecteur de supervision
list-storages [code]Non utilisé pour ce connecteur de supervision
load [code]Non utilisé pour ce connecteur de supervision
memory [code]Non utilisé pour ce connecteur de supervision
offset [code]Non utilisé pour ce connecteur de supervision
processcount [code]App-VoIP-XiVO-Process-nginx-custom
App-VoIP-XiVO-Process-postgres-custom
App-VoIP-XiVO-Process-xivo-agentd-custom
App-VoIP-XiVO-Process-xivo-agid-custom
App-VoIP-XiVO-Process-xivo-amid-custom
App-VoIP-XiVO-Process-xivo-call-logd-custom
App-VoIP-XiVO-Process-xivo-confd-custom
App-VoIP-XiVO-Process-xivo-confgend-custom
App-VoIP-XiVO-Process-xivo-ctid-custom
App-VoIP-XiVO-Process-xivo-dxtora-custom
App-VoIP-XiVO-Process-xivo-provd-custom
App-VoIP-XiVO-Process-xivo-sysconfd-custom
response [code]Non utilisé pour ce connecteur de supervision
response-time [code]Non utilisé pour ce connecteur de supervision
soap-content [code]Non utilisé pour ce connecteur de supervision
storage [code]Non utilisé pour ce connecteur de supervision
swap [code]Non utilisé pour ce connecteur de supervision
tcpcon [code]Non utilisé pour ce connecteur de supervision
time [code]Non utilisé pour ce connecteur de supervision
udpcon [code]Non utilisé pour ce connecteur de supervision
uptime [code]Non utilisé pour ce connecteur de supervision

Options disponibles​

Options génériques​

Les options génériques sont listées ci-dessous :

OptionDescription
--memcachedMemcached server to use (only one server).
--redis-serverRedis server to use (only one server). Syntax: address[:port]
--redis-attributeSet Redis Options (--redis-attribute="cnx_timeout=5").
--redis-dbSet Redis database index.
--failback-fileFall back on a local file if Redis connection fails.
--memexpirationTime to keep data in seconds (default: 86400).
--statefile-dirDefine the cache directory (default: '/var/lib/centreon/centplugins').
--statefile-suffixDefine a suffix to customize the statefile name (default: '').
--statefile-concat-cwdIf used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux.
--statefile-formatDefine the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default).
--statefile-keyDefine the key to encrypt/decrypt the cache.
--statefile-cipherDefine the cipher algorithm to encrypt the cache (default: 'AES').
--process-statusFilter process status. Can be a regexp. (default: 'running|runnable').
--process-nameFilter process name.
--regexp-nameAllows to use regexp to filter process name (with option --process-name).
--process-pathFilter process path.
--regexp-pathAllows to use regexp to filter process path (with option --process-path).
--process-argsFilter process arguments.
--regexp-argsAllows to use regexp to filter process arguments (with option --process-args).
--warningWarning threshold of matching processes count.
--criticalCritical threshold of matching processes count.
--memoryCheck memory usage.
--warning-mem-eachWarning threshold of memory used by each matching processes (in Bytes).
--critical-mem-eachCritical threshold of memory used by each matching processes (in Bytes).
--warning-mem-totalWarning threshold of total memory used by matching processes (in Bytes).
--critical-mem-totalCritical threshold of total memory used by matching processes (in Bytes).
--warning-mem-avgWarning threshold of average memory used by matching processes (in Bytes).
--critical-mem-avgCritical threshold of average memory used by matching processes (in Bytes).
--cpuCheck CPU usage. Should be used with fix processes. If processes pid changes too much, the plugin can't compute values.
--warning-cpu-totalWarning threshold of CPU usage for all processes (in percent). CPU usage is in % of one CPU, so maximum can be 100% * number of CPU and a process can have a value greater than 100%.
--critical-cpu-totalCritical threshold of CPU usage for all processes (in percent). CPU usage is in % of one CPU, so maximum can be 100% * number of CPU and a process can have a value greater than 100%.
--topEnable top memory usage display.
--top-numNumber of processes in top memory display (default: 5).
--top-sizeMinimum memory usage to be in top memory display (default: 52428800 -> 50 MB).

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins/centreon_linux_snmp.pl \
	--plugin=os::linux::snmp::plugin \
	--mode=processcount \
	--help