Laravel

Paquete para Laravel 10+

Gratis en todos los planes, incluido el gratuito

Empezar gratis Documentación

Dónde conseguirlo

Ver en Packagist

Packagist

Requisitos Laravel 10+, PHP 8.2+

Nombre del paquete dockcodes/dock-ray-laravel

Precios Gratis

Para qué sirve

El paquete oficial de DockRay integra aplicaciones Laravel con la plataforma de monitorización y permite reportar automáticamente excepciones y monitorizar el tiempo de procesamiento de las solicitudes HTTP. Los eventos se envían directamente al panel de DockRay junto con la información necesaria para diagnosticar rápidamente los problemas.

Monitorización de errores y excepciones

DockRay se integra con el mecanismo de reporte de excepciones de Laravel y permite enviar automáticamente los errores de la aplicación a un único panel de monitorización.

Los eventos reportados pueden incluir, entre otros datos:

el tipo y el contenido de la excepción,
el lugar donde se produjo y el stack trace,
información sobre el entorno y la versión de la aplicación,
el contexto de la solicitud procesada.

Puedes excluir determinadas clases de excepciones del reporte. DockRay también respeta la configuración estándar dontReport de Laravel.

Monitorización del rendimiento

El paquete puede monitorizar el tiempo de procesamiento de las solicitudes HTTP para determinados grupos de middleware, como web y api. Las transacciones se agrupan según el patrón de la ruta, por lo que las solicitudes a una misma ruta se analizan conjuntamente independientemente de los identificadores proporcionados.

La frecuencia con la que se recopilan los datos de las transacciones puede controlarse mediante una tasa de muestreo.

Contexto del usuario y privacidad

Opcionalmente, DockRay puede incluir en los eventos información sobre el usuario que ha iniciado sesión, como su identificador, dirección de correo electrónico y nombre. El envío de la dirección IP y del user agent se controla mediante un ajuste independiente y no tiene que estar activado de forma predeterminada.

Colas y comandos Artisan

Los errores que se producen en las colas y en los procesos de consola también pueden reportarse a DockRay. Como se ejecutan fuera de la pila de middleware HTTP, no generan transacciones de rendimiento.

Reporte seguro

Los métodos de reporte de DockRay no lanzan excepciones, por lo que una indisponibilidad temporal de la plataforma de monitorización no interfiere con la gestión estándar de errores de la aplicación.

Instalación

Instalación del paquete

Instala DockRay mediante Composer:

bash

composer require dockcodes/dock-ray-laravel

A continuación, publica el archivo de configuración:

bash

php artisan vendor:publish --tag=ray-config

Laravel detecta automáticamente el Service Provider, por lo que no es necesario registrarlo manualmente.

Configuración

Añade las credenciales del proyecto de DockRay al archivo .env:

RAY_TOKEN=project-token
RAY_PRIVATE_KEY=project-private-key
RAY_TRACES_SAMPLE_RATE=0.2

Encontrarás el token del proyecto y la clave privada en el panel de DockRay. Si no se configuran los valores RAY_TOKEN y RAY_PRIVATE_KEY, el paquete permanecerá inactivo y no enviará ningún dato.

El resto de los ajustes de la integración se encuentran en el archivo config/ray.php.

Cómo usarlo

La integración informa de las excepciones por sí sola. Esto es para los informes que envías a propósito.

php

<?php

use Dock\Ray\Laravel\Ray;
use Illuminate\Foundation\Configuration\Exceptions;

->withExceptions(function (Exceptions $exceptions) {
    $exceptions->reportable( fn (Throwable $exception) => Ray::report($exception) );
})