Nombre amigable de verificación

¿Qué es un Nombre Amigable de Verificación?

Un nombre amigable de verificación es un identificador legible para tu verificación de API. Te ayuda a comprender rápidamente el propósito y contexto de la verificación sin necesidad de recordar o buscar detalles técnicos. El nombre se usa en alertas e informes, facilitando la gestión y referencia de tus verificaciones.

Nombres Generados Automáticamente

Cuando introduces la URL de una verificación de API, LoadFocus rellena el nombre por ti a partir de esa URL: el nombre de dominio, más la ruta si la hay. Por ejemplo, https://api.example.com/users se convierte en Example - Users. Puedes editarlo para poner un nombre más descriptivo y significativo. En otros tipos de verificación sin URL que leer, escribe tú el nombre.

Cómo Cambiar el Nombre Amigable de Verificación

Puedes cambiar el nombre de tu verificación de API yendo al campo Nombre descriptivo de la verificación y estableciendo tu propio nombre. El nombre es obligatorio. Se usa en alertas e informes, y los correos de alerta lo llevan en el asunto, por ejemplo [LoadFocus] Failure Alert Triggered for User Login Endpoint - San Francisco.

Mejores Prácticas para Nombrar Verificaciones de API

1. Descriptivo y Claro: Usa nombres claros y descriptivos que proporcionen suficiente contexto sobre lo que la verificación está probando. Evita nombres excesivamente técnicos que puedan ser confusos.

• Ejemplo: User Login Endpoint - San Francisco

2. Incluir Endpoint y Ubicación: Si estás probando el mismo endpoint desde múltiples ubicaciones, incluye la ubicación en el nombre para diferenciarlos.

• Ejemplo: Product Search API - US East

3. Usar Convenciones de Nomenclatura Consistentes: Establece y sigue una convención de nomenclatura consistente para facilitar la búsqueda y filtrado de tus verificaciones.

• Ejemplo: NombreServicio - Endpoint - Ubicación
• Ejemplo: Inventory Service - Add Item - EU Central

4. Indicar Propósito o Escenario: Si la verificación es para un propósito o escenario específico, inclúyelo en el nombre.

• Ejemplo: Payment API - Load Test - High Volume

5. Corto y Conciso: Mantén el nombre conciso pero informativo. Evita nombres excesivamente largos que puedan truncarse o ser difíciles de leer rápidamente.

• Ejemplo: Checkout API - Latency Check

Ejemplos de Nombres Amigables de Verificación

• 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

Beneficios de Usar Nombres Amigables de Verificación

• Mejor Gestión: Identifica y gestiona fácilmente tus verificaciones de API.
• Mejores Alertas: Recibe alertas con nombres significativos, facilitando la comprensión del contexto del problema.
• Colaboración Mejorada: Los miembros del equipo pueden comprender rápidamente el propósito de cada verificación, facilitando una mejor colaboración y comunicación.

Etiquetas

Junto al nombre puedes añadir Etiquetas: marcas opcionales como producción o pagos, separadas por comas, hasta 10 por verificación y 30 caracteres cada una (letras, dígitos, espacios, puntos, guiones bajos y guiones). No distinguen mayúsculas de minúsculas y los duplicados se descartan.

Las etiquetas aparecen como pequeñas píldoras junto a la verificación en la lista de verificaciones. Haz clic en una para mostrar solo las verificaciones que la llevan, y vacía el cuadro de filtro para volver a ver todas. Las etiquetas también forman parte de Monitoring as Code: un archivo de verificación las define con una lista tags, y desplegar un archivo sin tags las elimina de esa verificación.