Privacidad y enmascarado
Los valores por defecto de privacidad de los SDK, cada opción y atributo que enmascara más, cómo dejar fuera áreas enteras de tu app y cómo ver por ti mismo lo que se envía.
En esta página
- Los valores por defecto que no tienes que poner
- Enmascarar más
- Un elemento: data-sypnia-mask
- Un elemento, por completo: data-sypnia-block
- Sin tocar el HTML: maskSelector y blockSelector
- Todo el texto: maskAllText
- Dejar partes de la app fuera
- Pedir consentimiento
- beforeSend
- Lo que envías a propósito
- Ver lo que se envía
- Lo que ve el agente
- Sigue con
Esta página es para quien responde por lo que sale de la app. Da los nombres en código: opciones, atributos y funciones. Las reglas detrás de ellos, en palabras simples, están en Enmascarado y Qué se recoge. Todo lo de aquí ocurre dentro del SDK, en el navegador de la persona o en tu servidor, así que es igual para el motor de código abierto y para Sypnia Cloud.
Al final tendrás: una app en la que puedes decir, y comprobar, qué recibe Sypnia.
Los valores por defecto que no tienes que poner
| Por defecto | ¿Se puede apagar? |
|---|---|
Todo lo que una persona escribe se enmascara, siempre. Los campos de texto, las áreas de texto, las opciones elegidas en una lista y las áreas editables (contenteditable) se graban como asteriscos, uno por cada carácter. | No. No existe una opción para grabar lo que se escribe. |
| Los campos de contraseña, de tarjeta y de código de un solo uso se enmascaran. | No. |
| Los campos ocultos pierden su valor. | No. |
| Los eventos nunca llevan el valor de un campo: un clic en un campo reporta su etiqueta o su placeholder. | No. |
url es solo la ruta: sin origen, sin consulta, sin hash. Las rutas reemplazan los ids por :id. | No. |
| Los cuerpos de peticiones y respuestas, las cookies y los encabezados nunca se leen. De una llamada fallida a la API el SDK conserva un código de máximo 40 caracteres y un mensaje de máximo 160. | El código y el mensaje: sí, con capture.requestFailureDetail: false. |
Los correos en mensajes de error, pilas de error y mensajes de fallo se reemplazan por [email]. | No. |
| En el servidor, el mensaje de una llamada fallida a la base de datos o a un servicio se depura antes de salir: correos, URL, UUID, valores entre comillas, tokens largos y toda serie de dígitos. | No. |
Los parámetros de inicio de sesión (access_token, refresh_token, token, code) se quitan de los enlaces dentro de las grabaciones. | No. |
| Los marcos y los videos quedan fuera de las grabaciones. Los dibujos en canvas no se graban. Las imágenes no se copian. | No. |
Sin cookies. Dos ids aleatorios en localStorage, que no identifican a nadie. | Mira optOut más abajo. |
Lo que se graba tal como se ve, salvo que lo cambies: el texto que muestran tus páginas, y con él las etiquetas de lo que la gente toca.
Enmascarar más
Un elemento: data-sypnia-mask
<section data-sypnia-mask>
<h2>Dirección de envío</h2>
<p>Ada Park, Calle Olmo 12, Springfield</p>
</section>Dentro de él, las letras y los dígitos se vuelven asteriscos en grabaciones y capturas de página, ahora y cuando el contenido cambie después. Un clic dentro se reporta sin etiqueta. Úsalo para nombres, direcciones, montos, mensajes: cualquier texto que pertenezca a una persona.
Un elemento, por completo: data-sypnia-block
<div data-sypnia-block>
<img src="/documents/id-card.jpg" alt="Documento de identidad" />
</div>El elemento no se graba. La grabación muestra una caja vacía del mismo tamaño. Úsalo para imágenes, mapas, gráficas, widgets incrustados: cualquier cosa cuya sola forma diga demasiado.
Sin tocar el HTML: maskSelector y blockSelector
Para elementos a los que no puedes ponerles un atributo, como un widget de terceros:
init({
project: 'spk_7d1f0c9e4b8a2f6d3c5e1a9b0f4d8c2e',
maskSelector: '.customer-name, .order-total, [data-private]',
blockSelector: '#support-chat, .map',
});Todo el texto: maskAllText
init({
project: 'spk_7d1f0c9e4b8a2f6d3c5e1a9b0f4d8c2e',
maskAllText: true,
});Las grabaciones muestran entonces la disposición, los clics y el movimiento, con cada palabra reemplazada. Los eventos también cambian: los clics no llevan etiqueta ni contexto, y los fallos de formulario no llevan nombre de campo. Los problemas se vuelven más difíciles de leer («se hizo clic cinco veces en un botón» en vez de «se hizo clic cinco veces en Pagar»). Elígelo para una app sensible de punta a punta: salud, finanzas, cualquier cosa sobre menores.
Un proyecto también puede encenderlo para todos los navegadores a la vez, sin desplegar, con el ajuste del proyecto replay.mask_all_text. Basta con uno de los dos: el SDK enmascara todo el texto cuando lo dice la opción o el ajuste.
Dejar partes de la app fuera
| Quieres | Usa | Efecto |
|---|---|---|
| No grabar en algunas rutas | replay: { blockedRoutes: ['/account/cards'] } en init, o el ajuste del proyecto replay.blocked_routes | Ahí no hay grabación ni captura de página. La grabación se detiene al entrar y sigue al salir. Los eventos se siguen enviando, así que los problemas se siguen encontrando. El motor además rechaza grabaciones de las rutas de la lista del proyecto, para que una pestaña vieja no pueda enviarlas. |
| No grabar en ninguna parte | replay: false, snapshots: false | La grabadora nunca se carga. |
| Nada de nada en algunas rutas | ignoreRoutes: ['/admin'] | El SDK queda inactivo ahí: sin eventos, sin grabación. |
| Nada de nada para una persona | optOut() | Se recuerda en ese navegador hasta optIn(). |
| Cambiar o descartar un evento tú mismo | beforeSend | Mira abajo. |
Un texto en estas listas cubre la ruta y todo lo que cuelga de ella. Los ajustes del proyecto se cambian en la app en Sypnia Cloud, y con la API en cualquier motor.
Pedir consentimiento
Si tus visitantes deben aceptar antes de que empiece la analítica, arranca el SDK apagado y enciéndelo cuando acepten:
import { init } from '@sypnia/browser';
init({
project: 'spk_7d1f0c9e4b8a2f6d3c5e1a9b0f4d8c2e',
enabled: localStorage.getItem('analytics-consent') === 'yes',
});
export function onConsent(agreed: boolean) {
localStorage.setItem('analytics-consent', agreed ? 'yes' : 'no');
if (agreed) location.reload();
}Con enabled: false el SDK no guarda nada en el navegador y no envía nada. La recarga lo arranca para un visitante que acaba de aceptar.
beforeSend
La última palabra sobre cualquier evento. Corre en el navegador (o en tu servidor, en el SDK de Node) antes de que el evento entre a la cola.
init({
project: 'spk_7d1f0c9e4b8a2f6d3c5e1a9b0f4d8c2e',
beforeSend(event) {
if (event.type === 'error' && event.msg.includes('order #')) {
event.msg = event.msg.replace(/order #\w+/g, 'order #[id]');
}
if (event.type === 'custom' && event.name === 'internal_debug') return null;
return event;
},
});No se llama para el contenido de la grabación, que se enmascara con las reglas de arriba y no se puede editar evento por evento.
Lo que envías a propósito
Los valores por defecto cubren lo que el SDK recoge por su cuenta. Tres funciones envían lo que tú les das, tal como lo das:
identify()envía el id de la persona y, solo si los pasas, un nombre y un correo. Envía solo el id si no quieres datos personales en Sypnia. Mira Identificar personas.track()envía las propiedades que eliges. Nunca pases lo que una persona escribió.reportError()envía el mensaje del error. No armes mensajes de error con datos personales.
Ver lo que se envía
- Pon
debug: trueeninit. El SDK imprime cada evento en la consola antes de encolarlo, y dice por qué cuando no envía nada. - Abre las herramientas de desarrollo, pestaña Network, y filtra por
ingest. Los eventos van a…/v1/ingest/events, las grabaciones a…/v1/ingest/replay, las capturas de página a…/v1/ingest/snapshot. Los cuerpos de más de 2.048 caracteres van comprimidos con gzip. - Para revisar el enmascarado, escribe algo en un formulario, causa un error (para que la sesión se grabe) y mira la grabación: lo que escribiste son asteriscos. Un trozo de grabación lleva
mask: 1con las reglas por defecto ymask: 2cuando todo el texto está enmascarado.
Cada campo de cada evento está en el esquema de eventos.
Lo que ve el agente
El agente lee eventos: en qué se hizo clic, qué peticiones fallaron, qué error se lanzó. Nunca lee grabaciones ni lo que se escribió, y el contenido enmascarado nunca llega a Sypnia, así que no se puede enviar a un modelo. Mira Modelos y qué se envía.
Sigue con
- Las reglas en palabras simples, y qué hace exactamente el enmascarado.
- Quita los datos de una persona, o una sesión.
- Qué guarda
identify().