System Query Types

LogZilla documentation for System Query Types

Query Types — System/Admin Queries

These queries expose system metrics, storage counters, and status. Names and fields are verified against lib/logzilla/query.py and API wiring.

  • SystemStatus
  • ProcessingStats
  • StorageStats
  • System_CPU
  • System_Memory
  • System_DF
  • System_Network
  • System_NetworkErrors
  • System_IOPS (alias: System_IOPSQuery)
  • Notifications
  • Tasks

SystemStatus

High-level system information and disk usage. No time range.

Parameters:

  • show_usage_stats (bool): include disk usage breakdowns.

ProcessingStats

Internal processing counters for the pipeline.

Parameters:

  • time_range, timezone
  • show_daily_stats (bool)

Result highlights:

  • totals and details with new, duplicates, optional daily_stats.

StorageStats

Storage counters over a period (rounded to full hours).

Parameters:

  • time_range, timezone
  • show_daily_stats (bool)
  • show_raw_counters (bool)

Result highlights:

  • totals for the period, all_time counters.

System_CPU

CPU usage metrics per-CPU or totals.

Parameters:

  • time_range, timezone
  • cpu: CPU index or totals
  • Optional filters: host

Fields:

  • usage_softirq, usage_system, usage_idle, usage_user, usage_irq, usage_nice, usage_steal, usage_iowait.

System_Memory

Memory utilization metrics.

Parameters:

  • time_range, timezone
  • Optional filters: host

Fields:

  • buffered, cached, free, used.

System_DF

Filesystem usage metrics per mount/path.

Parameters:

  • time_range, timezone
  • Filters: host, path (mapped to fs internally)

Fields:

  • free, used. (Percentages can be derived by clients.)

System_Network

Network throughput derived from interface counters.

Parameters:

  • time_range, timezone
  • Filters: host, interface

Fields (custom rates):

  • bps_recv = derivative of bytes_recv × 8
  • bps_sent = derivative of bytes_sent × 8

System_NetworkErrors

Network interface error and drop counters.

Parameters:

  • time_range, timezone
  • Filters: host, interface

Fields:

  • drop_in, drop_out, err_in, err_out.

System_IOPS (System_IOPSQuery)

Disk I/O operations per second (IOPS).

Parameters:

  • time_range, timezone
  • Filters: host, disk (exposed as name internally)

Fields (custom rates):

  • reads, writes (derived per second)

Notes

  • System queries depend on metrics availability and the SYSTEM_METRICS_ENABLED configuration.
  • See Making Queries for the request flow.
  • For export formats, see Query Export Formats.

Notifications

Notifications group query built on top of system status mechanics.

Parameters:

  • time_range: Period to consider; values used against time_range_field.
  • timezone: Timezone for interpretation.
  • time_range_field: One of updated_at, created_at, unread_since, or read_at.
  • is_private: Filter by private flag (bool).
  • read: Filter by read flag (bool).
  • sort: List. Defaults to descending by time_range_field when not provided.

Tasks

Task list query with filters and sorting.

Parameters:

  • time_range: Period (default last day).
  • sort: List of fields (string or list). Default owner.
  • is_open: Filter by open/closed (bool).
  • is_overdue: Filter by due date (bool).
  • assigned_to: Filter by user ids (list); empty list means unassigned.
  • owner: Filter by owner ids (list).
System Query Types | LogZilla Documentation