Créez un déclencheur pour collecter des métriques personnalisées pour les erreurs HTTP 404

Lorsque vos clients et clients ne peuvent pas accéder aux informations dont ils ont besoin en raison d'erreurs sur les pages Web, vous pouvez écrire un déclencheur pour vous aider à trouver des réponses.

Par exemple, lorsqu'un client demande une page que votre HTTP le serveur ne trouve pas, le serveur répond avec un code d'état 404 ou une erreur « page introuvable ». De telles réponses ont tendance à indiquer que le lien sur lequel le client a cliqué mène à un URI non valide. Il serait utile de savoir à quelle URI les clients essaient d'accéder et de trouver le référent, ou la source, du lien non valide.

Dans cette procédure pas à pas, vous allez créer un déclencheur qui répond aux questions suivantes :

  • Mes clients reçoivent-ils des messages d'erreur « page introuvable » ?
  • Quel est l'URI de la page à l'origine de l'erreur ?
  • Quel est le référent à l'origine de l'erreur ?

Vous allez créer un déclencheur qui génère une nouvelle métrique personnalisée qui renvoie à la fois l' URI non valide et le référent de l'URI non valide. Vous allez également créer une application qui fournit une vue personnalisée de votre trafic Web en collectant des métriques Web chaque fois qu'un code dstate 404 apparaît sur des appareils spécifiques.

Prérequis

Configuration du déclencheur

Dans les étapes suivantes, vous allez nommer et décrire le déclencheur, activer le débogage et configurer le déclencheur pour qu'il s'exécute sur HTTP événements de réponse.

  1. Cliquez sur l'icône des paramètres système , puis cliquez sur DÉCLENCHEURS.
  2. Cliquez Créez.
  3. Entrez le nom du déclencheur. Pour cette procédure pas à pas, tapez Erreurs HTTP 404.
  4. Entrez une description du déclencheur. Pour cette procédure pas à pas, tapez Suivez les erreurs 404 jusqu'à la source.
  5. Cliquez Activer le journal de débogage.
  6. Cliquez dans le Évènements champ et sélectionnez HTTP_RESPONSE depuis la liste.
La figure suivante montre les attributs de configuration du déclencheur que vous avez configurés ci-dessus :

Rédiger une instruction de débogage

Ajoutez ensuite une simple instruction de débogage pour vous familiariser avec la disposition et les fonctionnalités de l'éditeur de déclencheurs.

Lorsque le déclencheur est lancé, il recherche HTTP événements de réponse et vérifie si le code dstatus de la réponse est 404. Si un code d'état 404 est détecté, l'appel de débogage ajoute l' URL à laquelle l'utilisateur a tenté d'accéder au journal de débogage.

  1. Cliquez sur Rédacteur onglet.
  2. Ajoutez le code suivant dans l'éditeur :
    if (HTTP.statusCode === 404) {
        debug (HTTP.uri);
    }
    Conseil :L'éditeur fournit certaines fonctionnalités de saisie semi-automatique lors de la saisie de code. Par exemple, si vous tapez un point (.) après avoir sélectionné un objet de classe, vous obtenez une liste de méthodes et de propriétés applicables à l'objet HTTP. Vous pouvez sélectionner l'élément souhaité dans la liste, comme illustré dans la figure suivante :

    En cliquant sur le je L'icône affiche une description de l' élément actuel, comme illustré dans la figure suivante :

  3. Cliquez Enregistrer et fermer.

Assignez le déclencheur aux appareils

Avant que le déclencheur puisse enregistrer le résultat de l'instruction de débogage, vous devez attribuer le déclencheur à au moins un équipement. Pour cette procédure pas à pas, vous allez attribuer le déclencheur au HTTP serveur groupe d'équipements.

Une fois le déclencheur attribué, le système exécute le déclencheur chaque fois qu'une Réponse HTTP se produit sur un serveur de ce groupe.

Important :Lorsque vous créez vos propres déclencheurs, attribuez-les uniquement aux appareils spécifiques dont vous avez besoin afin de minimiser l'impact de vos déclencheurs sur les performances du système.
  1. Cliquez Actifs depuis le menu supérieur.
  2. Cliquez Groupes d'appareils, puis sélectionnez Serveurs HTTP case à cocher.
  3. Cliquez Assigner un déclencheur en haut de la page pour ouvrir une liste des déclencheurs éligibles à l'attribution.
  4. Sélectionnez le Erreurs HTTP 404 déclencheur, puis cliquez sur Assigner des déclencheurs.
  5. Cliquez sur le Réglages du système icône, retournez à la DÉCLENCHEURS , puis sélectionnez le Erreurs HTTP 404 déclencheur.
  6. Dans le Missions champ, vérifiez que les serveurs HTTP sélectionnés sont ajoutés.
