Guide de l'interface utilisateur du gateway

L'interface utilisateur du gateway Pipeline Control fournit une interface basée sur des formulaires pour créer et gérer des règles de gateway sans écrire directement de YAML. L'interface utilisateur organise la logique de traitement en trois catégories de règles : taux d'échantillonnage, filtre et transformation. Chaque catégorie est configurable via des boîtes de dialogue modales guidées.

Organisation de l'interface utilisateur

L'interface utilisateur du gateway est organisée en trois sections principales :

Taux d'échantillonnage

Configurez l'échantillonnage probabiliste avec des règles conditionnelles pour contrôler le pourcentage de données de télémétrie qui parviennent à New Relic. Prise en charge :

• Pourcentage d'échantillonnage par défaut (0-100 %)
• Scénarios d'échantillonnage conditionnel basés sur la correspondance d'attributs

Cas d'utilisation courants :

• "Échantillonner 90 % des logs du service B, 83 % des logs du service A"
• "Conserver 100 % des erreurs, 100 % des traces > 1 000 ms, échantillonner 10 % du reste"

Filtre

Créez des règles de filtrage basées sur OTTL pour filtrer conditionnellement des enregistrements de télémétrie entiers ou des attributs spécifiques. Prise en charge :

• Correspondance de motif avec l'opérateur matches pour les regex
• Filtrage basé sur les attributs (environnement, nom de la métrique, niveau de log)
• Conditions combinées avec la logique and/or
• Opérateurs de comparaison (==, !=, >, <, >=, <=)

Cas d'utilisation courants :

• "Supprimer les données de l'environnement de test"
• "Supprimer les logs de niveau debug en production"
• "Supprimer les spans de health check"
• "Supprimer les métriques avec le préfixe test"

Transformer

Définissez des règles de transformation basées sur OTTL pour modifier, enrichir ou analyser les données de télémétrie. Prise en charge :

• Ajout et modification d'attributs à l'aide de fonctions OTTL
• Analyse de chaînes avec des motifs regex
• Transformations conditionnelles avec règles de correspondance
• Plusieurs instructions OTTL par transformation

Cas d'utilisation courants :

• "Ajouter des tags d'environnement et de région à toutes les métriques"
• "Analyser le format de log NGINX en attributs structurés"
• "Normaliser les noms de service dans les environnements"
• "Extraire les codes d'état HTTP des messages de log"

Créer des règles dans l'interface utilisateur

Création d'une règle de taux d'échantillonnage

1. Dans l'interface utilisateur du gateway, dans le bloc de taux d'échantillonnage, cliquez sur l'icône d'engrenage/paramètres pour créer une nouvelle configuration d'échantillonnage.

2. Configurer l'échantillonnage global :

   • Définir le pourcentage d'échantillonnage global (0-100 %).
   • Utilisez le curseur ou saisissez une valeur numérique. Cela s'applique à toutes les données qui ne correspondent pas aux règles conditionnelles.

3. Ajouter des scénarios conditionnels (facultatif) :

   • Cliquez sur l'icône PLUS pour créer des taux d'échantillonnage spécifiques à une condition.
   • Pour chaque scénario, configurez : un nom descriptif (par exemple, "B service sample"), une description (par exemple, "B service description"), une expression de correspondance d'attribut (par exemple, attributes["appName"]=="TelemetryApp-ServiceB"), un pourcentage d'échantillonnage à l'aide du curseur ou saisissez une valeur numérique (0-100 %)

4. Cliquez sur Save sample criteria pour appliquer les règles d'échantillonnage.

Créer une règle de filtrage

1. Dans l'interface du gateway, cliquez sur l'icône PLUS dans le bloc de filtre pour créer une nouvelle règle de filtrage.

2. Configurer les informations de base :

   • Rule name: Saisissez un nom descriptif.
   • Description: Expliquez ce que fait la règle.

3. Définissez une condition correspondant à vos données et cliquez sur Create rule.

4. Pour ajouter d'autres conditions si nécessaire, répétez les étapes 1 à 3.

Créer une règle de transformation

1. Dans l'interface du gateway, cliquez sur l'icône PLUS dans le bloc de transformations pour créer une nouvelle règle de transformation.

2. Configurer les informations de base:

   • Rule name: Saisissez un nom descriptif (par exemple, "parse-nginx-logs")
   • Description: Expliquez ce que fait la transformation

3. Définir des conditions correspondant à vos données:

   • Ajoutez des conditions pour cibler des enregistrements de télémétrie spécifiques.
   • Cliquez sur Add condition pour ajouter plusieurs conditions :

   Plusieurs conditions sont évaluées avec une logique OU (si l'une des conditions est remplie, la transformation s'applique). Exemples de conditions : body == "request failed", severity.text == "ERROR", severity.text == "FATAL_ERROR" Laisser vide pour appliquer la transformation à tous les enregistrements. Chaque condition est affichée dans un champ de saisie distinct avec l'opérateur OR entre elles.

4. Définir les instructions OTTL:

   • Ajouter une ou plusieurs instructions de transformation OTTL.
   • Cliquez sur Add statement pour ajouter plusieurs transformations.
   • Chaque instruction s'exécute séquentiellement. Modifiez l'ordre en faisant glisser la poignée à gauche de chaque instruction.
   • Exemples d'instructions utilisant les fonctions OTTL : set(severity_text, "FAIL"), set(attributes["processors"], true), set(attributes["environment"], "staging")

5. Cliquez sur Preview rule pour voir comment la transformation modifie les données d'exemple.

6. Apportez des modifications jusqu'à ce que vous soyez satisfait de la transformation.

7. Cliquez sur Create rule pour ajouter la transformation à votre gateway.

Déployez vos modifications

Une fois les règles configurées, suivez ces étapes pour déployer votre configuration :

1. Cliquez sur Create Deployment.

2. Sur la nouvelle page de déploiement :

   • Saisissez un nom et une description pour le déploiement.
   • Identifiez l'agent de gateway Pipeline Control sur lequel vous souhaitez effectuer le déploiement.
   • Ouvrez le menu à trois points à droite et cliquez sur Change version.

3. Dans la liste des versions, sélectionnez la version qui correspond à la configuration que vous venez de créer. (Les numéros de version s'incrémentent automatiquement à chaque modification de configuration, il devrait donc s'agir de la dernière version.)

4. Cliquez sur Add to deployment pour appliquer la configuration.

5. Cliquez sur Save draft, puis sur Start deployment.

6. Vous devez confirmer à nouveau que vous souhaitez lancer le déploiement. Cliquez à nouveau sur Start deployment pour confirmer.

Ressources OpenTelemetry

• Référence des fonctions OTTL - Liste complète des fonctions OTTL pour les transformations et les expressions booléennes pour le filtrage
• Processeur de transformation - Documentation officielle du processeur de transformation
• Processeur de filtre - Documentation officielle du processeur de filtre avec la syntaxe d'expression booléenne OTTL
• Processeur d'échantillonnage probabiliste - Documentation officielle du processeur d'échantillonnage