README.it.md

🇺🇸 English | 🇸🇦 العربية | 🇪🇸 Català | 🇨🇿 Čeština | 🇩🇪 Deutsch | 🇪🇸 Español | 🇫🇮 Suomi | 🇫🇷 Français | 🇮🇹 Italiano | 🇯🇵 日本語 | 🇧🇷 Português (Brasil) | 🇷🇺 Русский | 🇹🇭 ไทย | 🇹🇷 Türkçe | 🇺🇦 Українська | 🇻🇳 Tiếng Việt | 🇨🇳 简体中文 | 🇹🇼 繁體中文

Checkmate

Un'applicazione open source per il monitoraggio di uptime e infrastruttura

Questo repository contiene sia il frontend che il backend di Checkmate, uno strumento di monitoraggio open source e self-hosted per tenere sotto controllo l'hardware dei server, l'uptime, i tempi di risposta e gli incidenti in tempo reale, con visualizzazioni accattivanti. Checkmate verifica regolarmente se un server o un sito web è raggiungibile e funziona in modo ottimale, fornendo avvisi e report in tempo reale su disponibilità, tempi di inattività e tempi di risposta dei servizi monitorati.

Checkmate dispone anche di un agente, chiamato Capture, per raccogliere dati dai server remoti. Anche se Capture non è necessario per far funzionare Checkmate, offre informazioni aggiuntive su CPU, RAM, disco e temperatura dei tuoi server. Capture può essere eseguito su Linux, Windows, Mac, Raspberry Pi o qualsiasi altro dispositivo in grado di eseguire Go.

Checkmate è stato sottoposto a stress test con oltre 1000 monitor attivi senza problemi particolari né colli di bottiglia nelle prestazioni.

📚 Indice

• 📦 Demo
• 🔗 Guida utente
• 🛠️ Installazione
• 🚀 Prestazioni
• 💚 Domande e idee
• 🧩 Funzionalità
• 🏗️ Screenshot
• 🏗️ Tech stack
• 🔗 Alcuni link
• 🤝 Come contribuire

Demo

Puoi vedere l'ultima build di Checkmate in azione.

Il nome utente è demouser@demo.com e la password è Demouser1! (una nota: aggiorniamo il server demo di tanto in tanto, quindi se non dovesse funzionare, scrivici sul canale Discussions).

Guida utente

Le istruzioni per l'uso sono disponibili qui.

Prerequisiti

• Docker installato
• Git installato

Installazione

Consulta le istruzioni di installazione nel portale della documentazione di Checkmate.

In alternativa, puoi usare Coolify, Elestio, K8s, Sive Host (Sudafrica), Cloudzy o Pikapods per creare rapidamente un'istanza di Checkmate. Se desideri monitorare l'infrastruttura dei tuoi server, ti servirà l'agente Capture. Anche il repository di Capture contiene le istruzioni di installazione.

Usare una CA personalizzata

Se hai bisogno di monitorare endpoint HTTPS interni con certificati emessi da Autorità di Certificazione (CA) private (come Smallstep), consulta la nostra Guida all'attendibilità delle CA personalizzate per le opzioni di configurazione di Docker.

Per ulteriore documentazione, consulta la cartella docs.

Prestazioni

Grazie a numerose ottimizzazioni, Checkmate opera con un consumo di memoria estremamente ridotto, richiedendo risorse minime di memoria e CPU. Ecco l'utilizzo di memoria di un'istanza Node.js in esecuzione su un server che monitora 323 server ogni minuto:

Puoi vedere il consumo di memoria di MongoDB e Redis sullo stesso server (398Mb e 15Mb) per lo stesso numero di server:

Domande e idee

Se hai domande, suggerimenti o commenti, hai diverse opzioni:

• Canale Discord (preferito)
• GitHub Discussions (controlliamo di tanto in tanto)

Non esitare a fare domande o a condividere le tue idee: ci farebbe piacere sentirti!

Funzionalità

