Documentation ServicePilot

Agents

Qu'est-ce qu'un Agent ServicePilot

Les agents ServicePilot sont conçus pour collecter des données de surveillance de différentes sources et les envoyer à ServicePilot. Les agents ServicePilot ne nécessitent qu'une configuration succinte. Tout ce dont ils ont besoin, c'est d'un accès web à ServicePilot et d'une Clé API pour sécuriser la communication. Toute autre configuration se fait via l'interface web de ServicePilot.

Capacités de collectes de l'Agent ServicePilot

Chaque agent ServicePilot possède des capacités de collectes différentes. Pour voir ce que ces Agents Enterprise peuvent faire, consultez la page Agent Details :

  1. En utilisant un compte avec des privilèges administrateurs, accédez à ServicePilot.
  2. Allez dans Paramètres Settings icon
  3. Cliquez sur Agents > Installer Agents Install icon
  4. Cliquez sur le bouton Agent Details Agent Details button

Agents Enterprise de ServicePilot

Les Agents Enterprise collectent des données directement sur les serveurs où ils sont installés, ou sur d'autres équipements (ils agissent alors comme des relais vers ServicePilot). Ces agents peuvent aussi recevoir des données d'événements non sollicités s'ils sont configurés pour le faire.

L'Agent Windows de ServicePilot a été compilé avec les versions .NET 3.5, 4.0 et 4.5. Choisissez l'agent avec la version la plus récente de .NET supportée par votre système d'exploitation car cela vous offrira plus de possibilités de collectes.

L'Agent Linux de ServicePilot a été compilé pour les distributions x86 et x64 sur RedHat et Debian ainsi que pour Raspbian ARM.

Si plus de capacités de collectes sont requises sur les systèmes d'exploitation Linux ou MacOS, un agent .NET Core de ServicePilot peut être installé après l'installation du pré-requis du .NET Core.

Agent Endpoint de ServicePilot

L'Agent Endpoint de ServicePilot est conçu pour collecter l'inventaire matériel et logiciel des postes de travail Windows.

Agents Developer de ServicePilot

Des données statistiques sur le nombre et le type d'appels Web effectués dans les applications Puppeteer, JavaScript dans les navigateurs Web et Node.js peuvent être collectées. Ces intégrations nécessitent d'instrumenter le code en question pour envoyer les détails des appels à ServicePilot.

Intégration de l'agent Open Source

L'Agent Windows de ServicePilot peut agir comme une passerelle vers un certain nombre d'agents open source, fournissant ainsi à ServicePilot les données collectées par ces agents.

Status Monitor de ServicePilot

Le Status Monitor de ServicePilot n'est pas un agent utilisé pour collecter des données. Il s'agit d'une extension de l'interface web de ServicePilot permettant aux utilisateurs de ServicePilot de voir le nombre actuel d'éléments avec des alertes sur le bureau de Windows.

Le Status Monitor de ServicePilot peut être téléchargé depuis le menu Utilisateur.

Télécharger les agents de ServicePilot

  1. En utilisant un compte avec des privilèges administrateurs, accédez à ServicePilot.
  2. Allez dans Paramètres Settings icon
  3. Cliquez sur Agents > Installer Agents Install icon
  4. Sélectionnez l'Agent à installer et suivez les instructions sous Commencer Get started button

Obtenir une clé API de ServicePilot

Les agents ServicePilot communiquent avec ServicePilot à l'aide d'une Clé API. Plusieurs clés API peuvent être créées et utilisées, mais chaque agent doit être configuré avec une clé API valide avec droit d'écriture. Pour voir les clés API qui peuvent être utilisées, accédez à la page Clés :

  1. En utilisant un compte avec des privilèges administrateurs, accédez à ServicePilot.
  2. Allez dans Paramètres Settings icon
  3. Cliquez sur Agents > Clés Agents Keys icon
  4. Récupérez une clé API avec autorisation Read/Write Key list

Installer un agent Windows de ServicePilot

Après avoir téléchargé l'agent ServicePilot, double-cliquez sur le fichier pour exécuter le programme d'installation. A la fin de l'installation, la console de configuration de ServicePilot s'ouvre. Définissez les paramètres pour que l'agent ServicePilot puisse communiquer avec ServicePilot, puis démarrez l'agent. La console peut être fermée une fois que l'agent communique correctement avec ServicePilot.

