Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.zyntex.dev/llms.txt

Use this file to discover all available pages before exploring further.

Gauges capture a point‑in‑time value that may increase or decrease.

​
Create and use

local Telemetry = Zyntex:Telemetry(10)

local cpu = Telemetry:Gauge("cpu_utilisation_percent")
local health = Telemetry:Gauge("server_health_percent")

-- Absolute set
cpu:set(43.2, {core = "Main"})

-- Relative changes (applied as deltas)
health:dec(5)   -- -5
health:inc(2)   -- +2
:set(value) sets an absolute reading. :inc(delta) / :dec(delta) record a delta. Use :set for most gauges to avoid drift.

​
Typical use cases

  • Performance: server_fps, memory_mb, cpu_utilisation_percent
  • Live sentiment/health: server_health_percent
  • Current concurrent: players_online (instantaneous)

​
Dashboard fit

  • Time‑series line, single value gauge, table by label (e.g., {server_id}).