Le champ doit ressembler à la figure suivante :

Afficher la sortie de débogage

Après avoir assigné le déclencheur à HTTP serveurs, le système exécute le déclencheur lorsque le trafic de réponse HTTP se produit, et si une réponse contient un code dstate 404, le système envoie les résultats au journal de débogage.

Pour afficher les résultats de l'instruction de débogage, cliquez sur Journal de débogage onglet, qui devrait ressembler à la figure suivante :

La sortie de débogage démarre dès que le déclencheur est attribué et enregistré ; toutefois, le journal ne peut pas afficher les données des 404 réponses survenues avant l'attribution et l'enregistrement du déclencheur.

Création d'une métrique personnalisée

Les résultats de l'instruction de débogage ont confirmé la présence d'URI générant 404 codes d'état . Dans cette section, vous allez créer une métrique personnalisée nommée « 404URIAndReferrer » pour extraire les URI non valides et les référents correspondants.

La métrique personnalisée renverra à la fois l'URI non valide et le référent du lien, ce qui vous permet d'extraire les deux ensembles de données en un seul résultat.

Pour créer une métrique personnalisée, vous devez spécifier une métrique source à partir duquel les données sont extraites, comme une application, un réseau ou un équipement. Dans cette procédure pas à pas, vous allez créer une application nommée « Fichier introuvable » comme source de la métrique personnalisée.

  1. Dans le volet droit, ajoutez le code déclencheur suivant, surligné en vert, au script existant :
    if (HTTP.statusCode === 404){
        debug (HTTP.uri);
        var app = Application("File Not Found");
    }
    Ce code déclare l'application en tant que variable et spécifie le nom de l'application. Nous vous recommandons de déclarer une variable pour les méthodes que vous avez l'intention d' appeler plusieurs fois afin de réduire la consommation de ressources par le déclencheur. Dans cette procédure pas à pas, le code appellera l'application deux fois.
  2. Ajoutez le code déclencheur suivant, surligné en vert, au script existant :
    if (HTTP.statusCode === 404){
        debug (HTTP.uri);
        var app = Application("File Not Found");
        app.metricAddDetailCount(
            "404UriAndReferrer",
            "404:" + HTTP.uri + " | REFERRER:" + HTTP.referer,
            1);
    } 
    Le metricAddDetailCount méthode spécifie le nom de la métrique et les données de propriété de l'événement renvoyées par la métrique. La méthode spécifie également le format des données extraites sous la forme 404 : <uri>| RÉFÉRENT : <uri> lorsqu'il est affiché dans un graphique. Voir le Demande section du Référence de l'API ExtraHop Trigger pour plus d'informations sur les méthodes métriques personnalisées.
  3. Cliquez Enregistrer.
Une fois le code enregistré, le système ExtraHop ajoute la nouvelle métrique personnalisée au catalogue de métriques et crée l'application. À ce stade, l'application est une source pour la métrique personnalisée uniquement ; l'application ne collecte pas de métriques intégrées. Voir le Catalogue métrique section du Guide de l'utilisateur du système ExtraHop et le Demande section du Référence de l'API ExtraHop Trigger pour plus d' informations.

Afficher la métrique personnalisée dans un graphique

Pour afficher votre métrique personnalisée, vous devez l'ajouter à un widget graphique sur un tableau de bord. Dans le graphique, la métrique personnalisée indiquera quels URI ne sont pas valides et le référent de chaque lien non valide.

Pour plus d'informations sur l'affichage des statistiques sur un tableau de bord, consultez le Commencez avec les tableaux de bord section du Guide de l'utilisateur du système ExtraHop .

  1. Sur le Tableau de bord page, cliquez sur le menu de commandes dans le coin supérieur droit, puis sélectionnez Créer un graphique.
  2. Cliquez sur le widget graphique vide dans votre tableau de bord nouvellement créé pour lancer explorateur de métriques.
  3. Cliquez Ajouter une source.
  4. Tapez et sélectionnez Fichier introuvable, qui est l'application créée par le déclencheur.
  5. Dans le Métriques champ, type 404 puis sélectionnez 404 Uri et référent, qui est la métrique personnalisée créée par le déclencheur.
    Remarque :Le système ExtraHop convertit le nom métrique personnalisé que vous avez spécifié dans le code en un nom d'affichage convivial. Dans cette procédure pas à pas, « 404 Uri et référent » est converti en « 404 URI et référent ». Vous pouvez modifier le nom d'affichage convivial dans le Catalogue métrique. Voir le Catalogue métrique section du Guide de l'utilisateur du système ExtraHop pour plus d' informations.
  6. Sélectionnez le Bar type de graphique depuis le bas de l' explorateur métrique.
  7. Dans le coin inférieur droit, cliquez sur Ajouter au tableau de bord et sélectionnez Créer un tableau de bord.
  8. Tapez le nom de votre tableau de bord dans le Titre champ. Pour cette procédure pas à pas, tapez Erreurs HTTP 404.
  9. Cliquez Créez.
