Primeros pasos

Esta página le lleva de una cuenta vacía a un proyecto que recibe datos. Cuente con unos minutos.

1. Crear una cuenta

Quiet Guard está en beta cerrada: cada cuenta se abre a mano. Hay dos formas de entrar.

• Solicitar acceso. Abra /app/register, indique su nombre, su correo electrónico y una contraseña, y diga en pocas palabras qué le gustaría probar. Su solicitud entra en una cola; recibirá un correo cuando se acepte, y otro si no se acepta. Hasta entonces, iniciar sesión lleva a una página de espera, no al producto.
• Ser invitado. El operador puede crear su cuenta directamente; entonces recibirá un correo con un enlace para elegir su contraseña, y su cuenta ya estará aprobada.

La cuenta es suya; lo que contiene sus datos es un equipo, y lo crea usted mismo en su primer inicio de sesión. El formulario pide el nombre del equipo, su identificador de empresa (un SIREN francés o un número de IVA intracomunitario, ya que Quiet Guard se vende a profesionales) y su aceptación de las condiciones: el equipo es la parte del contrato, así que son declaraciones que solo puede hacer la persona que lo compromete. Nada se factura durante la beta y no se pide ninguna tarjeta.

El equipo es el tenant: todo, proyectos, planes, consumo, facturación, cifrado, pertenece a un equipo, no a un usuario individual. Podrá invitar a miembros más adelante desde la página Miembros del equipo, dentro de los asientos de su plan: uno en Free, tres en Indie, ilimitados en Studio. Los proyectos sí son ilimitados en todos los planes. Pasar a un plan con menos asientos no expulsa a nadie: el equipo conserva los miembros que tiene y no puede añadir ninguno nuevo hasta volver por debajo del número que lleva el plan.

El equipo es el tenant. Todos los datos están vinculados al equipo activo. Si pertenece a varios equipos, cambie el equipo activo desde el menú del tenant en la barra superior.

2. Crear un proyecto

Un proyecto representa una aplicación monitorizada (una aplicación Laravel, un sitio, un servicio).

1. En el panel /app, abra Proyectos y elija Nuevo proyecto.
2. Dele un nombre (por ejemplo Acme Store, production).
3. Guarde. Las demás secciones del formulario, apariencia, sonda de disponibilidad e integración con GitHub, son opcionales y pueden esperar.

Ahora dispone de un proyecto vacío, listo para recibir excepciones, logs e instantáneas de dependencias.

3. Generar una clave de API de proyecto

Cada proyecto autentica la aplicación monitorizada mediante una clave de API de proyecto. Las claves se almacenan con hash (SHA-256) y el valor en claro solo se muestra una vez.

1. Abra su proyecto y vaya a sus claves de API (tokens de proyecto).
2. Cree una clave y póngale un nombre (por ejemplo production).
3. Copie la clave inmediatamente. Tiene este aspecto:

lm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Cópiela ahora. La clave completa solo se muestra una vez. Si la pierde, revóquela y genere una nueva; el hash almacenado no puede transformarse de vuelta en la clave original.

4. Apuntar un cliente al punto de entrada de ingesta

La aplicación monitorizada envía sus datos al servidor Quiet Guard por HTTP, autenticándose con la clave de proyecto. Se aceptan dos estilos de encabezado:

# Recomendado: token bearer
curl -X POST https://votre-monitor.example.com/api/v1/ingest \
  -H "Authorization: Bearer lm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "exception": {
      "class": "RuntimeException",
      "message": "Quelque chose a mal tourné",
      "file": "/app/Services/Checkout.php",
      "line": 42
    },
    "context": { "environment": "production" }
  }'

# Encabezado alternativo
curl -X POST https://votre-monitor.example.com/api/v1/ingest \
  -H "X-Monitor-Key: lm_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{ "exception": { "class": "RuntimeException" } }'

Una llamada correcta devuelve un HTTP 202 Accepted:

{ "message": "accepted", "stored": true, "issue_id": "01kw6tkrd8wjbfv2pktr7ssw43" }

issue_id es el identificador público de la incidencia, un ULID. Es el mismo valor que lleva la URL del panel, así que puede registrarlo y pegarlo en la barra de direcciones. No es un número de fila, y la respuesta no incluye ningún contador de ocurrencias: esos números habrían indicado a cada proyecto cuántas excepciones había almacenado toda la plataforma.

En la práctica no fabricará estas peticiones a mano. Instale el cliente oficial para su stack, el SDK Laravel es la implementación de referencia, y configúrelo con la URL de su servidor y la clave de proyecto. El cliente se encarga de capturar las excepciones, de enviar los logs por lotes y de reportar el composer.lock.

5. Verificar la recepción

De vuelta en el panel /app, abra su proyecto desde Proyectos en la barra lateral. La primera excepción enviada aparece como una issue. Desde ahí puede explorar el seguimiento de excepciones, activar las alertas y desbloquear las funcionalidades de pago como los logs y el almacenamiento cifrado según su plan.

¿Está construyendo su propio cliente? El contrato completo de petición/respuesta de cada punto de entrada se encuentra en la referencia de la API de ingesta.