Definir el objetivo de nivel de servicio (SLO)
Resumen
El objetivo de nivel de servicio (SLO) declara qué tiempo de respuesta y qué disponibilidad te comprometés a ofrecer en una API, y cada cuántos minutos se comprueba el estado de sus métodos. Se define una vez por API, se puede sobreescribir en cada método, y se muestra a los desarrolladores en la ficha de la API y en el portal.
Antes de comenzar
- El paso SLO del asistente aparece en las cuentas que tienen el monitoreo de métodos habilitado. Si no lo ves al crear una API, consultá a soporte.
- Necesitás un rol que pueda crear o editar APIs.
Los tres valores
- Tiempos de respuesta, en milisegundos: el tiempo máximo que esperás que tarde un método en responder. Por defecto 10000.
- Disponibilidad, en porcentaje: la proporción de tiempo en la que la API tiene que estar en servicio. Por defecto 99.97; acepta de 0 a 99.99 con hasta dos decimales y punto como separador.
- Frecuencia de comprobación del estado de los métodos: cada cuántos minutos se comprueba que cada método responde. Por defecto 5; acepta de 0 a 1440 (un día).
Si completás uno de los tres, los otros dos pasan a ser obligatorios.
Definir el SLO de la API
Al crear o editar una API, el paso 2. SLO muestra Configure los SLO globales de su API con los tres valores precargados. Ajustalos y hacé clic en Continuar: el resto del asistente sigue con los límites y la revisión, que repite el bloque Objetivo de Nivel de Servicio (SLO) antes de guardar.
Sobreescribir el SLO en un método
En el editor del método, el bloque Objetivo de Nivel de Servicio (SLO) indica Este método heredará los SLO globales. Hacé clic en Sobreescribir para cargar valores propios: aparecen los mismos tres campos y el botón Usar valores por defecto, que vuelve a los de la API. Guardá el método con Listo y publicá la versión para que el cambio se vea.
Dónde se ve
- Ficha de la API en el Workspace, solapa Información: el bloque Objetivo de Nivel de Servicio (SLO) con los tres valores en ms, % y min, seguido de los límites.
- Portal para desarrolladores: la ficha de la API tiene una sección plegable con el mismo nombre. Muestra el SLO del método si lo sobreescribiste y, si no, el de la API.
- Estadísticas del Workspace: el panel Niveles de disponibilidad (SLO) compara la disponibilidad medida desde el inicio y en los últimos 30 días, cuando el servicio de monitoreo está configurado para la cuenta.
Qué hace la plataforma con estos valores
La frecuencia es el único valor operativo: al publicar la versión de la API, la plataforma registra una comprobación por método en el servicio de monitoreo, con ese intervalo, contra la URL del método en el dominio de producción. Al despublicar la versión o borrar el método, la comprobación se elimina.
El tiempo de respuesta y la disponibilidad son el compromiso que publicás: se muestran a los desarrolladores y sirven de referencia frente a las estadísticas, pero no limitan las llamadas ni cortan un método que los incumpla. Para acotar el tiempo de una llamada usá el Tiempo máximo de espera de los límites.
Resultado esperado
La ficha de la API y el portal muestran los tres valores del SLO, los métodos que no sobreescriben nada heredan los de la API, y cada método publicado queda con una comprobación de estado con la frecuencia definida.
Errores frecuentes
- No aparece el paso SLO: la cuenta no tiene habilitado el monitoreo de métodos. El asistente pasa directo de Descripción a Límites.
- Porcentaje no válido: la disponibilidad acepta de 00.00 a 99.99 con punto decimal; 100 no es un valor válido.
- Campo requerido en los otros dos campos: al completar uno de los tres valores hay que completar los tres, o dejar los tres vacíos.
- El portal sigue mostrando el SLO de la API: el método lo sobreescribió pero la versión no se publicó después del cambio.