• Completamente open source, distribuibile sui tuoi server o su dispositivi domestici (es. Raspberry Pi 4 o 5)
• Diverse opzioni di monitoraggio: Uptime, Docker, Ping, SSL, Port, Game server
• Monitoraggio della velocità delle pagine
• Monitoraggio dell'infrastruttura (memoria, utilizzo del disco, prestazioni della CPU, rete, ecc.) - richiede l'agente Capture
  • Monitoraggio selettivo dei dischi con selezione del mountpoint
• Incidenti a colpo d'occhio
• Pagine di stato con 4 temi curati
• Notifiche via E-mail, Webhook, Discord, Slack, PagerDuty, Matrix, Microsoft Teams, Telegram, Pushover, Twilio (SMS)
• Manutenzione programmata
• Monitoraggio tramite query JSON
• Supporto multilingua per arabo, cinese (semplificato), cinese (tradizionale, Taiwan), ceco, inglese, finlandese, francese, tedesco, giapponese, portoghese (Brasile), russo, spagnolo, thailandese, turco, ucraino e vietnamita

Ciclo di vita del monitor

1. Un monitor esegue un controllo (HTTP / ping / port / hardware tramite l'agente Capture)
2. Il risultato viene memorizzato (successo/errore + tempo di risposta)
3. I risultati dei controlli recenti vengono valutati rispetto alla soglia di cambio stato configurata per il monitor
4. Se la soglia di cambio stato del monitor viene raggiunta e lo stato attuale è diverso da quello precedente, lo stato del monitor cambia (es. initializing, up, down, breached)
5. Al cambio di stato: viene creato o risolto un incidente, a seconda dello stato attuale del monitor
6. Le notifiche vengono attivate in base alla configurazione

Screenshot

Tech stack

• ReactJs
• MUI (framework React)
• Node.js
• MongoDB
• Recharts
• Tanti altri componenti open source!

Alcuni link

• Se vuoi supportarci, valuta di lasciare una ⭐ e di cliccare su "watch".
• Hai una domanda o un suggerimento per la roadmap o le funzionalità? Dai un'occhiata al nostro canale Discord o al forum Discussions.
• Vuoi ricevere una notifica quando esce una nuova release? Usa Newreleases, un servizio gratuito per tenere traccia delle release.
• Guarda un video di installazione e utilizzo di Checkmate

Come contribuire

Siamo Alex (team lead), Gorkem, Aryaman, Mert e Karen, e aiutiamo privati e aziende a monitorare la propria infrastruttura e i propri server.

Siamo orgogliosi di costruire legami solidi con i contributori a ogni livello. Pur essendo un progetto giovane, Checkmate ha già raccolto oltre 7000 stelle e attirato più di 90 contributori da tutto il mondo.

Il nostro repository ha ricevuto una stella da dipendenti di Google, Microsoft, Intel, Cisco, Tencent, Electronic Arts, ByteDance, JP Morgan Chase, Deloitte, Accenture, Foxconn, Broadcom, China Telecom, Barclays, Capgemini, Wipro, Cloudflare, Dassault Systèmes e NEC, quindi non trattenerti: unisciti a noi, contribuisci e impara con noi!

Ecco come puoi contribuire:

0. Metti una stella a questo repository :)
1. Consulta la guida per i contributori. Chi è alle prime armi è incoraggiato a controllare il tag good-first-issue.
2. Leggi una descrizione dettagliata della struttura di Checkmate se vuoi approfondire l'architettura.
3. Apri una issue se pensi di aver trovato un bug.
4. Se sei un nuovo arrivato, dai un'occhiata alle good-first-issue.
5. Apri una pull request per aggiungere nuove funzionalità, apportare miglioramenti dell'esperienza d'uso o correggere bug.
6. Dai un'occhiata a questa guida interattiva alla codebase di Checkmate su CodeCanvas qui. Per perfezionare le simulazioni di flusso dati esistenti o crearne di nuove, segui il breve tutorial qui.