Utilisation de l'API Java pour surveiller des données

Vous pouvez définir une source de données pour qu'elle utilise l'API Java™ en vue d'interagir avec une application à exécution longue sur la plateforme Java. L'agent lance l'application au moment du démarrage et interagit régulièrement avec elle. Lorsque vous générez l'agent, Agent Builder crée le code source pour l'application. Vous devez personnaliser le code pour regrouper les données correctes. Selon le code, la source de données peut produire plusieurs jeux de données contenant une ligne, plusieurs lignes ou des données d'événement.

1. Sur la page Source de données initiale de l'agent ou Emplacement de la source de données, cliquez sur Programmes personnalisés dans la zone Catégories de données de surveillance.
2. Dans la zone Sources de données, cliquez sur Interface de programme d'application Java.
3. Cliquez sur Suivant.
4. Dans la page Informations relatives à l'interface de programme d'application Java, entrez un nom de groupe d'attributs.
5. Entrez un texte d'aide pour le groupe d'attributs.
6. Indiquez si le groupe d'attributs Génère une ligne de données unique, Peut générer plusieurs lignes de données ou Génère des événements. Ce choix affecte l'exemple d'application Java créé à la fin de l'exécution de l'assistant. Pour plus d'informations, voir Envoi de données.
7. Facultatif : Cliquez sur Avancé pour modifier les propriétés avancées du groupe d'attributs. L'option Avancé apparaît lorsque vous indiquez que le groupe d'attributs Peut générer plusieurs lignes de données ou Génère des événements.
8. Cliquez sur Suivant.
9. Sur la page Informations d'attribut, indiquez le premier attribut du groupe d'attributs. Pour plus d'informations sur la création d'attributs, voir (Création d'attributs).
10. Sélectionnez Ajouter des attributs supplémentaires et cliquez sur Suivant pour ajouter d'autres attributs à l'agent. Les références aux attributs sont incorporées dans l'exemple d'application Java qui est créé à la fin de l'exécution de l'assistant.
11. Cliquez sur Suivant.
12. Dans la page Informations globales relatives à la source de données de l'interface de programme d'application Java, entrez un nom de classe et un nom de fichier JAR.

    Le nom de classe est un nom de classe qualifié complet dont la méthode principale est appelée au démarrage de Java. L'exemple d'application Java est créé avec la méthode Java principale dans cette classe.

    Le fichier JAR est l'archive qui contient les classes Java comprenant l'application Java. Le fichier JAR est intégré à l'agent et installé avec lui.

13. Facultatif : Définissez les codes d'erreur que l'application Java peut envoyer, sur la page Informations globales relatives à la source de données de l'API Java, dans la section Codes d'erreur. Ces codes sont envoyés par l'application Java lorsqu'elle ne parvient pas à collecter des données.
    Restriction : Un code d'erreur est limité à 256 caractères. Seuls les lettres, les chiffres et les traits de soulignement ASCII sont admis. Les espaces ne sont pas autorisés.
    1. Cliquez sur Ajouter dans la section Codes d'erreur.
    2. Dans la fenêtre Définition du code d'erreur d'interface de programme d'application Java, entrez une valeur d'affichage.
    3. Entrez une valeur interne. La valeur interne doit être un entier compris entre 1 000 et 2 147 483 647.
    4. Définissez un texte de message pour chaque erreur. Vous pouvez utiliser un texte précédemment entré en le sélectionnant dans la liste. Cliquez sur OK pour revenir à la page Informations globales relatives à la source de données de l'interface de programme d'application Java.
       Le message est consigné dans le fichier journal de l'agent.
    5. Si aucun texte de message approprié n'est disponible, cliquez sur Parcourir pour définir le texte du message.
       La fenêtre (liste) Messages s'affiche. La zone de messages montre les messages définis dans l'agent. La liste reste vide jusqu'à ce que vous définissiez des messages. Vous pouvez utiliser Modifier pour modifier un message défini et Supprimer pour supprimer un ou plusieurs messages que vous avez définis.
    6. Dans la fenêtre (liste) Messages, cliquez sur Ajouter pour afficher une fenêtre Définition de message. Dans la fenêtre Définition de message, tapez le texte indiquant la signification du nouveau message et sélectionnez le type du message.
       Remarque : L'identificateur de message est automatiquement généré pour vous.
    7. Cliquez sur OK.
    8. La fenêtre (liste) Messages s'affiche avec le nouveau message. Pour vérifier le message et revenir à la page Informations globales relatives à la source de données de l'interface de programme d'application Java, cliquez sur OK.
14. Facultatif : Dans la section Fichiers supplémentaires de la page Informations globales relatives à la source de données de l'interface de programme d'application Java, vous pouvez ajouter des fichiers qui sont intégrés à l'agent et copiés sur le système d'agent au moment de l'installation de l'agent. Le fichier JAR de l'API client du fournisseur Java n'est pas répertorié ici ; il est automatiquement copié sur le système d'agent. La colonne Type de fichier décrit comment chaque fichier doit être utilisé. Trois utilisations possibles sont décrites dans le tableau suivant (Tableau 1). Cliquez sur Modifier pour modifier le fichier importé. Pour plus d'informations, voir Modification d'une définition de fichier de commandes.

    Tableau 1. Types des fichiers supplémentaires

    Type de fichier	Description
    Exécutable	Sélectionnez cette option pour inclure un fichier exécutable à l'agent. L'agent n'utilise pas ce fichier, mais il est intégré au chemin d'accès pour être utilisé par l'application Java.
    Bibliothèque	Sélectionnez cette option si vous voulez inclure une bibliothèque à l'agent. L'agent n'utilise pas ce fichier, mais il est intégré au chemin d'accès de bibliothèque pour être utilisé par l'application Java.
    Ressource Java	Sélectionnez cette option pour inclure des ressources Java à l'agent. L'agent n'utilise pas ce fichier, mais il est intégré au chemin d'accès aux classes pour être utilisé par l'application Java.

    Remarque : Lorsqu'un fichier supplémentaire de ressource Java est ajouté à Agent Builder, il est automatiquement inséré dans le chemin d'accès des classes du projet. Cet ajout permet au compilateur Java de résoudre toutes les références figurant dans le code pour les classes dans la ressource.

    Pour plus d'informations sur l'emplacement où sont installés les fichiers supplémentaires avec l'agent, voir (Nouveaux fichiers sur votre système).
15. Facultatif : Créez un filtre pour limiter les données renvoyées par ce groupe d'attributs, si les données sont échantillonnées. Créez un filtre en cliquant sur Avancé.
    Remarque : Les données sont échantillonnées si vous n'avez pas sélectionné Génère des événements sur la page Informations relatives à l'API Java.

    Pour plus d'informations sur le filtrage des données à partir d'un groupe d'attributs, voir Filtrage des groupes d'attributs.
16. Facultatif : Ajoutez des propriétés de configuration au sous-noeud.
    Si vous ajoutez cette source de données à un sous-noeud, la page Substitutions de configuration de sous-noeud apparaît et vous permet d'ajouter des propriétés de configuration à ce sous-noeud. Au moins une propriété de configuration est nécessaire sous le sous-noeud pour l'exemple d'application Java à créer, Au moins une propriété de configuration est nécessaire, car l'exemple s'en sert pour distinguer les instances de sous-noeud les unes des autres.
17. Effectuez l'une des opérations suivantes :
    1. Si vous utilisez l'assistant d'agent, cliquez sur Suivant. Exécutez l'assistant si nécessaire.
    2. Sinon, cliquez sur Terminer pour sauvegarder la source de données et ouvrir l'éditeur d'agent. Puis, dans le menu principal, sélectionnez Fichier > Sauvegarder.
    A ce point, Agent Builder crée le code source pour l'application de surveillance. Le code se trouve dans le sous-répertoire src du répertoire de projet. Editez ce code pour créer votre application de surveillance.