Jenkins API

Contenu du Pack

Modèles

Le Pack Centreon Jenkins API apporte un modèle d'hôte :

• App-Jenkins-Api-custom

Il apporte le modèle de service suivant :

Alias	Modèle de service	Description	Défaut	Découverte
Jobs	App-Jenkins-Jobs-Api	Contrôle l'état des jobs		X

Règles de découverte

Nom de la règle	Description
App-Jenkins-Api-Job-Name	Découvre les jobs et supervise le statut

Rendez-vous sur la documentation dédiée pour en savoir plus sur la découverte automatique de services et sa planification.

Métriques & statuts collectés

Jobs

Métrique	Unité
job_name#job.score.percentage	%
job_name#job.violations.count	count

Installation

Pack de supervision

Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le pack 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 :

Alma / RHEL / Oracle Linux 8

dnf install centreon-pack-applications-jenkins

CentOS 7

yum install centreon-pack-applications-jenkins

Debian 11 & 12

apt install centreon-pack-applications-jenkins

Quel que soit le type de la licence (online ou offline), installez le Pack Jenkins API 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 pack. 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 :

Alma / RHEL / Oracle Linux 8

dnf install centreon-plugin-Applications-Jenkins

CentOS 7

yum install centreon-plugin-Applications-Jenkins

Debian 11 & 12

apt install centreon-plugin-applications-jenkins

Configuration

Hôte

• Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
• Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre serveur Jenkins.
• Appliquez le modèle d'hôte App-Jenkins-Api-custom.
• Une fois le modèle appliqué, les macros ci-dessous indiquées comme requises (Obligatoire) doivent être renseignées.

Obligatoire	Macro	Description
X	JENKINSAPIUSERNAME
X	JENKINSAPIPASSWORD
	JENKINSAPIPORT	(Défaut : '443')
	JENKINSAPIPROTO	(Défaut : 'https')
	JENKINSAPIEXTRAOPTIONS	--insecure

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) :

/usr/lib/centreon/plugins/centreon_jenkins.pl \
    --plugin=apps::jenkins::plugin \
    --mode=jobs \
    --hostname='10.0.0.1' \
    --port='443' \
    --proto='https' \
    --username='myuser' \
    --password='mytoken' \
    --filter-job-name='centreon-plugins' \
    --verbose

La commande devrait retourner un message de sortie similaire à :

OK: All jobs are ok | 'centreon-plugins-stable#job.score.percentage'=100.00%;;;0;100 'centreon-plugins-stable#job.violations.count'=0;;;0; 'centreon-plugins-testing#job.score.percentage'=100.00%;;;0;100 'centreon-plugins-testing#job.violations.count'=0;;;0; 'centreon-plugins/update-jenkinsfile-to-s3-alt-apt#job.score.percentage'=100.00%;;;0;100 'centreon-plugins/update-jenkinsfile-to-s3-alt-apt#job.violations.count'=0;;;0;
Job 'centreon-plugins-stable' score: 100.00 %, violations: 0
Job 'centreon-plugins-testing' score: 100.00 %, violations: 0
Job 'centreon-plugins/update-jenkinsfile-to-s3-alt-apt' score: 100.00 %, violations: 0

La liste de toutes les options complémentaires et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins/centreon_jenkins.pl \
    --plugin=apps::jenkins::plugin \
    --mode=jobs \
    --help

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

/usr/lib/centreon/plugins/centreon_jenkins.pl \
    --plugin=apps::jenkins::plugin \
    --list-mode

Diagnostic des erreurs communes

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