Configuración
El plugin se configura desde una única pantalla en wp-admin. Tras la activación, vaya a Ajustes → Quiet Guard (se requiere un usuario con la capacidad manage_options).
Todos los valores se almacenan juntos en una única opción de WordPress llamada laravel_monitor_options, dentro del grupo de ajustes laravel_monitor. El formulario es una página estándar de la API Settings de WordPress, titulada Quiet Guard, con una única sección Connection.
Campos
La pantalla de ajustes expone los campos siguientes:
| Etiqueta del campo | Clave de opción | Ejemplo | Observaciones |
|---|---|---|---|
| Enabled (1/0) | enabled | 1 | Interruptor principal. Cualquier valor no vacío se guarda como 1; un valor vacío se convierte en 0. La captura solo comienza si este campo está activo y la clave está definida; una URL vacía equivale al servicio alojado. |
| Server URL | url | https://monitor.example.com | URL base de su servidor Quiet Guard. Saneada con esc_url_raw. El plugin añade por sí mismo /api/v1/ingest, y un valor que ya termina en /api o /api/v1 se acepta: el sufijo se retira en lugar de duplicarse, de modo que pegar la dirección de la API funciona igual que pegar la del servidor. Vacía equivale al servicio alojado https://quietguard.dev, así que un sitio que lo use solo tiene que pegar su clave. |
| Project key | key | lm_xxxxxxxx | La clave de API propia del proyecto, obtenida en su panel Quiet Guard. Enviada como token HTTP Authorization: Bearer. Saneada con sanitize_text_field. |
| Environments (comma-separated, empty = all) | environments | production,staging | Lista opcional de nombres de entornos. Vea la nota más abajo sobre su comportamiento actual. |
| Release (optional) | release | 2024.05.1 o un SHA de git | Identificador de la versión desplegada. Se adjunta a cada evento reportado para que el servidor pueda vincular los problemas a un despliegue. |
Los cinco campos se muestran como simples campos de texto. Haga clic en Guardar cambios para guardarlos.
Configuración mínima
Para empezar a reportar errores, bastan dos elementos:
- Enabled con el valor
1. - Project key, creada al añadir el proyecto en el panel Quiet Guard. Consulte la documentación del servidor para saber cómo se crean los proyectos y las claves.
Server URL solo se rellena para una instancia autoalojada, con la URL base de su servidor (un /api o /api/v1 final se retira por usted): vacía, equivale al servicio alojado.
Si el plugin está activado pero la clave está vacía, no se envía nada y no se lanza ningún error, el plugin simplemente permanece en silencio. Una URL vacía no lo detiene: los informes van al servicio alojado.
Cómo se envía la clave
Los informes se envían mediante una petición HTTPS POST a {Server URL}/api/v1/ingest, con la clave de proyecto en la cabecera Authorization: Bearer … y un cuerpo JSON. La petición está acotada por un tiempo de espera corto para que un servidor lento o inaccesible nunca bloquee la página.
Release
Definir una Release permite al servidor agrupar los problemas por despliegue. Un SHA de git hexadecimal es ideal, porque el servidor puede entonces vincular la release de un problema con el commit correspondiente que ha sincronizado para el proyecto. Actualice este valor en cada despliegue.
Sobre el campo Environments
El campo Environments se almacena y se transmite a la configuración del núcleo subyacente, donde está concebido como una lista blanca de entornos desde los que reportar los errores (vacía significa "reportar desde todas partes").
En la versión actual, el adaptador WordPress no calcula ningún "entorno actual" con el que comparar: esta lista todavía no tiene ningún efecto de filtrado, cualquier error capturado se reporta sea cual sea el valor introducido. El campo está cableado por anticipación; el filtrado por entorno para WordPress está previsto. Para dejar de reportar los errores de un sitio hoy, desactive Enabled.
Opciones avanzadas (ausentes de la interfaz)
Tres claves adicionales se leen desde la misma opción laravel_monitor_options pero no están expuestas en la pantalla de ajustes: usan por tanto sus valores por defecto, salvo que se definan por programa (por ejemplo mediante update_option):
| Clave de opción | Por defecto | Función |
|---|---|---|
timeout | 3 | Tiempo de espera HTTP, en segundos, para cada informe. |
trace_limit | 0 | Frames de pila enviados por excepción. 0 (el valor por defecto) envía la traza de pila completa; un valor positivo recorta la traza a ese número de frames. El punto de lanzamiento, al principio de la pila desde la versión 0.3, cuenta como un frame. |
code_snippets | true | Envía, con cada frame de su propio código, las cinco líneas de código a cada lado de la suya. Nunca para una dependencia; una línea que nombra una clave de enmascaramiento y le da un valor se enmascara entera. false envía solo el archivo y la línea. |
Puede definir estos valores por programa sin riesgo: el saneador de ajustes conserva timeout, trace_limit y code_snippets en los guardados desde la pantalla de ajustes, por lo que un valor escrito mediante update_option() sobrevive a los guardados posteriores desde wp-admin.
Siguiente paso
Continúe con el Uso para ver qué captura el plugin y cómo confirmar que funciona.
Está leyendo la documentación WordPress Plugin v1.0.