Créer une métrique personnalisée

Outre l'analyse des métriques de protocole intégrées dans le système ExtraHop, vous pouvez créer vos propres métriques personnalisées pour collecter des informations spécifiques sur votre environnement. La création d'une métrique personnalisée nécessite deux étapes : la spécification des paramètres de la métrique dans le catalogue de métriques et la création d'un déclencheur pour découvrir, collecter et stocker les données de la métrique personnalisée. Dans cette rubrique, vous apprendrez à créer une mesure personnalisée à partir du catalogue de mesures.

1. Connectez-vous au système ExtraHop via https://<extrahop-hostname-or-IP-address>.
2. Cliquez sur l'icône Paramètres système , puis sur Catalogue de métriques.
3. Cliquez sur le menu de commande et sélectionnez Create Metric Manually (Créer une métrique manuellement).
4. Dans la section Paramètres, effectuez les étapes suivantes pour créer le code qui sera référencé par un déclencheur :
   1. Dans le champ Métrique, saisissez un nom unique pour votre métrique. La méthode de déclenchement qui collecte les données pour votre indicateur personnalisé doit faire référence au nom exact de l'indicateur que vous indiquez dans le champ Indicateur. Évitez les espaces entre les mots en tapant des traits de soulignement. Lorsque vous définissez un nom de métrique détaillé, indiquez la clé de détail dans le nom en ajoutant .by_<key_name_without_spaces> au nom de la métrique, où <nom_de_la_clé_sans_espaces> est le nom de la clé de la métrique.
      Par exemple, une mesure personnalisée qui collecte le nombre maximum de réponses HTTP par client peut être spécifiée comme max_http_responses.by_client.
   2. Dans le champ Type de source, sélectionnez dans la liste déroulante la source ou la classe dont vous souhaitez extraire les données. Pour plus d'informations sur ces classes, voir General purpose classes dans le Trigger API Reference.
   3. Dans le champ Metric Type (Type de mesure), sélectionnez dans la liste déroulante une option qui spécifie comment les données seront stockées et visualisées dans le système ExtraHop. La sélection du type de mesure apparaît dans les déclencheurs en tant que partie du nom de la méthode, par exemple metricAddCount ou metricAddDataset. Pour plus d'informations, voir Types de données ExtraHop dans la Référence API pour les déclencheurs.
   4. Dans le champ Type, sélectionnez l'une des options suivantes :
   • Sélectionnez Base Metric. Une métrique de base, ou de premier niveau, inclut les types de métriques, le comptage, l'ensemble de données. La sélection du type apparaît dans les déclencheurs comme une partie du nom de la méthode, par exemple metricAddDataset.
   • Sélectionnez la métrique de détail. Une métrique détaillée se compose de paires clé-valeur, où la clé est une chaîne ou une adresse IP et la valeur est un type de métrique de niveau supérieur, tel qu'une métrique de comptage ou de jeu de données. La sélection du type apparaît dans les déclencheurs en tant que partie du nom de la méthode, par exemple metricAddDetailDataset.

   Important :

   Les sélections effectuées dans la section Paramètres ne peuvent pas être modifiées après la création de la métrique personnalisée.

5. Dans la section Affichage, suivez les étapes suivantes pour spécifier les informations métriques consultables par les utilisateurs du système ExtraHop :
   1. Dans le champ Nom, saisissez un nom d'affichage convivial pour votre paramètre qui sera affiché dans les résultats de recherche et les graphiques du système ExtraHop. Vous pouvez inclure des espaces dans le nom d'affichage.
   2. Facultatif : Dans le champ Unités, sélectionnez une option dans la liste déroulante si vous connaissez l'unité de mesure à afficher dans un graphique pour vos données métriques.
   3. Facultatif : Dans le champ Description, saisissez les informations qui s'affichent avec les résultats de la recherche de votre unité métrique dans le système ExtraHop. La description de la métrique de base personnalisée est automatiquement affichée pour la métrique détaillée dans les résultats de recherche.
   4. Facultatif : (Pour les métriques détaillées uniquement) Dans le champ Étiquette de clé, saisissez un nom d'affichage pour l'ensemble des clés de votre métrique. Par exemple, vous pouvez créer l'étiquette de clé, Agent utilisateur, pour une mesure personnalisée qui collecte les demandes par agent utilisateur HTTP. Il n'est pas nécessaire que les étiquettes de clés soient uniques.
6. Facultatif : Dans la section Relations de détail, effectuez l'une des étapes suivantes si vous souhaitez associer une métrique de base personnalisée à une métrique de détail personnalisée :
   • (Pour les indicateurs de base) Dans le champ Indicateurs de détail, cliquez sur le champ et recherchez un indicateur personnalisé que vous souhaitez que les utilisateurs visualisent en descendant à partir de l'indicateur personnalisé. Vous pouvez laisser ce champ vide si vous ne souhaitez pas fournir de données d'exploration pour votre métrique personnalisée.
   • (Pour les indicateurs détaillés) Dans le champ Indicateur de base, sélectionnez dans la liste déroulante un indicateur de premier niveau que vous souhaitez associer à votre indicateur détaillé personnalisé. Vous pouvez laisser ce champ vide si vous ne souhaitez pas associer d'autres métriques à votre métrique personnalisée.
7. Facultatif : Dans la section Relations d'enregistrement, cliquez sur la liste déroulante TYPE D'ENREGISTREMENT, cliquez sur un ou plusieurs types d'enregistrement, puis cliquez en dehors de la liste. En option, vous pouvez filtrer les résultats de la requête lorsque vous effectuez une recherche dans les enregistrements de l'indicateur personnalisé à l'aide des champs suivants.
   1. Facultatif : Dans la section FILTRE SOURCE, cochez la case en regard de la source de cette mesure personnalisée. Ce filtre interroge automatiquement la source à partir de laquelle vous effectuez une analyse descendante. Par exemple, si vous cochez la case située en regard de Serveur, lorsque vous recherchez des enregistrements pour cette mesure personnalisée à partir d'un serveur web nommé example-web-sea, un filtre est automatiquement ajouté à votre requête qui ne renvoie que les résultats des transactions pour lesquelles example-web-sea agit en tant que serveur.
   2. Facultatif : Dans la section FILTRES SUPPLÉMENTAIRES, vous pouvez créer des filtres avancés qui recherchent des enregistrements en fonction des critères spécifiés ou saisir une expression régulière (regex ) pour filtrer les enregistrements des mesures détaillées personnalisées.

   Remarque :

   Pour plus d'informations, voir Activer les requêtes d'enregistrement pour les métriques personnalisées.

8. Lorsque vous êtes satisfait des paramètres, cliquez sur Créer. Vos paramètres de mesure personnalisés sont ajoutés au système ExtraHop. Les paramètres de l'API REST pour votre métrique apparaissent dans le catalogue des métriques. Vous pouvez maintenant rechercher votre métrique et l'ajouter à des graphiques.

   Important :

   Vous devez créer un déclencheur pour découvrir, collecter et stocker les données des indicateurs personnalisés.