README.cs.md

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

⚠️ Tento překlad je strojový koncept. Revize od rodilých mluvčích jsou vítány formou pull requestu.

Checkmate

Open source aplikace pro monitorování dostupnosti a infrastruktury

Tento repozitář obsahuje jak frontend, tak backend Checkmate, open source, samohostovatelného monitorovacího nástroje pro sledování hardwaru serveru, dostupnosti, doby odezvy a incidentů v reálném čase s krásnými vizualizacemi. Checkmate pravidelně kontroluje, zda je server/web dostupný a zda funguje optimálně, a poskytuje upozornění a zprávy o dostupnosti, výpadcích a době odezvy monitorovaných služeb v reálném čase.

Checkmate má také agenta zvaného Capture, který získává data ze vzdálených serverů. Capture není pro běh Checkmate povinný, ale poskytuje další informace o stavu CPU, RAM, disku a teploty serverů. Capture lze provozovat na Linuxu, Windows, Macu, Raspberry Pi nebo jakémkoli zařízení, které dokáže spouštět Go.

Checkmate byl zátěžově otestován s více než 1000 aktivními monitory bez jakýchkoli problémů nebo výkonnostních úzkých míst.

📚 Obsah

• 📦 Demo
• 🔗 Uživatelská příručka
• 🛠️ Instalace
• 🚀 Výkon
• 💚 Dotazy & nápady
• 🧩 Funkce
• 🏗️ Snímky obrazovky
• 🏗️ Technologie
• 🔗 Několik odkazů
• 🤝 Přispívání

Demo

Nejnovější sestavení Checkmate si můžete vyzkoušet v akci.

Uživatelské jméno je demouser@demo.com a heslo Demouser1! (Poznámka: demo server čas od času aktualizujeme; pokud něco nefunguje, dejte nám prosím vědět na kanále Discussions).

Uživatelská příručka

Pokyny k použití najdete zde.

Předpoklady

• Nainstalovaný Docker
• Nainstalovaný Git

Instalace

Pokyny k instalaci najdete v dokumentačním portálu Checkmate.

Případně můžete použít Coolify, Elestio, K8s, Sive Host (Jižní Afrika), Cloudzy nebo Pikapods pro rychlé spuštění instance Checkmate. Pokud chcete monitorovat infrastrukturu serverů, budete potřebovat agenta Capture. Repozitář Capture obsahuje také pokyny k instalaci.

Použití vlastní CA

Pokud potřebujete monitorovat interní HTTPS endpointy s certifikáty od soukromých certifikačních autorit (jako je Smallstep), přečtěte si naši příručku pro důvěřování vlastním CA pro možnosti konfigurace Dockeru.

Další dokumentaci najdete v adresáři docs.

Výkon

Díky rozsáhlým optimalizacím funguje Checkmate s mimořádně malým paměťovým otiskem a vyžaduje jen minimum paměti a CPU. Zde je využití paměti instance Node.js na serveru, který každou minutu monitoruje 323 serverů:

A zde paměťový otisk MongoDB a Redis na stejném serveru (398 MB, resp. 15 MB) pro stejný počet serverů:

Dotazy & nápady

Pokud máte dotazy, návrhy nebo komentáře, máte několik možností:

• Discord kanál (preferováno)
• GitHub Discussions (kontrolujeme čas od času)

Neváhejte se ptát nebo sdílet své nápady — moc rádi vás slyšíme!

Funkce

• Plně open source, nasaditelné na vlastních serverech nebo domácích zařízeních (např. Raspberry Pi 4 nebo 5)
• Několik způsobů monitorování: dostupnost, Docker, ping, SSL, port, herní server
• Monitorování rychlosti stránek
• Monitorování infrastruktury (paměť, využití disku, výkon CPU, síť atd.) — vyžaduje agenta Capture
  • Selektivní monitorování disků s výběrem přípojných bodů
• Incidenty na první pohled
• Stavové stránky se 4 elegantními tématy
• Notifikace přes e-mail, webhooky, Discord, Slack, PagerDuty, Matrix, Microsoft Teams, Telegram, Pushover, Twilio (SMS)
• Plánovaná údržba
• Monitorování pomocí JSON dotazů
• Vícejazyčná podpora pro arabštinu, čínštinu (zjednodušenou), čínštinu (tradiční, Tchaj-wan), češtinu, angličtinu, finštinu, francouzštinu, němčinu, japonštinu, portugalštinu (Brazílie), ruštinu, španělštinu, thajštinu, turečtinu, ukrajinštinu a vietnamštinu

Životní cyklus monitoru

1. Monitor provede kontrolu (HTTP / ping / port / hardware přes agenta Capture)
2. Výsledek se uloží (úspěch/neúspěch + doba odezvy)
3. Nedávné výsledky se vyhodnotí proti nastavenému prahu změny stavu monitoru
4. Pokud je prah dosažen a aktuální stav se liší od předchozího, změní se stav monitoru (např. initializing, up, down, breached)
5. Při změně stavu se podle aktuálního stavu vytvoří nebo vyřeší incident
6. Notifikace se spouštějí podle konfigurace

Snímky obrazovky

Technologie

• ReactJs
• MUI (React framework)
• Node.js
• MongoDB
• Recharts
• A mnoho dalších open source komponent!

Několik odkazů

• Pokud nás chcete podpořit, zvažte přidělení ⭐ a kliknutí na „watch“.
• Máte dotaz nebo návrh na roadmapu/funkce? Podívejte se na náš Discord kanál nebo fórum Discussions.
• Chcete být upozorněni na nové vydání? Použijte Newreleases, bezplatnou službu pro sledování vydání.
• Podívejte se na instalační a uživatelské video Checkmate

Přispívání

Jsme Alex (vedoucí týmu), Gorkem, Aryaman, Mert a Karen a pomáháme jednotlivcům a firmám monitorovat jejich infrastrukturu a servery.

Jsme hrdí na to, že budujeme silné vztahy s přispěvateli na všech úrovních. Přestože jsme mladý projekt, Checkmate už získal přes 7000 hvězdiček a přilákal více než 90 přispěvatelů z celého světa.

Náš repozitář mají označený zaměstnanci společností Google, Microsoft, Intel, Cisco, Tencent, Electronic Arts, ByteDance, JP Morgan Chase, Deloitte, Accenture, Foxconn, Broadcom, China Telecom, Barclays, Capgemini, Wipro, Cloudflare, Dassault Systèmes a NEC — takže neváhejte, zapojte se, přispějte a učte se s námi!

Jak přispět:

0. Dejte tomuto repozitáři hvězdičku :)
1. Přečtěte si pokyny pro přispěvatele. Začátečníkům doporučujeme prohlédnout si štítek good-first-issue.
2. Pokud chcete proniknout do architektury, přečtěte si podrobnou strukturu Checkmate.
3. Otevřete issue, pokud se domníváte, že jste narazili na chybu.
4. Pokud jste nováček, podívejte se po good-first-issue.
5. Vytvořte pull request pro přidání funkcí, drobná vylepšení nebo opravy chyb.
6. Vyzkoušejte interaktivní průchod kódovou základnou Checkmate na CodeCanvas zde. Pro vylepšení existujících simulací datových toků nebo vytvoření nových postupujte podle krátkého tutoriálu zde.