Documentazione / Collega
Dati inviati dagli SDK
Per ogni SDK, cosa manda da solo, cosa solo se lo accendi e cosa non esce mai dalla tua app.
Questa pagina è scritta dal codice dei quattro SDK: JavaScript, Ruby, Python e Dart. Per ognuno dice cosa esce dalla tua app con le impostazioni di base, cosa esce solo se lo accendi e cosa viene nascosto prima dell'invio. I quattro SDK non nascondono esattamente gli stessi campi: le differenze sono nella tabella qui sotto.
Tutto va solo all'indirizzo della tua installazione, mai a terzi. All'arrivo il server ripulisce di nuovo i dati.
Cosa non esce mai
Queste regole valgono in tutti e quattro gli SDK. Le prime due non si spengono:
- Il valore di un campo sensibile. Quando il nome di un campo contiene una delle parole della tabella qui sotto, il suo valore esce come
[FILTERED]. Vale per tag, contesto, dati extra e gli oggetti dentro di loro. - Le credenziali scritte in un testo. Nei messaggi d'errore e nelle righe di log, una credenziale scritta come intestazione o dopo il suo schema, come
Authorization: Bearer …, viene sostituita da[FILTERED]. Il resto della frase resta leggibile. - Chi è l'utente. Dell'utente che imposti esce solo l'
id. Email, nome e indirizzo IP escono solo con l'interruttore dei dati personali (sendPiiosend_pii), che è spento.
Un campo si riconosce dal nome, non dal contenuto: un numero di carta in un campo chiamato number non viene nascosto. Dai ai campi nomi che dicono cosa contengono. In Ruby e in Python puoi aggiungere nomi tuoi con filter_parameters.
L'indirizzo della pagina precedente fa eccezione alla regola della query string. Gli SDK tolgono la query string dagli indirizzi che costruiscono, ma tre punti mandano l'indirizzo della pagina precedente come l'ha scritto il browser o l'app, query string compresa, anche con l'interruttore dei dati personali spento: le visite di JavaScript (trackPageviews), l'intestazione Referer in Ruby e l'intestazione Referer in Dart. Se i tuoi indirizzi portano token o dati personali nella query string, leggi le note di ogni SDK qui sotto.
Campi nascosti, SDK per SDK
Un campo è nascosto quando il suo nome contiene la parola: user_password, X-Api-Key e credit_card_number sono tutti nascosti. Ruby e Python ignorano anche trattini e trattini bassi, quindi E-Mail vale come email.
| Il nome contiene | JavaScript | Ruby | Python | Dart |
|---|---|---|---|---|
pass (password, passphrase, passport) | sì | sì | sì | sì |
secret, token, api_key, apikey, authorization | sì | sì | sì | sì |
cookie, csrf | sì | sì | sì | sì |
credit, card, cvv, iban, ssn | sì | sì | sì | sì |
email | sì | sì | sì | sì |
phone, telephone, mobile | no | sì | sì | sì |
dob, birth | no | sì | sì | sì |
bearer, session | no | sì | sì | sì |
pin, pan | no | sì | sì | sì |
Cercare una parte del nome nasconde più del necessario: in Ruby, Python e Dart company_name contiene pan e shipping contiene pin, quindi sono nascosti tutti e due. È una scelta voluta: meglio un valore nascosto che uno uscito.
Anche dentro un testo gli SDK sono diversi. JavaScript, Python e Dart nascondono anche una coppia scritta come nome=valore quando il nome è sensibile, per esempio password=… in un messaggio d'errore. Ruby nasconde solo l'intestazione Authorization e le credenziali dopo Bearer, Basic o Token: per le altre coppie aggiungi modelli tuoi con scrub_message_patterns.
JavaScript
Pacchetto @bussolabs/closeyourit-js, nel browser e su Node.
Da solo:
- gli errori: eccezioni non gestite e Promise rifiutate, con tipo, messaggio e stack trace;
- la pagina dell'errore: indirizzo senza query string e senza frammento, lo User-Agent del browser, la pagina da cui arrivava il visitatore senza query string;
- gli ultimi 50 passi prima dell'errore: clic, navigazione, messaggi della console e richieste HTTP, con indirizzi senza query string;
- i log che scrivi, da
infoin su; - l'
iddell'utente, se lo imposti, e i tag e il contesto che aggiungi; - gli eventi che mandi con
captureEvent, con gli stessi campi di una visita (veditrackPageviewsqui sotto); - solo su Node, il nome della macchina (
sendServerName).
Solo se lo accendi:
sendPii: negli errori, l'indirizzo della pagina e la pagina da cui arrivava il visitatore con tutta la loro query string, e l'utente intero (email, nome, IP);trackPageviews: le visite alle pagine, senza cookie, con il nome del sito, il percorso senza query string, i cinque parametriutm_, la larghezza dello schermo e l'indirizzo intero della pagina da cui arrivava il visitatore. Quell'indirizzo tiene la sua query string anche consendPiispento: se le pagine che portano alla tua ci mettono token o dati personali, togli il camporeferrerinbeforeSend;replay: la registrazione della sessione. I campi in cui si scrive e tutto il testo della pagina sono mascherati, a meno che tu non scelga altrimenti. Un cookie di sessione,cyi_replay, contiene solo un codice casuale che lega la registrazione agli errori del server;trackWebVitals,captureResourceErrors,detectPerformanceIssues: la velocità della pagina, le risorse che non si caricano (indirizzo senza query string), le chiamate lente o ripetute;captureMethodArguments: gli argomenti dei blocchi che misuri conmeasure(), con i nomi sensibili nascosti;usageEnabled, solo su Node: quali rotte e quali lavori girano davvero.
Se il browser del visitatore chiede di non essere tracciato, visite, eventi e registrazione si fermano; errori e log continuano ad arrivare (respectDoNotTrack, acceso di base). Nel browser l'SDK non usa mai il token segreto: con il solo token resta spento.
Ruby
Gem closeyourit-ruby, per le app Rails.
Da sola:
- gli errori, dalle richieste, dai lavori ActiveJob e Sidekiq e da
Rails.error.report, con lo stack trace e 3 righe di codice intorno a ogni passaggio; - la richiesta dell'errore: metodo, indirizzo senza query string, e solo le intestazioni
Accept,Content-Type,User-AgenteReferer. MaiAuthorizationnéCookie. IlRefereresce come l'ha mandato il browser, query string compresa: per lasciarlo fuori, toglilo darequest_header_allowlist; - il nome della macchina;
- le query lente, con ogni valore dell'SQL sostituito da
?, e i metodi lenti; - le metriche dei lavori in background;
- i log che scrivi con
CloseYourIt.log, dainfoin su; - quali rotte, lavori e chiavi girano davvero, come
Controller#action, mai l'indirizzo; - l'
iddell'utente, se lo imposti.
Dagli ambienti development e test non manda proprio niente.
Solo se lo accendi:
send_pii: la query string, l'indirizzo IP del visitatore, i campi del corpo della richiesta (con i nomi sensibili nascosti) e l'utente intero;capture_query_bindings: i valori delle query, con i nomi di colonna sensibili nascosti;capture_method_arguments: gli argomenti dei metodi misurati;capture_rails_logs: le righe diRails.logger, dawarnin su;detect_performance_issues: N+1, troppe query, richieste e chiamate lente;capture_console_errors: gli errori dirails consoleerails runner;propagate_trace_context: l'identificativo della richiesta passato ai servizi che chiami.
Python
Pacchetto closeyourit, lato server.
Da solo:
- gli errori non gestiti, con lo stack trace;
- la richiesta dell'errore: metodo, indirizzo e percorso senza query string, e solo le intestazioni
Accept,Content-TypeeUser-Agent; - i log che mandi;
- con l'integrazione SQLAlchemy, le query lente, con ogni valore tolto dall'SQL;
- con l'integrazione Celery, la durata dei task; e la durata dei blocchi che misuri;
- l'
iddell'utente, se lo imposti.
Nei dati che aggiungi, i valori sotto nomi come url o referrer perdono la query string, e una query string tiene i suoi parametri con i nomi sensibili nascosti. Intestazioni come Authorization, Cookie, X-Forwarded-For e X-Real-IP sono sempre nascoste.
Solo se lo accendi:
send_pii: l'utente intero;CLOSEYOURIT_USAGE_ENABLED: quali rotte e quali lavori girano davvero;http_capture_hosts: le chiamate che la tua app fa verso gli host che elenchi, con indirizzi senza query string;trace_propagation_enabled: l'identificativo della richiesta passato agli host che elenchi.
Dart
Pacchetto closeyourit, per le app Flutter.
Da solo:
- le eccezioni non gestite, con lo stack trace. Senza rete vengono salvate sul dispositivo, al massimo 50, e mandate all'avvio successivo;
- l'app e il dispositivo: versione e build dell'app, nome del pacchetto, modello e produttore del dispositivo, se è un simulatore, sistema e sua versione;
- le richieste HTTP fatte con Dio, dopo che aggiungi il suo interceptor: metodo, indirizzo senza query string, e solo le intestazioni
Accept,Content-Type,User-AgenteReferer. UnRefererche imposta la tua app esce come l'hai scritto, query string compresa: per lasciarlo fuori, toglilo darequestHeaderAllowlist; - i log che scrivi con
CloseYourIt.log, dainfoin su; - l'
iddell'utente, se lo imposti, e i tag e il contesto che aggiungi.
Solo se lo accendi:
sendPii: la query string delle richieste, con i parametri sensibili nascosti, e l'utente intero. Anche così la parteutente:password@di un indirizzo e il frammento non escono mai;captureLifecycleBreadcrumbs: quando l'app va in secondo piano e torna;captureConnectivityBreadcrumbs: il tipo di rete, mai il suo nome o indirizzo;captureTapBreadcrumbs: che c'è stato un tocco e su quale schermata, mai cosa è stato scritto;detectPerformanceIssues: scatti dell'interfaccia, troppe ricostruzioni, chiamate lente o ripetute;captureMethodArguments: gli argomenti dei blocchi che misuri;propagateTraceContext: l'identificativo della richiesta, solo verso gli host che elenchi;usageEnabled: quali parti dell'app girano davvero, come le segni conCloseYourIt.used. Serve iltokensegreto, quindi un'app che distribuisci con lapublicKeynon manda niente anche se è acceso.
Un'app distribuita usa la publicKey, mai il token segreto.