netx/netx_api/port_traffic_schemas.py
oliver efe8f58cd2 Add ZTE-first port traffic monitoring with task wizard and ops wall.
Collect interface bit/s via CLI on a schedule, store samples in Postgres, and chart trends with uPlot.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-31 14:56:50 +08:00

131 lines
3.1 KiB
Python

"""Pydantic schemas for port traffic monitoring API."""
from __future__ import annotations
from datetime import datetime
from typing import Literal
from pydantic import BaseModel, Field
class PortTrafficNeRef(BaseModel):
source: Literal["managed", "ume"]
id: str
ne_name: str = ""
ne_ip: str = ""
vendor: str = ""
class PortTrafficTargetIn(BaseModel):
source: Literal["managed", "ume"]
target_id: str
ne_name: str = ""
ne_ip: str = ""
vendor: str = ""
ifname: str
if_description: str = ""
bw_bps: int = 0
class PortTrafficTaskCreate(BaseModel):
title: str = Field(min_length=1, max_length=256)
interval_sec: int = Field(default=60, ge=15, le=3600)
retention_days: int = Field(default=7, ge=1, le=90)
concurrency: int = Field(default=5, ge=1, le=20)
targets: list[PortTrafficTargetIn] = Field(default_factory=list)
start_now: bool = False
class PortTrafficTaskUpdate(BaseModel):
title: str | None = Field(default=None, min_length=1, max_length=256)
interval_sec: int | None = Field(default=None, ge=15, le=3600)
retention_days: int | None = Field(default=None, ge=1, le=90)
concurrency: int | None = Field(default=None, ge=1, le=20)
class PortTrafficTaskOut(BaseModel):
id: str
title: str
status: str
interval_sec: int
retention_days: int
concurrency: int
collect_running: bool = False
target_count: int = 0
active_target_count: int = 0
last_collect_started_at: datetime | None = None
last_collect_ended_at: datetime | None = None
last_error: str = ""
created_at: datetime | None = None
updated_at: datetime | None = None
class PortTrafficTargetOut(BaseModel):
id: str
task_id: str
source: str
target_id: str
ne_name: str
ne_ip: str
vendor: str
ifname: str
if_description: str
bw_bps: int
status: str
last_error: str = ""
last_sample_at: datetime | None = None
created_at: datetime | None = None
class PortTrafficTargetsPut(BaseModel):
targets: list[PortTrafficTargetIn]
class DiscoverPortsRequest(BaseModel):
source: Literal["managed", "ume"]
id: str
class DiscoverPortItem(BaseModel):
ifname: str
attribute: str = ""
mode: str = ""
bw_raw: str = ""
bw_bps: int = 0
admin: str = ""
phy: str = ""
prot: str = ""
description: str = ""
class DiscoverPortsResponse(BaseModel):
source: str
id: str
ne_name: str = ""
ne_ip: str = ""
vendor: str = ""
vendor_key: str = ""
ports: list[DiscoverPortItem] = Field(default_factory=list)
class PortTrafficSamplePoint(BaseModel):
ts: datetime
in_bps: float
out_bps: float
in_util_pct: float
out_util_pct: float
bw_bps: int
rate_period_sec: int = 0
class PortTrafficSamplesOut(BaseModel):
target: PortTrafficTargetOut
points: list[PortTrafficSamplePoint] = Field(default_factory=list)
class PortTrafficDashboardOut(BaseModel):
task_count: int = 0
running_task_count: int = 0
active_target_count: int = 0
sample_count_24h: int = 0
last_sample_at: datetime | None = None