SDK
Cómo envía tu app los datos a Sypnia. Un SDK para el navegador, uno para Node, uno para Next.js, y la entrada de OpenTelemetry para cualquier otro backend.
En esta página
Un SDK es la pieza pequeña de Sypnia que vive dentro de tu app. Nota lo que pasa (un error, una página lenta, un clic que no hace nada) y lo envía a Sypnia como eventos.
Los SDK son de código abierto con licencia MIT y son los mismos para el motor de código abierto y para Sypnia Cloud. Cambian dos cosas, y cada página muestra las dos:
| Sypnia Cloud | Motor con alojamiento propio | |
|---|---|---|
| A dónde envía el SDK | https://ingest.sypnia.com, por defecto. No pones nada. | La URL base de tu motor, en la opción endpoint. |
| De dónde sale la llave | La página de tu proyecto en app.sypnia.com. | sypnia project create, o la API. |
npm
npm install @sypnia/browserimport { init } from '@sypnia/browser';
init({ project: 'YOUR_PROJECT_KEY' });pnpm
pnpm add @sypnia/browserimport { init } from '@sypnia/browser';
init({ project: 'YOUR_PROJECT_KEY' });yarn
yarn add @sypnia/browserimport { init } from '@sypnia/browser';
init({ project: 'YOUR_PROJECT_KEY' });bun
bun add @sypnia/browserimport { init } from '@sypnia/browser';
init({ project: 'YOUR_PROJECT_KEY' });script tag
<script async
src="https://ingest.sypnia.com/v1/sdk.js"
data-project="YOUR_PROJECT_KEY"></script>Sin paso de compilación y sin llamar a init: pégala antes de </head>. La etiqueta inicia Sypnia con la llave que va en data-project.
Cuál necesitas
| Tu app | Usa | Estado |
|---|---|---|
| Cualquier cosa que corre en un navegador: React, Vue, Svelte, HTML simple, una app hecha con un constructor de IA | @sypnia/browser | Al lanzar |
| Una app Next.js | @sypnia/next, que cubre el navegador y el servidor | Al lanzar |
| Un servidor Node: Express, Fastify, Koa, NestJS, Hono | @sypnia/node | Al lanzar |
| Un backend en Python, Go, PHP, Rust, Java o cualquier otro | OpenTelemetry: apunta tu exportador OTLP a Sypnia | Al lanzar |
| Una app móvil hecha como vista web | @sypnia/browser | Al lanzar |
| Una app nativa de iOS o Android | Los SDK nativos están planeados. Mira Planeado. | Planeado |
Una app web con su propio backend usa dos: el SDK del navegador en la página y un SDK de servidor (u OpenTelemetry) en el backend, ambos enviando al mismo proyecto. Eso es lo que le permite a Sypnia seguir un clic desde la página hasta la base de datos.
Toda la API pública
Tres paquetes, un puñado de funciones.
| Función | @sypnia/browser | @sypnia/node | Qué hace |
|---|---|---|---|
init(options) | sí | sí | Arranca el SDK. Una vez. |
identify(who) | sí | sí | Dice quién es la persona, y su cuenta. |
reportError(error) | sí | sí | Reporta un error que tu código capturó. |
track(name, props) | sí | no | Envía un evento propio. |
flush() | sí | sí | Envía lo que está esperando. |
getSessionId() | sí | no | El id de la sesión actual. |
optOut(), optIn() | sí | no | Detiene y reanuda todo en un navegador. |
span(name, fn) | no | sí | Registra un paso tuyo dentro de una petición. |
shutdown() | no | sí | Envía lo que está esperando y se detiene. |
wrapFetchHandler(handler) | no | sí | Traza una función que recibe un Request y devuelve un Response. |
@sypnia/next te da las funciones del navegador desde @sypnia/next/client, las del servidor desde @sypnia/next/server, y withSypnia para next.config.ts.
Páginas de esta sección
- Instalación, cada opción, qué se captura sin código.
- Peticiones, llamadas salientes y errores de un servidor Node.
- Una sola configuración para el cliente y el servidor, y source maps al compilar.
- Cualquier otro backend, por OTLP/HTTP.
- Los valores por defecto, y cómo enmascarar más.
- Personas, cuentas y sesiones anónimas.
- Qué sesiones se graban, y qué pasa al llegar a un límite.
- No llega nada, bloqueadores de anuncios, source maps, sesiones duplicadas.
La forma exacta de todo lo que envían los SDK es el esquema de eventos.