BGP Types¶

The BGP family models the data files published by APNIC's thyme BGP analysis service at thyme.apnic.net. Thyme publishes eight files; the SDK covers all eight and additionally derives an ASN→prefixes map locally from the raw route table. Three geographic views (current, au, hk) are exposed through the --bgp-source flag / FetchBGP* source argument.

All types live in models.go.

Class Diagram¶

classDiagram
    class BGPSummary {
        +[]BGPKeyValue Entries
    }

    class BGPKeyValue {
        +string Key
        +string Value
    }

    class BGPRawTable {
        +[]BGPRoute Routes
    }

    class BGPRoute {
        +string Prefix
        +string ASN
    }

    class BGPASNMap {
        +map~string,[]string~ ASNs
    }

    class BGPBadPrefix {
        +string OriginAS
        +string Address
    }

    class BGPBadPrefixes {
        +[]BGPBadPrefix Prefixes
    }

    class BGPPrefixLengthCount {
        +int Length
        +int Count
        +string Raw
    }

    class BGPPerPrefixLength {
        +[]BGPPrefixLengthCount Counts
    }

    class BGPUsedAutnum {
        +string ASN
        +string Name
        +string Country
        +string FullName
    }

    class BGPUsedAutnums {
        +[]BGPUsedAutnum Autnums
    }

    class BGPSparPrefix {
        +string Prefix
        +string OriginAS
        +string Description
    }

    class BGPSparPrefixes {
        +[]BGPSparPrefix Prefixes
    }

    class BGPSinglePfxCount {
        +int PrefixCount
        +int ASNCount
        +string RIR
    }

    class BGPSinglePfx {
        +[]BGPSinglePfxCount Counts
    }

    BGPSummary --> BGPKeyValue
    BGPRawTable --> BGPRoute
    BGPBadPrefixes --> BGPBadPrefix
    BGPPerPrefixLength --> BGPPrefixLengthCount
    BGPUsedAutnums --> BGPUsedAutnum
    BGPSparPrefixes --> BGPSparPrefix
    BGPSinglePfx --> BGPSinglePfxCount

    BGPRoute ..> BGPASNMap : derived by SDK

BGPSummary / BGPKeyValue — data-summary¶

Thyme's summary file is a list of key: value pairs preceded by a dash separator line. Values are kept verbatim as strings because thyme mixes counts, percentages and prose in the same column.

BGPRawTable / BGPRoute — data-raw-table¶

One prefix\tASN line per route.

BGPASNMap — derived, not fetched¶

BGPASNMap aggregates BGPRawTable routes by origin ASN. It is built locally by the SDK (GroupByASN); no extra network request is made. ASNs maps each origin ASN to the list of prefixes it originates, in first-seen order.

BGPBadPrefix / BGPBadPrefixes — data-badpfx-nos¶

Prefixes longer than /24 and their origin AS. Such prefixes often indicate route leaks or mis-announcements. The SDK guards against malformed rows by truncating out-of-range data rather than failing the whole file.

BGPPrefixLengthCount / BGPPerPrefixLength — data-pfx-nos¶

How many prefixes of each length are announced (/N:count).

BGPUsedAutnum / BGPUsedAutnums — data-used-autnums¶

In-use ASNs: "ASN Name - Description, CC". The SDK splits each line into four fields; the FullName field preserves the Name - Description text that precedes the trailing country code.

BGPSparPrefix / BGPSparPrefixes — data-spar¶

Prefixes from the Special Purpose Address Registry (RFC 6890 reserved space) that are nonetheless being announced, with origin AS and description.

BGPSinglePfxCount / BGPSinglePfx — data-singlepfx¶

Counts of ASNs that announce fewer than 20 prefixes, broken down by RIR. Each row is No. of Prefixes / No. of ASNs / RIR.

Source-to-type map¶

flowchart LR
    subgraph Thyme["thyme.apnic.net (current/au/hk)"]
        S1["data-summary"]
        S2["data-raw-table"]
        S3["data-badpfx-nos"]
        S4["data-pfx-nos"]
        S5["data-used-autnums"]
        S6["data-spar"]
        S7["data-singlepfx"]
    end

    S1 --> BS["BGPSummary"]
    S2 --> BRT["BGPRawTable"]
    S3 --> BBPS["BGPBadPrefixes"]
    S4 --> BPLS["BGPPerPrefixLength"]
    S5 --> BUAS["BGPUsedAutnums"]
    S6 --> BSPS["BGPSparPrefixes"]
    S7 --> SSPX["BGPSinglePfx"]

    BRT -. GroupByASN .-> BAM["BGPASNMap"]

Per-source view¶

Thyme publishes the same files for three geographic views, selected at fetch time via the source argument (current is the default):

The parsed type is identical regardless of source — only the data differs.