Paramètre Description
Clé API Une clé API autorisée en écriture telle qu'elle se trouve dans la liste des clés API listées ci-dessus.
Remote Command Ne pas activer ce paramètre à moins qu'une ressource surveillée le nécessite. Les descriptions des packages indiqueront quand ceci est nécessaire.

Windows Agent parameters 1

Paramètre Description
Use proxy Si l'accès à ServicePilot nécessite un proxy Web, activez cette option et remplissez les champs Address et Port.
Address Spécifiez l'adresse IP du proxy
Port Spécifiez le port du proxy
Username Spécifiez un nom d'utilisateur pour autoriser l'accès par proxy, si nécessaire.
Password Spécifiez un mot de passe pour permettre l'accès par proxy, si nécessaire.

Windows Agent parameters 2

Installer un agent Linux de ServicePilot

Après avoir téléchargé l'agent ServicePilot, vérifiez que le fichier est exécutable puis lancez-le en tant que root. A la fin de l'installation, le script demandera une clé API. Définissez les paramètres pour que l'agent ServicePilot puisse communiquer avec ServicePilot. Vous pouvez arrêter et démarrer le service spagent en utilisant les commandes standards de votre distribution Linux.

# chmod +x servicepilotlinuxagent.run
# ./servicepilotlinuxagent.run

Creating directory _agent_files
Verifying archive integrity...  100%   All good.
Uncompressing ServicePilot Linux Agent Package  100%
This is RedHat based distro
64 Bit
Enter API KEY

10000000-0000-0000-0000-000000000000

Run in debug mode? [default: n]

n

Enter ServicePilot Agent Log Path [default: '/var/log/']

/var/log/

SP Agent Started.
LinuxAgent started

#

Installer un agent .NET Core de ServicePilot

Avant d'installer un agent .NET Core, assurez-vous que le runtime .NET Core est installé. Suivez la documentation d'installation de Microsoft et vérifiez l'installation en exécutant la commande suivante en tant qu'utilisateur root.

# dotnet --list-runtimes

Après avoir téléchargé l'agent ServicePilot, vérifiez que le fichier est exécutable et devient root pour pouvoir exécuter l'archive auto-extractible. A la fin de l'installation, le script demandera une clé API. Définissez les paramètres pour que l'agent ServicePilot puisse communiquer avec ServicePilot. Vous pouvez arrêter et démarrer le service DotnetCoreAgent en utilisant les commandes standards de votre distribution Linux.

# chmod +x servicepilotdotnetagent.run
# ./servicepilotdotnetagent.run

Creating directory _agent_files
Verifying archive integrity...  100%   All good.
Uncompressing ServicePilot .NEt Core Agent Package  100%
dotnet version 3.0.0 [/usr/share/dotnet/shared/Microsoft.NETCore.App] installed.  Proceeding with installation of agent..
Enter API KEY

10000000-0000-0000-0000-000000000000

Run in debug mode? [default: n]

n

Enter ServicePilot Agent Log Path [default: '/var/log/']

/var/log/

This is RedHat based distro
DotnetCoreAgent Started.
DotnetCoreAgent started

#

Vérifiez si un agent ServicePilot fonctionne

Pour vous assurer que les agents ServicePilot communiquent correctement avec ServicePilot, ouvrez la page Agents :

  1. En utilisant un compte avec des privilèges administrateurs, accédez à ServicePilot.
  2. Allez dans Paramètres Settings icon
  3. Cliquez sur Agents > Agents Agents Agents icon

L'agent doit apparaître dans la liste avec un statut jaune ou vert et une valeur Vu il y a de quelques secondes. Un statut jaune indique que l'agent n'a encore rien reçu à faire.

Logs des agents ServicePilot

Les logs des agents ServicePilot journalisent les erreurs de connectivité entre l'agent ServicePilot et ServicePilot, et les problèmes de récupération des données depuis les équipements. Ces logs sont particulièrement intéressants si la surveillance ne semble pas fonctionner entre l'agent et les équipements distants en raison de mauvaises informations d'accès (par exemple).

Ouvrez les logs des agents avec un éditeur de texte :

Logs de l'agent Windows

C:\Program Files (x86)\ServicePilot\ServicePilot ISM Enterprise\Logs\ServicePilotAgent.log

