API Reference PhoenixKitStats v#0.2.0

Copy Markdown View Source

Modules

PhoenixKit plugin module for collecting and charting time-series stats.

Owns every stats group's open Barograph database — a SQLite file plus a Graphite plaintext ingest listener bound to the group's configured port.

Central mapping from error atoms (returned by PhoenixKitStats.Groups and used across its LiveViews) to translated human-readable strings.

Context module for managing stats groups.

Thin wrapper around Barograph for querying and charting a stats group's time-series data.

Versioned migration for the Stats module.

Centralized path helpers for the Stats module.

A stats group — one external data source (e.g. "server1"). Owns a dedicated Barograph SQLite database (see PhoenixKitStats.DatabaseManager) and a Graphite plaintext ingest port that a collector on that source writes metrics to.

Create/edit form for stats groups: name, key, port, template, description.

Chart page for a stats group: shows the collector endpoint + an example command, lets the admin pick a metric + time range + bucket + aggregation, and renders the resulting Barograph SVG chart.

Admin list page for stats groups: create, pause/resume, delete, and jump to a group's chart page or edit form.