PHP

Biblioteca para aplicaciones PHP

Gratis en todos los planes, incluido el gratuito

Empezar gratis Documentación

Dónde conseguirlo

Ver en Packagist

Packagist

Requisitos PHP 8.2+ y Composer 2

Nombre del paquete dockcodes/dock-ray

Precios Gratis

Para qué sirve

El SDK oficial de DockRay para PHP permite integrar cualquier aplicación PHP con la plataforma de monitorización DockRay. Reporta automáticamente excepciones no controladas y errores de PHP, y permite monitorizar el tiempo de procesamiento de las solicitudes HTTP.

Monitorización de errores y excepciones de PHP

DockRay puede capturar automáticamente excepciones no controladas y errores críticos y enviarlos al panel de monitorización.

Los eventos reportados pueden incluir, entre otros datos:

el tipo y el contenido del error o 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,
etiquetas, datos del usuario y contexto adicional.

El SDK también permite reportar manualmente excepciones y mensajes, así como añadir información de diagnóstico personalizada mediante etiquetas, datos del usuario y breadcrumbs.

Monitorización del rendimiento

El SDK permite monitorizar las transacciones HTTP y el tiempo de procesamiento de las solicitudes. La frecuencia de recopilación de datos puede controlarse mediante una tasa de muestreo.

Monitorización de errores de JavaScript

El SDK de DockRay para PHP también proporciona herramientas para integrar la monitorización de errores de JavaScript. Los eventos del navegador se envían a través de la aplicación PHP, por lo que la clave privada del proyecto permanece en el servidor.

Diseñado para aplicaciones en producción

De forma predeterminada, los eventos se ponen en cola durante el procesamiento de la solicitud y se envían una vez preparada la respuesta. De este modo, una indisponibilidad temporal o una respuesta más lenta del servicio de monitorización no debería retrasar la respuesta de la aplicación al usuario.

Independiente del framework

El SDK de DockRay para PHP no requiere ningún framework específico y puede utilizarse en cualquier aplicación con PHP 8.2+. También sirve como base para las integraciones específicas de DockRay con frameworks y sistemas CMS populares.

Instalación

Instala el SDK de DockRay para PHP mediante Composer:

bash

composer require dockcodes/dock-ray

El paquete requiere PHP 8.2 o una versión posterior.

Configuración

Inicializa DockRay al iniciar la aplicación proporcionando el token del proyecto y la clave privada:

php

use function Dock\Ray\init;

init([
    'token' => 'PROJECT_TOKEN',
    'private_key' => 'PROJECT_PRIVATE_KEY',
    'environment' => 'production',
    'release' => '1.4.0',
]);

Encontrarás el token del proyecto y la clave privada en el panel de DockRay. Las credenciales también pueden proporcionarse mediante las variables de servidor RAY_TOKEN y RAY_PRIVATE_KEY.

Si no se configuran el token o la clave privada, el SDK permanecerá inactivo y no enviará ningún dato.

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 function Dock\Ray\captureException;

try {
    $order->settle();
} catch (\Throwable $exception) {
    captureException($exception);

    throw $exception;
}