Seguimiento de eventos con keenauth events tail
keenauth events tail lee la API de eventos de su entorno y muestra cada evento de cliente a medida que aparece, por ejemplo user.created. Los eventos son los mismos que las entregas de webhooks: el mismo sobre y el mismo id. Úselo para observar lo que recibirá su integración, o para comprobar que una acción generó el evento que espera. Pulse Ctrl-C para detenerlo; el comando termina entonces con el código 0.
El comando necesita el permiso events:read. Funciona con una clave de API y con una sesión de keenauth login.
Uso
keenauth events tail --types user.created,user.updated
| Indicador | Descripción |
|---|---|
--types |
Solo estos tipos de evento, separados por comas o repetidos. |
--org |
Solo eventos de esta organización (org_…). |
--payload |
thin (por defecto) o full. full incluye el recurso y también necesita el permiso users:read. |
--after |
Desde dónde empezar: latest (por defecto) muestra solo los eventos que ocurran a partir de ahora; un cursor mostrado por una ejecución anterior continúa desde allí. |
--interval |
Tiempo entre dos comprobaciones cuando no hay eventos nuevos, de 1s a 60s. Por defecto: 5s. |
--output, -o |
table, json o yaml. Sin este indicador, la CLI muestra una tabla en un terminal y JSON en caso contrario. |
Un filtro, cursor o intervalo no válido detiene el comando con el código 2 antes de enviar cualquier solicitud.
Salida
table: una línea por evento con la hora, el tipo, el número de secuencia y el ID del evento.json: cada evento exactamente como lo envió el servidor, un objeto JSON por línea (JSON delimitado por saltos de línea). Es el valor por defecto cuando la salida estándar no es un terminal.yaml: un documento YAML por evento, cada uno empezando por---.
Los eventos se muestran en el orden de eventos del entorno (seq). Al detener el comando, muestra en el error estándar el cursor desde el que continuar:
to continue from here: --after <cursor>
Ejecute keenauth events tail --after <cursor> más tarde para mostrar los eventos que se perdió en el intervalo. Los eventos se conservan durante 30 días.
Cómo sigue los eventos
El comando pide los eventos posteriores a su cursor, los muestra y mueve el cursor al que devuelve la respuesta. Cuando la respuesta indica que hay más eventos pendientes, vuelve a pedirlos de inmediato; en caso contrario, espera --interval y vuelve a pedirlos.
Códigos de salida
| Código | Significado |
|---|---|
0 |
Detenido con Ctrl-C. |
1 |
Un error del servidor o un fallo de red, por ejemplo un cursor de otro entorno. |
2 |
Error de uso: un filtro, cursor, intervalo o formato de salida no válido. No se envió ninguna solicitud. |
3 |
Falta la credencial, o el servidor respondió 401 o 403. |
4 |
El plan no incluye la función (403 con plan_feature_unavailable). |