Logs de l'agent Linux

/var/log/spagent.log

Logs de l'agent .NET Core

/var/log/ServicePilotAgent.log

Désinstaller un agent ServicePilot

Si un agent ServicePilot n'est plus utilisé, il peut être désinstallé.

Vérifier si un agent est en cours d'utilisation

  1. En utilisant un compte avec des privilèges administrateurs, accédez à ServicePilot.
  2. Allez dans Paramètres Settings icon
  3. Cliquez sur Agents > Agents Agents Agents icon

Si un agent n'est pas utilisé, le statut sera jaune, ce qui signifie qu'il n'est pas configuré. Si l'agent est toujours en utilisation, en cliquant sur la loupe bleue, les Détails de l'agent y compris le Agent data seront affichés. Cela va lister les ressources qui utilisent actuellement cet agent.

Désinstaller un agent Windows de ServicePilot

Pour désinstaller un agent Windows de ServicePilot correctement, vérifiez qu'il est arrêté avant de le supprimer.

  1. Arrêtez le service ServicePilotAgent
  2. Fermez la ServicePilot Setup Console si elle est ouverte.
  3. Désinstallez l'agent ServicePilot à partir du panneau de configuration de Windows.
  4. Optionnel: Vous pouvez supprimer le répertoire C:\Program Files (x86)\ServicePilot si vous ne souhaitez pas conserver les logs de l'agent
  5. Optionnel: Si vous n'envisagez pas de réinstaller un agent ServicePilot sur la machine, vous pouvez supprimer la clé de registre HKEY_LOCAL_MACHINE\SOFTWARE\ServicePilot Technologies

Désinstaller un agent Linux de ServicePilot

Pour désinstaller un agent Linux de ServicePilot correctement, vérifiez qu'il est arrêté avant de le supprimer.

  1. Arrêtez le daemon spagent en utilisant les commandes standards de votre distribution Linux systemctl stop spagent ou service spagent stop
  2. Désinstallez l'agent Linux de ServicePilot en utilisant les commandes standards de votre distribution Linux rpm -e spagent ou dpkg --remove spagent
  3. Optionnel : Vous pouvez supprimer les fichiers /var/log/spagent* si vous ne souhaitez pas conserver les logs de l'agent.
  4. Optionnel : Si vous n'envisagez pas de réinstaller un agent ServicePilot sur la machine, vous pouvez supprimer le répertoire de configuration /etc/spagent. Notez que ce répertoire est utilisé à la fois par l'agent Linux et par l'agent .NET Core.

Désinstaller un agent .NET Core de ServicePilot

Pour désinstaller un agent .NET Core de ServicePilot correctement, vérifiez qu'il est arrêté avant de le supprimer.

  1. Arrêtez le daemon DotnetCoreAgent en utilisant les commandes standards de votre distribution Linux systemctl stop DotnetCoreAgent ou service DotnetCoreAgent stop
  2. Désinstallez l'agent .NET Core ServicePilot en supprimant le répertoire d'installation. Supprimer le répertoire /usr/DotnetCoreAgent
  3. Optionnel : Vous pouvez supprimer les fichiers /var/log/ServicePilotAgent* si vous ne souhaitez pas conserver les logs de l'agent.
  4. Optionnel : Si vous n'envisagez pas de réinstaller un agent ServicePilot sur la machine, vous pouvez supprimer le répertoire de configuration /etc/spagent. Notez que ce répertoire est utilisé à la fois par l'agent Linux et par l'agent .NET Core.
  5. Optionnel : Vous pouvez désinstaller le runtime .NET Core s'il n'est pas utilisé pour un autre logiciel en suivant les instructions de Microsoft.

Supprimer les agents désinstallés de la liste des agents

Tant qu'un agent n'est pas désinstallé, sa suppression de la liste des agents n'aura pas l'effet souhaité car l'agent continuera à communiquer avec ServicePilot et réapparaitra continuellement dans la liste des agents.

  1. En utilisant un compte avec des privilèges administrateurs, accédez à ServicePilot.
  2. Allez dans Paramètres Settings icon
  3. Cliquez sur Agents > Agents Agents Agents icon
  4. Cliquez sur l'icône en forme de corbeille orange puis sur le bouton Supprimer pour supprimer un agent de la liste des agents.

Commencez Maintenant