mirror of
https://github.com/thatmattlove/hyperglass.git
synced 2026-04-17 21:38:27 +00:00
9db9849a59
Summary: - Add structured traceroute support with comprehensive IP enrichment (ASN/org/RDNS). - Improve MikroTik traceroute cleaning and aggregation; collapse repeated tables into a single representative table. - Enhance traceroute logging for visibility and add traceroute-specific cleaning helpers. - Add/adjust IP enrichment plugins and BGP/traceroute enrichment integrations. - UI updates for traceroute output and path visualization; update docs and configuration for structured output. This commit squashes changes from 'structured-dev' into a single release commit.
79 lines
2.7 KiB
Python
79 lines
2.7 KiB
Python
"""Structured data configuration variables."""
|
|
|
|
# Standard Library
|
|
import typing as t
|
|
|
|
# Third Party
|
|
from pydantic import field_validator, ValidationInfo
|
|
|
|
# Local
|
|
from ..main import HyperglassModel
|
|
|
|
StructuredCommunityMode = t.Literal["permit", "deny", "name"]
|
|
StructuredRPKIMode = t.Literal["router", "external"]
|
|
|
|
|
|
class StructuredCommunities(HyperglassModel):
|
|
"""Control structured data response for BGP communities."""
|
|
|
|
mode: StructuredCommunityMode = "deny"
|
|
items: t.List[str] = []
|
|
names: t.Dict[str, str] = {}
|
|
|
|
@field_validator("names")
|
|
def validate_names(cls, value: t.Dict[str, str], info: ValidationInfo) -> t.Dict[str, str]:
|
|
"""Validate that names are provided when mode is 'name'."""
|
|
if info.data and info.data.get("mode") == "name" and not value:
|
|
raise ValueError(
|
|
"When using mode 'name', at least one community mapping must be provided in 'names'"
|
|
)
|
|
return value
|
|
|
|
|
|
class StructuredRpki(HyperglassModel):
|
|
"""Control structured data response for RPKI state."""
|
|
|
|
mode: StructuredRPKIMode = "router"
|
|
backend: str = "cloudflare"
|
|
rpki_server_url: str = ""
|
|
|
|
|
|
class StructuredIpEnrichment(HyperglassModel):
|
|
"""Control IP enrichment for structured data responses.
|
|
|
|
Two tri-state flags are provided to allow the presence of a `structured:`
|
|
config block to imply the features are enabled, while still allowing users
|
|
to explicitly disable them.
|
|
"""
|
|
|
|
cache_timeout: int = 86400 # 24 hours in seconds (minimum)
|
|
|
|
@field_validator("cache_timeout")
|
|
def validate_cache_timeout(cls, value: int) -> int:
|
|
"""Ensure cache timeout is at least 24 hours (86400 seconds)."""
|
|
if value < 86400:
|
|
return 86400
|
|
return value
|
|
|
|
enrich_traceroute: bool = True
|
|
"""Enable ASN/org/IP enrichment for traceroute hops.
|
|
|
|
This option remains under `structured.ip_enrichment` per-user request and
|
|
must be True (in addition to top-level structured presence and
|
|
`structured.enable_for_traceroute` not being False) for enrichment to run.
|
|
"""
|
|
|
|
|
|
class Structured(HyperglassModel):
|
|
"""Control structured data responses."""
|
|
|
|
communities: StructuredCommunities = StructuredCommunities()
|
|
rpki: StructuredRpki = StructuredRpki()
|
|
ip_enrichment: StructuredIpEnrichment = StructuredIpEnrichment()
|
|
|
|
# Top-level structured enable/disable flags. If `structured:` is present in
|
|
# the user's config and these are not set (None), the structured table
|
|
# output is considered enabled by default. Setting them to False disables
|
|
# the structured table output even when a `structured:` block exists.
|
|
enable_for_traceroute: t.Optional[bool] = None
|
|
enable_for_bgp_route: t.Optional[bool] = None
|