Le graphique contenant les données extraites de la métrique personnalisée est automatiquement ajouté au nouveau tableau de bord. La sortie du tableau de bord doit ressembler à la figure suivante :

Collectez des métriques intégrées dans l'application

Au cours des étapes précédentes, vous avez ajouté du code au script pour créer une application en tant que source de votre nouvelle métrique personnalisée. Dans cette section, vous allez ajouter du code qui permet à l'application de collecter des données intégrées HTTP des métriques, mais pas des métriques personnalisées, pour fournir une vue personnalisée de votre trafic Web chaque fois qu'un code dstatus 404 apparaît sur les appareils spécifiés.

  1. Dans le Configuration du déclencheur fenêtre, cliquez sur Rédacteur onglet.
  2. Ajoutez le code déclencheur suivant, surligné en vert, au script existant :
    if (HTTP.statusCode === 404){
        debug (HTTP.uri);
        var app = Application("File Not Found");
        app.metricAddDetailCount(
            "404UriAndReferrer",
            "404:" + HTTP.uri + " | REFERRER:" + HTTP.referer,
            1);
        app.commit();
    }
  3. Cliquez Enregistrer et fermer.

Afficher l'application et les pages métriques

La nouvelle application « Fichier introuvable » est créée lors de la première exécution du déclencheur et les conditions spécifiées par le script de déclenchement sont remplies. Une fois l'application validée, plusieurs minutes peuvent s'écouler avant que le déclencheur ne s'exécute et que les données ne soient disponibles dans l'application.

L'application validée ajoute des données métriques intégrées pertinentes aux conditions définies par votre déclencheur chaque fois que celui-ci s'exécute. Dans cette procédure pas à pas, intégré HTTP des métriques sont ajoutées à l'application chaque fois qu'une Réponse HTTP génère un code dquo 404 sur les appareils sélectionnés

L'application affiche les données collectées sur une ou plusieurs pages de protocole. Les pages de protocole sont automatiquement créées en fonction des objets de protocole inclus dans votre déclencheur. Dans cette procédure pas à pas, étant donné que le déclencheur s'exécute sur les réponses HTTP, l'application « Fichier introuvable » contient une page de protocole appelée Web qui affiche des métriques HTTP intégrées. Si vous créez un déclencheur configuré pour s'exécuter sur des événements TLS, l'application affiche une page de mesures TLS intégrées, et un déclencheur qui s'exécute sur des événements Flow affiche une page de mesures L4 intégrées.

  1. Cliquez Actifs depuis le menu supérieur.
  2. Dans le volet de gauche, cliquez sur Demandes, puis sélectionnez le Fichier introuvable application.
  3. Dans le volet de gauche, cliquez sur HTTP pour afficher les métriques HTTP intégrées collectées dans l'application.
La page Web doit ressembler à la figure suivante :

Vérifiez les performances du déclencheur

Les déclencheurs sont un outil puissant qui peut fournir des informations détaillées sur votre environnement. Cependant, les déclencheurs consomment des ressources et affectent les performances du système. Dans cette section, vous allez vérifier l'impact du déclencheur sur les performances et découvrir les petites modifications que vous pouvez apporter pour améliorer les performances.

Le graphique des performances du déclencheur indique le nombre de cycles consommés par le déclencheur dans l'intervalle de temps spécifié. Vous pouvez survoler un point de données pour afficher des informations détaillées sur les performances du déclencheur à un moment précis.

Dans le Modifier le déclencheur volet, affichez le Capturer la charge du déclencheur graphique. le graphique ressemble à la figure suivante :

Conseil :La page État du système dans les paramètres système fournit des graphiques de performance supplémentaires qui vous permettent de surveiller l'effet cumulé de tous vos déclencheurs sur le système. Voir le tableau de bord de l'état du système sujet.

Essayez d'apporter les modifications suivantes, puis consultez le graphique des performances pour visualiser les modifications éventuelles :

  • Commentez l'instruction de débogage. Vous avez vérifié que le déclencheur fonctionne et qu' il collecte les métriques personnalisées et intégrées souhaitées ; vous n'avez plus besoin de la sortie de débogage.
  • Réaffectez le déclencheur à des appareils spécifiques plutôt qu'à tous HTTP serveurs du groupe ddispositifs/équipements.

Pour obtenir des conseils et astuces supplémentaires sur l'optimisation des déclencheurs, consultez le Référence de l'API ExtraHop Trigger et les articles de blog suivants sur Trigger Optimization 101 publiés dans le Forums communautaires ExtraHop:

Last modified 2024-09-26