Nom convivial de la vérification

Nom convivial de la vérification API

Qu'est-ce qu'un nom convivial de vérification ?

Un nom convivial de vérification est un identifiant lisible par l'humain pour votre vérification API. Il vous aide à comprendre rapidement l'objectif et le contexte de la vérification sans avoir besoin de mémoriser ou de rechercher des détails techniques. Le nom est utilisé dans les alertes et les rapports, facilitant la gestion et le référencement de vos vérifications.

Noms générés automatiquement

Quand vous saisissez l'URL d'une vérification API, LoadFocus remplit le nom pour vous à partir de cette URL : le nom de domaine, plus le chemin s'il y en a un. Par exemple, https://api.example.com/users devient Example - Users. Vous pouvez le modifier pour définir un nom plus descriptif et significatif. Pour les autres types de vérification sans URL à lire, saisissez vous-même le nom.

Comment changer le nom convivial de la vérification

Vous pouvez changer le nom de votre vérification API en accédant au champ Nom convivial de la vérification et en définissant votre propre nom. Un nom est obligatoire. Il est utilisé dans les alertes et les rapports, et les e-mails d'alerte le portent dans leur objet, par exemple [LoadFocus] Failure Alert Triggered for User Login Endpoint - San Francisco.

Bonnes pratiques pour nommer les vérifications API

1. Descriptif et clair : Utilisez des noms clairs et descriptifs qui fournissent suffisamment de contexte sur ce que la vérification teste. Évitez les noms trop techniques qui pourraient être confus.

• Exemple : User Login Endpoint - San Francisco

2. Inclure le point de terminaison et l'emplacement : Si vous testez le même point de terminaison depuis plusieurs emplacements, incluez l'emplacement dans le nom pour les différencier.

• Exemple : Product Search API - US East

3. Utiliser des conventions de nommage cohérentes : Établissez et suivez une convention de nommage cohérente pour faciliter la recherche et le filtrage de vos vérifications.

• Exemple : NomService - PointTerminaison - Emplacement
• Exemple : Inventory Service - Add Item - EU Central

4. Indiquer l'objectif ou le scénario : Si la vérification est destinée à un objectif ou un scénario spécifique, incluez-le dans le nom.

• Exemple : Payment API - Load Test - High Volume

5. Court et concis : Gardez le nom concis mais informatif. Évitez les noms trop longs qui peuvent être tronqués ou difficiles à lire rapidement.

• Exemple : Checkout API - Latency Check

Exemples de noms conviviaux de vérification

• User Authentication API - London
• Order Processing - Peak Hours - Asia
• Search Service - Keyword Search - US West
• User Profile Update - Response Time
• Cart API - Add Item - Canada
• Notification Service - Delivery Status - Australia

Avantages de l'utilisation de noms conviviaux

• Meilleure gestion : Identifiez et gérez facilement vos vérifications API.
• Meilleures alertes : Recevez des alertes avec des noms significatifs, facilitant la compréhension du contexte du problème.
• Collaboration améliorée : Les membres de l'équipe peuvent rapidement comprendre l'objectif de chaque vérification, facilitant une meilleure collaboration et communication.

Tags

À côté du nom, vous pouvez ajouter des Tags : des étiquettes facultatives comme production ou paiements, séparées par des virgules, 10 au maximum par vérification et 30 caractères chacune (lettres, chiffres, espaces, points, tirets bas et tirets). Les tags ne tiennent pas compte de la casse et les doublons sont ignorés.

Les tags apparaissent sous forme de petites pastilles à côté de la vérification dans la liste des vérifications. Cliquez sur une pastille pour n'afficher que les vérifications qui portent ce tag, et videz le champ de filtre pour revoir toutes les vérifications. Les tags font aussi partie de Monitoring as Code : un fichier de vérification les définit avec une liste tags, et déployer un fichier sans tags les retire de cette vérification.