Documentazione / Ricette / Ricette
Log legati alla stessa richiesta
I messaggi della tua app Rails si mettono accanto all'errore che spiegano, richiesta per richiesta.
Quando qualcosa si rompe, l'errore da solo ti dice dove. I log scritti durante la stessa richiesta ti dicono perché: quale ordine, quale passaggio, quale risposta da fuori. Con la gem Rails ogni log porta l'identificativo della sua richiesta, e CloseYourIt mette uno accanto all'altro log ed errori della stessa richiesta.
1. Crea il progetto e il token
- In CloseYourIt crea un progetto per l'app, per esempio
shop. - Nelle impostazioni del progetto crea un token di ingest.
- Copia il
tokensegreto, che comincia concyi_, e l'id del progetto. Tieni il token nell'ambiente del server, mai nel codice.
2. Installa la gem
# Gemfile
gem "closeyourit-ruby"
bundle install
3. Configurala, con i log di Rails
# config/initializers/closeyourit.rb
CloseYourIt.init do |c|
c.endpoint_url = "https://bugs.example.com"
c.token = ENV["CLOSEYOURIT_TOKEN"]
c.project_id = ENV["CLOSEYOURIT_PROJECT_ID"]
c.environment = Rails.env
# Manda anche le righe di Rails.logger, da warn in su.
c.capture_rails_logs = true
end
Imposta CLOSEYOURIT_TOKEN e CLOSEYOURIT_PROJECT_ID nell'ambiente dell'app pubblicata, poi pubblicala.
capture_rails_logs inoltra solo da warn in su: a livello info Rails scrive una riga per ogni richiesta e riempirebbe l'elenco. La gem non manda niente dagli ambienti development e test. Per provare dal tuo computer aggiungi c.disabled_environments = [], e toglilo quando hai finito.
4. Scrivi i tuoi log
Aggiungi messaggi dove la storia conta, con i dati che la spiegano:
CloseYourIt.log(:info, "Order created", order_id: order.id, items: order.items.count)
CloseYourIt.log(:warning, "Payment retry", order_id: order.id, attempt: 2)
Dentro una richiesta ogni messaggio prende da solo l'identificativo della richiesta: quello che Rails assegna già. Nei lavori in background l'identificativo è quello del lavoro, così si allineano anche i log e l'errore dello stesso lavoro. Non devi passare niente.
I messaggi sotto info non partono. I valori il cui nome contiene token, email, card o altre parole sensibili escono dall'app come [FILTERED].
5. Segui una richiesta
Quando succede un errore in una richiesta che ha scritto log:
- Apri l'errore in Errori.
- Apri la scheda Log della richiesta: i messaggi scritti mentre succedeva, in ordine.
- Vedi tutti i log di questa richiesta apre l'elenco completo in Log, filtrato su quella richiesta.
Da un messaggio, al contrario:
- Apri Log e il messaggio.
- Questa richiesta elenca gli altri log della stessa richiesta, Errori di questa richiesta gli errori.
Puoi anche incollare l'identificativo di una richiesta nella ricerca di Log, o usare il terminale:
cyi logs list --trace-id <trace-id>
6. Collega un messaggio senza identificativo
Un messaggio scritto fuori dalla richiesta, per esempio da uno script programmato, non porta l'identificativo. Collegalo a mano:
- Apri il messaggio.
- In Collegato a premi Collega a errore/ticket.
- Cerca l'errore per titolo, poi premi Collega.
Il messaggio compare in Log collegati sulla pagina dell'errore. Serve il permesso «Collega un registro a un ticket».
Per quanto restano
I log si tengono 14 giorni, poi vengono cancellati da soli. Per tenerli di più per un progetto, aprilo, poi Impostazioni e Retention log (giorni).