bvandeusen
ad4fcd1cfd
First-party plugins for Fabled Scryer (https://github.com/bvandeusen/fabledscryer). traefik: Prometheus metrics scraping, stats history, access log parsing (GeoIP optional) unifi: UniFi controller integration — WAN health, devices, clients, DPI, events ups: UPS monitoring via NUT (Network UPS Tools), Ansible shutdown automation Each plugin follows the Fabled Scryer plugin contract: setup(app), get_scheduled_tasks(), get_blueprint() index.yaml lists all three plugins in the catalog format. Populate checksum_sha256 entries once release zips are published via GitHub Releases. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
157 lines
8.0 KiB
Python
157 lines
8.0 KiB
Python
"""UniFi expanded tables: wlan stats, dpi, events, alarms, known clients,
|
|
speedtest results, networks, port forwards, firewall rules.
|
|
Also adds missing 'version' column to unifi_devices.
|
|
|
|
Revision ID: unifi_002_expanded
|
|
Revises: unifi_001_initial
|
|
Create Date: 2026-03-20
|
|
"""
|
|
from typing import Sequence, Union
|
|
from alembic import op
|
|
import sqlalchemy as sa
|
|
|
|
revision: str = "unifi_002_expanded"
|
|
down_revision: Union[str, None] = "unifi_001_initial"
|
|
branch_labels: Union[str, Sequence[str], None] = None
|
|
depends_on: Union[str, Sequence[str], None] = None
|
|
|
|
|
|
def upgrade() -> None:
|
|
# ── Patch unifi_devices to add missing version column ─────────────────────
|
|
op.add_column("unifi_devices", sa.Column("version", sa.String(64), nullable=True))
|
|
|
|
# ── WLAN stats (time-series per SSID+radio) ───────────────────────────────
|
|
op.create_table(
|
|
"unifi_wlan_stats",
|
|
sa.Column("id", sa.String(36), primary_key=True),
|
|
sa.Column("scraped_at", sa.DateTime(timezone=True), nullable=False),
|
|
sa.Column("ssid", sa.String(255), nullable=False),
|
|
sa.Column("radio", sa.String(8), nullable=True),
|
|
sa.Column("num_sta", sa.Integer, nullable=False, server_default="0"),
|
|
sa.Column("tx_bytes", sa.Float, nullable=True),
|
|
sa.Column("rx_bytes", sa.Float, nullable=True),
|
|
sa.Column("channel", sa.Integer, nullable=True),
|
|
sa.Column("satisfaction", sa.Integer, nullable=True),
|
|
)
|
|
op.create_index("ix_unifi_wlan_stats_scraped", "unifi_wlan_stats", ["scraped_at"])
|
|
|
|
# ── DPI snapshots (site-level category totals) ────────────────────────────
|
|
op.create_table(
|
|
"unifi_dpi_snapshots",
|
|
sa.Column("id", sa.String(36), primary_key=True),
|
|
sa.Column("scraped_at", sa.DateTime(timezone=True), nullable=False),
|
|
sa.Column("by_category_json", sa.Text, nullable=False, server_default="[]"),
|
|
sa.Column("by_client_json", sa.Text, nullable=False, server_default="[]"),
|
|
)
|
|
op.create_index("ix_unifi_dpi_scraped", "unifi_dpi_snapshots", ["scraped_at"])
|
|
|
|
# ── Known clients (upserted by MAC) ───────────────────────────────────────
|
|
op.create_table(
|
|
"unifi_known_clients",
|
|
sa.Column("mac", sa.String(32), primary_key=True),
|
|
sa.Column("hostname", sa.String(255), nullable=True),
|
|
sa.Column("name", sa.String(255), nullable=True),
|
|
sa.Column("ip", sa.String(64), nullable=True),
|
|
sa.Column("mac_vendor", sa.String(128), nullable=True),
|
|
sa.Column("note", sa.Text, nullable=True),
|
|
sa.Column("is_blocked", sa.Boolean, nullable=False, server_default="false"),
|
|
sa.Column("first_seen", sa.DateTime(timezone=True), nullable=True),
|
|
sa.Column("last_seen", sa.DateTime(timezone=True), nullable=True),
|
|
sa.Column("scraped_at", sa.DateTime(timezone=True), nullable=False),
|
|
)
|
|
|
|
# ── Events (upserted by UniFi event ID) ───────────────────────────────────
|
|
op.create_table(
|
|
"unifi_events",
|
|
sa.Column("unifi_id", sa.String(64), primary_key=True),
|
|
sa.Column("event_time", sa.DateTime(timezone=True), nullable=False),
|
|
sa.Column("event_key", sa.String(64), nullable=False),
|
|
sa.Column("category", sa.String(16), nullable=False),
|
|
sa.Column("message", sa.Text, nullable=False),
|
|
sa.Column("source_mac", sa.String(32), nullable=True),
|
|
sa.Column("source_ip", sa.String(64), nullable=True),
|
|
sa.Column("details_json", sa.Text, nullable=False, server_default="{}"),
|
|
)
|
|
op.create_index("ix_unifi_events_time", "unifi_events", ["event_time"])
|
|
|
|
# ── Alarms (upserted by UniFi alarm ID) ───────────────────────────────────
|
|
op.create_table(
|
|
"unifi_alarms",
|
|
sa.Column("unifi_id", sa.String(64), primary_key=True),
|
|
sa.Column("alarm_time", sa.DateTime(timezone=True), nullable=False),
|
|
sa.Column("alarm_key", sa.String(64), nullable=False),
|
|
sa.Column("message", sa.Text, nullable=False),
|
|
sa.Column("archived", sa.Boolean, nullable=False, server_default="false"),
|
|
sa.Column("scraped_at", sa.DateTime(timezone=True), nullable=False),
|
|
)
|
|
op.create_index("ix_unifi_alarms_time", "unifi_alarms", ["alarm_time"])
|
|
|
|
# ── Speedtest results (upserted by run timestamp) ─────────────────────────
|
|
op.create_table(
|
|
"unifi_speedtest_results",
|
|
sa.Column("run_at", sa.DateTime(timezone=True), primary_key=True),
|
|
sa.Column("download_mbps", sa.Float, nullable=True),
|
|
sa.Column("upload_mbps", sa.Float, nullable=True),
|
|
sa.Column("latency_ms", sa.Float, nullable=True),
|
|
sa.Column("server_name", sa.String(255), nullable=True),
|
|
)
|
|
|
|
# ── Networks/VLANs (upserted by UniFi ID) ────────────────────────────────
|
|
op.create_table(
|
|
"unifi_networks",
|
|
sa.Column("unifi_id", sa.String(64), primary_key=True),
|
|
sa.Column("name", sa.String(255), nullable=False),
|
|
sa.Column("purpose", sa.String(32), nullable=True),
|
|
sa.Column("vlan", sa.Integer, nullable=True),
|
|
sa.Column("ip_subnet", sa.String(64), nullable=True),
|
|
sa.Column("dhcp_enabled", sa.Boolean, nullable=False, server_default="false"),
|
|
sa.Column("is_guest", sa.Boolean, nullable=False, server_default="false"),
|
|
sa.Column("scraped_at", sa.DateTime(timezone=True), nullable=False),
|
|
)
|
|
|
|
# ── Port forwards (upserted by UniFi ID) ─────────────────────────────────
|
|
op.create_table(
|
|
"unifi_port_forwards",
|
|
sa.Column("unifi_id", sa.String(64), primary_key=True),
|
|
sa.Column("name", sa.String(255), nullable=True),
|
|
sa.Column("proto", sa.String(8), nullable=False, server_default="tcp"),
|
|
sa.Column("dst_port", sa.String(32), nullable=False),
|
|
sa.Column("fwd_ip", sa.String(64), nullable=False),
|
|
sa.Column("fwd_port", sa.String(32), nullable=False),
|
|
sa.Column("src_filter", sa.String(255), nullable=True),
|
|
sa.Column("enabled", sa.Boolean, nullable=False, server_default="true"),
|
|
sa.Column("scraped_at", sa.DateTime(timezone=True), nullable=False),
|
|
)
|
|
|
|
# ── Firewall rules (upserted by UniFi ID) ────────────────────────────────
|
|
op.create_table(
|
|
"unifi_fw_rules",
|
|
sa.Column("unifi_id", sa.String(64), primary_key=True),
|
|
sa.Column("name", sa.String(255), nullable=False),
|
|
sa.Column("ruleset", sa.String(16), nullable=False),
|
|
sa.Column("rule_index", sa.Integer, nullable=True),
|
|
sa.Column("action", sa.String(16), nullable=False),
|
|
sa.Column("protocol", sa.String(16), nullable=True),
|
|
sa.Column("enabled", sa.Boolean, nullable=False, server_default="true"),
|
|
sa.Column("src_address", sa.String(255), nullable=True),
|
|
sa.Column("dst_address", sa.String(255), nullable=True),
|
|
sa.Column("scraped_at", sa.DateTime(timezone=True), nullable=False),
|
|
)
|
|
|
|
|
|
def downgrade() -> None:
|
|
op.drop_table("unifi_fw_rules")
|
|
op.drop_table("unifi_port_forwards")
|
|
op.drop_table("unifi_networks")
|
|
op.drop_table("unifi_speedtest_results")
|
|
op.drop_index("ix_unifi_alarms_time", "unifi_alarms")
|
|
op.drop_table("unifi_alarms")
|
|
op.drop_index("ix_unifi_events_time", "unifi_events")
|
|
op.drop_table("unifi_events")
|
|
op.drop_table("unifi_known_clients")
|
|
op.drop_index("ix_unifi_dpi_scraped", "unifi_dpi_snapshots")
|
|
op.drop_table("unifi_dpi_snapshots")
|
|
op.drop_index("ix_unifi_wlan_stats_scraped", "unifi_wlan_stats")
|
|
op.drop_table("unifi_wlan_stats")
|
|
op.drop_column("unifi_devices", "version")
|