Instalación - Python

2 min de lectura Actualizado: 11.09.2026

Antes de empezar, crea un proyecto en el panel de DockRay. En sus ajustes encontrarás el token del proyecto - el identificador público que forma parte de la URL de ingesta - y en la pestaña Claves de API generarás una clave privada. La clave se muestra una sola vez, al generarla: DockRay guarda únicamente su hash. Si todavía no tienes un proyecto, empieza por Primeros pasos.

Requisitos

Python 3.9 o posterior,
un entorno con bucle de eventos asyncio - una aplicación ASGI, un script ejecutado con asyncio.run() o un worker con soporte async,
conexiones HTTPS salientes permitidas.

El paquete es un cliente asíncrono: cada método de reporte es una corrutina, así que su llamada siempre va precedida de await. Su única dependencia es httpx, que se instala junto con el paquete.

Instalación

bash

pip install dock-ray

Creación del cliente

A diferencia de las integraciones de PHP, aquí no hay una función global init(): creas una instancia de DockRayClient y la pasas allí donde se necesite:

python

from dock_ray import DockRayClient

client = DockRayClient(
    token="TOKEN_DEL_PROYECTO",
    private_key="CLAVE_PRIVADA_DEL_PROYECTO",
    environment="production",
)

Sin token ni clave el constructor no lanza ninguna excepción: client.enabled devuelve False y cada llamada de reporte termina de inmediato, sin intentar conectarse a la red. Así puedes crear el cliente incondicionalmente y dejar las credenciales fuera del entorno local. El paquete en sí no lee ninguna variable del servidor: es tu propio código el que decide de dónde vienen el token y la clave.

Reportar

python

try:
    settle(order)
except Exception as error:
    await client.capture_exception(error)

Cada método de reporte - capture_exception(), capture_message(), capture_transaction() - devuelve un bool: True cuando el panel acepta el evento, False en cualquier otro caso, incluida una cuenta que ha agotado su cupo de errores.

Cierre del cliente

Al apagar la aplicación llama a await client.close(): vacía las tareas en segundo plano pendientes y cierra el pool de conexiones de httpx. Omitir este paso en un script de vida corta puede cortar un envío a mitad de camino, antes de que el evento haya salido del proceso.

La primera prueba

python

import asyncio
from dock_ray import DockRayClient

async def main():
    client = DockRayClient(token="TOKEN_DEL_PROYECTO", private_key="CLAVE_PRIVADA_DEL_PROYECTO")
    await client.capture_message("Mensaje de control DockRay")
    await client.close()

asyncio.run(main())

El mensaje debería aparecer en el panel, en la sección Errores del proyecto al que apunta el token.