INTEGRITY Dokumentace

Metriky

Metriky tunelu zobrazují propustnost a využití prostředků Cloudflare Tunnel v průběhu času. Když spustíte tunel, cloudflared spustí endpoint metrik Prometheus, tedy HTTP server, který zpřístupňuje metriky ve Prometheus formátu. Pomocí sady nástrojů Prometheus na vzdáleném počítači můžete získávat (scrapovat) metriky z cloudflared server.

Výchozí adresa serveru metrik

V prostředích bez kontejnerizace, cloudflared spustí server metrik na 127.0.0.1:<PORT>/metrics, kde <PORT> je první dostupný port v rozsahu 20241 na 20245. Pokud nejsou dostupné žádné porty, cloudflared se naváže na náhodný port. V kontejnerizovaných prostředích (Docker, Kubernetes) je výchozí adresa 0.0.0.0:<PORT>/metrics.

Chcete-li zjistit výchozí port, zkontrolujte svůj protokoly tunelu kolem doby, kdy byl tunel spuštěn. Například:

2024-12-19T21:17:58Z INF Starting metrics server on 127.0.0.1:20241/metrics

Konfigurace adresy serveru metrik

Chcete-li zpřístupnit metriky na vlastní IP adrese a portu, proveďte tyto kroky na cloudflared hostitele:

  1. Spuštění tunelu pomocí --metrics příznak. Například,

    cloudflared tunnel --metrics 127.0.0.1:60123 run my-tunnel
  2. Ověřte, že server metrik běží, a přejděte na http://localhost:60123/metrics. Bude to fungovat pouze v případě, že jste nakonfigurovali IP adresu localhost (127.0.0.1 nebo 0.0.0.0).

Nyní můžete metriky exportovat do Prometheus a Grafana a data vizualizovat i dotazovat. Více informací najdete v Tutoriál pro Grafana pro pokyny, jak s těmito nástroji začít.

Dostupné metriky

metriky cloudflared

Název Popis Typ Štítky
build_info Informace o sestavení a verzi. GAUGE goversion, revision, type, version
cloudflared_config_local_config_pushes Počet lokálních odeslání konfigurace do Cloudflare. COUNTER
cloudflared_config_local_config_pushes_errors Počet chyb při odesílání lokální konfigurace. COUNTER
cloudflared_orchestration_config_version Verze konfigurace. GAUGE
cloudflared_tcp_active_sessions Počet souběžných relací TCP proxovaných na libovolný origin. GAUGE
cloudflared_tcp_total_sessions Celkový počet relací TCP, které byly proxovány na libovolný origin server. COUNTER
cloudflared_tunnel_active_streams Celkový počet aktivních streamů. GAUGE
cloudflared_tunnel_concurrent_requests_per_tunnel Počet souběžných požadavků proxovaných přes jednotlivé tunely. GAUGE
cloudflared_tunnel_ha_connections Počet aktivních HA připojení. GAUGE
cloudflared_tunnel_request_errors Počet chyb při proxování na origin. COUNTER
cloudflared_tunnel_server_locations Kam je každý tunel připojen. 1 znamená aktuální umístění, 0 znamená předchozí umístění. GAUGE connection_id, edge_location
cloudflared_tunnel_timer_retries Počet nepotvrzených heartbeatů. GAUGE
cloudflared_tunnel_total_requests Počet požadavků proxovaných přes všechny tunely. COUNTER
cloudflared_tunnel_tunnel_authenticate_success Počet úspěšných událostí ověření tunelu. COUNTER
cloudflared_tunnel_tunnel_register_success Počet úspěšných registrací tunelu. COUNTER rpcName
cloudflared_udp_active_sessions Počet souběžných relací UDP proxovaných na libovolný origin. GAUGE
cloudflared_udp_total_sessions Celkový počet relací UDP, které byly proxovány na libovolný origin server. COUNTER
coredns_panics_total Počet panic. COUNTER
quic_client_closed_connections Počet uzavřených připojení. COUNTER
quic_client_latest_rtt Poslední naměřená doba odezvy (RTT) daného připojení. GAUGE conn_index
quic_client_lost_packets Počet paketů ztracených v rámci připojení. COUNTER conn_index, reason
quic_client_min_rtt Nejnižší naměřená hodnota RTT na připojení v ms. GAUGE conn_index
quic_client_packet_too_big_dropped Počet paketů přijatých z originu, které jsou příliš velké na odeslání do Cloudflare, a proto jsou zahozeny. COUNTER
quic_client_smoothed_rtt Vyhlazené RTT vypočítané pro připojení, v ms. GAUGE conn_index
quic_client_total_connections Počet zahájených připojení. U všech metrik QUIC znamená klient stranu, která připojení zahajuje. COUNTER

Metriky Prometheus

Název Popis Typ Štítky
promhttp_metric_handler_requests_in_flight Aktuální počet právě obsluhovaných scrapů. GAUGE
promhttp_metric_handler_requests_total Celkový počet scrapů podle stavového kódu HTTP. COUNTER code

Metriky runtime Go

Název Popis Typ Štítky
go_gc_duration_seconds Přehled doby pozastavení cyklů garbage collection. SHRNUTÍ
go_goroutines Počet aktuálně existujících goroutin. GAUGE
go_info Informace o prostředí Go. GAUGE version
go_memstats_alloc_bytes Počet alokovaných bajtů, které jsou stále používány. GAUGE
go_memstats_alloc_bytes_total Celkový počet alokovaných bajtů, včetně těch, které byly následně uvolněny. COUNTER
go_memstats_buck_hash_sys_bytes Počet bajtů používaných hashovací tabulkou profilovacích bucketů. GAUGE
go_memstats_frees_total Celkový počet uvolnění (free). COUNTER
go_memstats_gc_sys_bytes Počet bajtů používaných pro systémová metadata garbage collection. GAUGE
go_memstats_heap_alloc_bytes Počet alokovaných bajtů haldy, které jsou stále používány. GAUGE
go_memstats_heap_idle_bytes Počet bajtů haldy čekajících na použití. GAUGE
go_memstats_heap_inuse_bytes Počet používaných bajtů haldy. GAUGE
go_memstats_heap_objects Počet alokovaných objektů. GAUGE
go_memstats_heap_released_bytes Počet bajtů haldy uvolněných operačnímu systému. GAUGE
go_memstats_heap_sys_bytes Počet bajtů haldy získaných od systému. GAUGE
go_memstats_last_gc_time_seconds Počet sekund od roku 1970 od poslední garbage collection. GAUGE
go_memstats_lookups_total Celkový počet vyhledávání ukazatelů. COUNTER
go_memstats_mallocs_total Celkový počet alokací (malloc). COUNTER
go_memstats_mcache_inuse_bytes Počet bajtů používaných strukturami mcache. GAUGE
go_memstats_mcache_sys_bytes Počet bajtů používaných strukturami mcache získaných od systému. GAUGE
go_memstats_mspan_inuse_bytes Počet bajtů používaných strukturami mspan. GAUGE
go_memstats_mspan_sys_bytes Počet bajtů používaných strukturami mspan získaných od systému. GAUGE
go_memstats_next_gc_bytes Počet bajtů haldy, při kterém proběhne další garbage collection. GAUGE
go_memstats_other_sys_bytes Počet bajtů používaných pro ostatní systémové alokace. GAUGE
go_memstats_stack_inuse_bytes Počet bajtů používaných alokátorem zásobníku. GAUGE