Créer un déclencheur
Les déclencheurs permettent d'étendre les fonctionnalités de votre système ExtraHop. Grâce aux déclencheurs, vous pouvez créer des mesures personnalisées, générer et stocker des enregistrements ou envoyer des données à un système tiers. Comme vous écrivez le script du déclencheur, vous contrôlez les actions entreprises par le déclencheur lors d'événements système spécifiques.
Before you begin
Si vous êtes novice en matière de déclencheurs, familiarisez-vous avec le processus de planification des
déclencheurs, qui vous aidera à réduire l'objectif de votre déclencheur ou à déterminer s'il est nécessaire de créer un déclencheur. Ensuite, exécutez le processus de création d'un déclencheur en suivant la procédure des déclencheurs.
Configurer les paramètres du déclencheur
La première étape de la construction d'un déclencheur consiste à lui donner un nom, à déterminer si le débogage est activé et, surtout, à identifier les événements du système sur lesquels le déclencheur s'exécutera.
-
Cliquez sur l'icône Paramètres système
, puis sur Déclencheurs.
Rédiger un script de déclenchement
Le script de déclenchement spécifie les instructions que le déclencheur exécutera lorsqu'un événement système configuré pour le déclencheur se produira.
Before you begin
Nous vous recommandons d'ouvrir le site Référence API ExtraHop Trigger , qui contient les événements, les méthodes et les propriétés dont vous avez besoin pour votre déclencheur. Un lien est également disponible dans la fenêtre de l'éditeur de déclencheur du système ExtraHop.-
Cliquez sur l'icône Paramètres système , puis sur Déclencheurs.
-
Dans le volet de droite, saisissez le script du déclencheur dans une syntaxe de type JavaScript avec les événements, les méthodes et les propriétés du site
Référence API ExtraHop Trigger
.
La figure suivante montre un exemple de script saisi dans l'onglet Éditeur :
L'éditeur offre une fonction d'autocomplétion qui affiche une liste de propriétés et de méthodes en fonction de l'objet de classe sélectionné. Par exemple, tapez un nom de classe, puis un point (.) pour afficher une liste de propriétés et de méthodes disponibles, comme le montre la figure suivante :
-
Cliquez sur Enregistrer.
L'éditeur fournit une validation syntaxique de votre script. Lorsque vous enregistrez le déclencheur, le validateur signale les actions non valides, les erreurs de syntaxe ou les éléments dépréciés dans le script. Le cas échéant, le validateur affiche des remplacements pour les éléments obsolètes.
Avertissement : Pour éviter de mauvaises performances du déclencheur, des résultats incorrects ou un déclencheur qui ne fonctionne pas, nous vous recommandons vivement de corriger le code ou de remplacer l'élément obsolète. La figure suivante présente un exemple de message d'erreur généré par le validateur de syntaxe :
Options avancées des déclencheurs
Vous devez configurer les déclencheurs pour qu'ils s'exécutent sur au moins un événement. En fonction de l'événement sélectionné, le volet Créer un déclencheur affiche des options de configuration avancées. Par exemple, la sélection de l'événement HTTP_RESPONSE vous permet de définir le nombre d'octets de charge utile à mettre en mémoire tampon chaque fois que cet événement se produit sur le système.
| Option | Description de l'option | Événements pris en charge | ||
|---|---|---|---|---|
| Octets par paquet à capturer | Spécifie le nombre d'octets à capturer par paquet. La capture commence par le premier octet du paquet. Spécifiez cette option uniquement si le script de déclenchement effectue une capture de paquets . Une valeur de 0 indique que la capture doit recueillir tous les octets de chaque paquet . |
Tous les événements sont pris en charge, à l'exception de la liste suivante :
|
||
| L7 Payload Bytes to Buffer (octets de charge utile dans la mémoire tampon) |
|
|
||
| Octets du presse-papiers | Spécifie le nombre d'octets à mettre en mémoire tampon lors d'un transfert de presse-papiers Citrix. |
|
||
| Cycle métrique | Spécifie la durée du cycle métrique, exprimée en secondes. Les valeurs suivantes sont valides :
|
|
||
| Types de métriques | Spécifie le type de métrique par le nom brut de la métrique, tel que extrahop.device.http_server. Spécifiez plusieurs types de métriques dans une liste délimitée par des virgules. |
|
||
| Run trigger on each flow turn |
Si cette option est activée, toutes les valeurs spécifiées pour les options Chaîne de correspondance du clientet Chaîne de correspondance du serveur sont ignorées . |
|
||
| Plage de ports du client | Spécifie la plage de ports du client . Les valeurs valides sont comprises entre 0 et 65535 . |
|
||
| Octets du client à mettre en mémoire tampon | La valeur de cette option ne peut pas être définie sur 0 si la valeur de l'option Octets du serveur à mettre en mémoire tampon estégalement définie sur 0 . |
|
||
| Chaîne de recherche du tampon client | Spécifie la chaîne de format qui indique quand commencer à mettre en mémoire tampon les données du client .Toute valeur spécifiée pour cette option est ignorée si l'option Per Turn est activée . |
|
||
| Plage de ports du serveur | Spécifie la plage de ports du serveur . Les valeurs valides sont comprises entre 0 et 65535 . |
|
||
| Server Bytes to Buffer (octets de serveur à mettre en mémoire tampon) |
La valeur de cette option ne peut pas être définie sur 0 si la valeur de l'option Octets du client à mettre en mémoire tampon estégalement définie sur 0 . |
|
||
| Chaîne de recherche du tampon du serveur | Spécifie la chaîne de format qui indique quand commencer à mettre les données en mémoire tampon. Toute valeur spécifiée pour cette option est ignorée si l'option Per Turn est activée . |
|
||
| Run trigger on all UDP packets (Lancer un déclencheur sur tous les paquets UDP) | Active la capture de tous les datagrammes UDP. |
|
||
| Run FLOW_CLASSIFY on expiring, unclassified flows (Exécuter FLOW_CLASSIFY sur les flux non classifiés arrivant à expiration) | Permet d'exécuter l'événement à l'expiration afin d'accumuler des mesures pour les flux qui n'ont pas été classés avant l'expiration. |
|
Nous vous remercions pour vos commentaires. Pouvons-nous vous contacter pour vous poser des questions complémentaires ?