Documentazione / Ricette / Ricette
Un avviso su Telegram quando un pagamento fallisce
La tua app Rails scrive il pagamento fallito, e il messaggio ti arriva in una chat Telegram.
Ricevi un messaggio su Telegram ogni volta che un pagamento fallisce nella tua app Rails, con il collegamento ai dettagli. L'app scrive il fallimento come log di livello error, una regola lo trasforma in avviso e le tue preferenze mandano quell'avviso su Telegram.
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 due valori: il
tokensegreto, che comincia concyi_, e l'id del progetto.
Il token è segreto: tienilo nell'ambiente del server, mai nel codice.
2. Installa la gem
# Gemfile
gem "closeyourit-ruby"
bundle install
3. Configurala
# 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
end
Imposta CLOSEYOURIT_TOKEN e CLOSEYOURIT_PROJECT_ID nell'ambiente dell'app pubblicata, poi pubblicala.
La gem non manda niente dagli ambienti development e test. Per provare la ricetta dal tuo computer aggiungi c.disabled_environments = [] al blocco, e toglilo quando hai finito.
4. Scrivi il pagamento fallito
Dove il tuo codice addebita il cliente, scrivi un log di livello error quando l'addebito fallisce:
def charge(order)
PaymentGateway.charge!(order)
rescue PaymentGateway::Error => e
CloseYourIt.log(:error, "Payment failed", order_id: order.id, reason: e.message)
raise
end
PaymentGateway sta per la libreria che usi già. raise lascia proseguire l'errore come prima: CloseYourIt lo registra anche in Errori, con le righe di codice da cui è passato.
Dai agli attributi nomi semplici, come order_id e reason. I valori il cui nome contiene card, token, email o altre parole sensibili escono dall'app come [FILTERED], di proposito.
5. Collega Telegram
Il bot si crea una volta per tutta l'installazione, da chi gestisce il server:
- Crea un bot con BotFather su Telegram.
- In
/opt/closeyourit/.envimpostaTELEGRAM_BOT_TOKEN,TELEGRAM_BOT_USERNAMEeTELEGRAM_WEBHOOK_SECRET, poi lanciacloseyourit restart. - Registra il bot una volta:
cd /opt/closeyourit
docker compose exec app bin/rails telegram:set_webhook
docker compose exec app bin/rails telegram:set_commands
Poi ognuno collega la propria chat:
- In Preferenze → Notifiche accendi Telegram e premi Collega Telegram: si apre la chat con il bot.
- Nella chat premi Avvia (in inglese Start).
- Torna nella pagina: quando leggi «Collegato come», la chat è pronta.
6. Crea la regola di avviso
- Apri Avvisi → Regole di avviso e premi Nuova regola.
- Nome:
Pagamento fallito. - Evento: Log error/fatal.
- Progetto:
shop. Ambiente:production. - Raggruppa avvisi ripetuti: per esempio 10 minuti, così una raffica di fallimenti diventa un messaggio solo.
- Premi Salva regola.
La regola scatta per ogni log error o fatal di quel progetto. Con questa configurazione la gem manda solo i log che scrivi tu, quindi tieni il livello error per le cose che una persona deve guardare.
7. Manda l'avviso su Telegram
- Apri Preferenze → Notifiche.
- Trova nell'elenco l'avviso dei log di errore: il campo di ricerca lo trova per nome.
- Nella sua colonna Telegram scegli Ogni volta.
Le ore silenziose trattengono solo le email: i messaggi Telegram non vengono ritardati.
8. Provala
Fai fallire un pagamento dove la gem manda i dati, per esempio con una carta che il tuo fornitore di pagamenti rifiuta in modalità di prova. I log escono dall'app ogni 5 secondi: in pochi secondi il messaggio arriva su Telegram, con il collegamento al log. Lo stesso messaggio è in Log, con il filtro Livello su error.
Se non arriva niente
- L'app gira in
developmentotest: lì la gem resta muta (vedi il passo 3). - Il Progetto o l'Ambiente della regola non corrispondono all'app.
- In Preferenze → Notifiche la colonna Telegram di quell'avviso non è Ogni volta.
- Telegram non mostra «Collegato come»: ripeti il passo 5.