Docs

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.

Aplica a MotorNube Al lanzar

Ver como Markdown
En esta página
  1. Cuál necesitas
  2. Toda la API pública
  3. Páginas de esta sección

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 CloudMotor con alojamiento propio
A dónde envía el SDKhttps://ingest.sypnia.com, por defecto. No pones nada.La URL base de tu motor, en la opción endpoint.
De dónde sale la llaveLa página de tu proyecto en app.sypnia.com.sypnia project create, o la API.

npm

npm install @sypnia/browser
import { init } from '@sypnia/browser';

init({ project: 'YOUR_PROJECT_KEY' });

Guía de inicio completa

Cuál necesitas

Tu appUsaEstado
Cualquier cosa que corre en un navegador: React, Vue, Svelte, HTML simple, una app hecha con un constructor de IA@sypnia/browserAl lanzar
Una app Next.js@sypnia/next, que cubre el navegador y el servidorAl lanzar
Un servidor Node: Express, Fastify, Koa, NestJS, Hono@sypnia/nodeAl lanzar
Un backend en Python, Go, PHP, Rust, Java o cualquier otroOpenTelemetry: apunta tu exportador OTLP a SypniaAl lanzar
Una app móvil hecha como vista web@sypnia/browserAl lanzar
Una app nativa de iOS o AndroidLos 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/nodeQué 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ínoEnvía un evento propio.
flush()sísíEnvía lo que está esperando.
getSessionId()sínoEl id de la sesión actual.
optOut(), optIn()sínoDetiene y reanuda todo en un navegador.
span(name, fn)nosíRegistra un paso tuyo dentro de una petición.
shutdown()nosíEnvía lo que está esperando y se detiene.
wrapFetchHandler(handler)nosí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

  • Navegador

    Instalación, cada opción, qué se captura sin código.
  • Node

    Peticiones, llamadas salientes y errores de un servidor Node.
  • Next.js

    Una sola configuración para el cliente y el servidor, y source maps al compilar.
  • OpenTelemetry

    Cualquier otro backend, por OTLP/HTTP.
  • Privacidad y enmascarado

    Los valores por defecto, y cómo enmascarar más.
  • Identificar personas

    Personas, cuentas y sesiones anónimas.
  • Muestreo y cuotas

    Qué sesiones se graban, y qué pasa al llegar a un límite.
  • Solución de problemas

    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.

Secciones

Empieza aquíQué es Sypnia, cómo funciona, qué es código abierto y qué es la nube de pago, y las dos maneras de recibir tu primer problema en palabras claras.ConceptosLas diez ideas de las que está hecho Sypnia, cada una definida con precisión, desde un proyecto y sus llaves hasta los problemas, las trazas y las alertas.SDKCó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.El agenteCómo analiza Sypnia un problema, qué escribe, qué le envía a un modelo y qué nunca hace.MCP y skillsConecta tu agente de código a Sypnia para que pregunte qué está fallando en producción, lea lo que necesita para arreglarlo y configure Sypnia por ti.Referencia de la APILa API HTTP de Sypnia: una sola API para el motor de código abierto y para Sypnia Cloud, con cada endpoint, parámetro, respuesta y error.Referencia de la CLIEl comando sypnia: cómo instalarlo, qué variables lee, qué significan sus códigos de salida y dónde está documentado cada comando.Alojamiento propioQué corres cuando alojas tú mismo el motor de Sypnia, qué necesitas, cuánto cuesta y qué no tienes frente a Sypnia Cloud.Cómo está construido el motorTodo el motor de Sypnia en una página, desde un clic en tu app hasta la frase que lee tu agente de código, con las reglas de diseño y el código que las sostiene.Sypnia CloudCómo funciona el servicio pago, desde las organizaciones y los roles hasta los planes, los límites, la facturación, dónde viven tus datos, la GitHub App y el soporte.Privacidad y seguridadQué recoge Sypnia de tu app y de sus usuarios, qué no recoge nunca, cómo funciona el enmascarado, cómo eliminar datos y cómo se protege el servicio.LicenciasQué licencia cubre cada parte de Sypnia, qué puedes hacer con ella, cómo se puede usar el nombre, y los términos de una contribución.GuíasRecetas paso a paso para las formas comunes de usar Sypnia, desde apps hechas con constructores de IA y Next.js en Vercel hasta Supabase, source maps en CI, correos de alerta desde tu propio motor, y venir desde Sentry.ReferenciaLas páginas donde se consulta, desde el esquema de eventos y el glosario hasta lo planeado, el registro de cambios y las preguntas frecuentes.
↑↓ para moverte↵ para abrirEsc para cerrar