# cisco-ie/telemetry architecture

> Architecture diagram of the GitHub repository cisco-ie/telemetry, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cisco-ie/telemetry
- Repository: https://github.com/cisco-ie/telemetry

## Overview

This repository is a collection of network telemetry datasets for anomaly-detection research, not an application or processing pipeline. The principal workflow is for a researcher to choose a traffic or anomaly scenario and use its data alongside header definitions and event context; topology documentation supplies network context. The README documents the CSV/header/case-file relationship, but no source excerpts describe processing or runtime behavior. Dataset 11 and the detailed scenario captures under 12 are represented from the tree; their internal relationships are not inferred.

Main entry points: [`0`](https://github.com/cisco-ie/telemetry/tree/master/0) (Zero-load baseline), [`1`](https://github.com/cisco-ie/telemetry/tree/master/1) (500 Gbps baseline), [`2`](https://github.com/cisco-ie/telemetry/tree/master/2) (BGP clear sets), [`4`](https://github.com/cisco-ie/telemetry/tree/master/4) (Flap and admin sets)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_scenario_sets["Scenario datasets"]
  node_baseline_zero[("Zero-load baseline")]
  node_baseline_500[("500 Gbps baseline")]
  node_bgp_clear[("BGP clear sets")]
  node_mixed_scenarios[("Flap and admin sets")]
  node_transceiver[("Transceiver pull")]
  node_csv_data["CSV measurements"]
  node_header_defs["Header definitions"]
end

subgraph group_telemetry["Telemetry captures"]
  node_router_telemetry[("Router telemetry")]
  node_scenario_captures[("Network scenarios")]
  node_case_context["Event records<br/>[events.csv.gz]"]
end

subgraph group_network_context["Network context"]
  node_topology_docs["Topology documents"]
end

node_researcher(("Researcher"))

node_researcher -->|"selects"| node_baseline_zero
node_researcher -->|"selects"| node_baseline_500
node_researcher -->|"selects"| node_bgp_clear
node_researcher -->|"selects"| node_mixed_scenarios
node_researcher -->|"selects"| node_transceiver
node_baseline_zero -->|"includes CSV"| node_csv_data
node_baseline_zero -->|"includes definitions"| node_header_defs
node_researcher -->|"uses"| node_router_telemetry
node_researcher -->|"uses"| node_scenario_captures
node_researcher -->|"consults"| node_topology_docs

click node_baseline_zero "https://github.com/cisco-ie/telemetry/tree/master/0"
click node_baseline_500 "https://github.com/cisco-ie/telemetry/tree/master/1"
click node_bgp_clear "https://github.com/cisco-ie/telemetry/tree/master/2"
click node_mixed_scenarios "https://github.com/cisco-ie/telemetry/tree/master/4"
click node_transceiver "https://github.com/cisco-ie/telemetry/tree/master/10"
click node_router_telemetry "https://github.com/cisco-ie/telemetry/tree/master/11/Dataset"
click node_scenario_captures "https://github.com/cisco-ie/telemetry/tree/master/12"
click node_csv_data "https://github.com/cisco-ie/telemetry/blob/master/0/baseline_no_anomaly.csv.gz"
click node_header_defs "https://github.com/cisco-ie/telemetry/blob/master/0/baseline_header.txt"
click node_case_context "https://github.com/cisco-ie/telemetry/blob/master/11/Dataset/events.csv.gz"
click node_topology_docs "https://github.com/cisco-ie/telemetry/tree/master/topology_description_docs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_baseline_zero,node_baseline_500,node_bgp_clear,node_mixed_scenarios,node_transceiver,node_csv_data,node_header_defs toneBlue
class node_router_telemetry,node_scenario_captures,node_case_context toneAmber
class node_topology_docs toneMint
class node_researcher toneIndigo
```

## Components

### Scenario datasets

- [Zero-load baseline](https://github.com/cisco-ie/telemetry/tree/master/0): `0`
- [500 Gbps baseline](https://github.com/cisco-ie/telemetry/tree/master/1): `1`
- [BGP clear sets](https://github.com/cisco-ie/telemetry/tree/master/2): `2`
- [Flap and admin sets](https://github.com/cisco-ie/telemetry/tree/master/4): `4`
- [Transceiver pull](https://github.com/cisco-ie/telemetry/tree/master/10): `10`
- [CSV measurements](https://github.com/cisco-ie/telemetry/blob/master/0/baseline_no_anomaly.csv.gz): `0/baseline_no_anomaly.csv.gz`
- [Header definitions](https://github.com/cisco-ie/telemetry/blob/master/0/baseline_header.txt): `0/baseline_header.txt`

### Telemetry captures

- [Router telemetry](https://github.com/cisco-ie/telemetry/tree/master/11/Dataset): `11/Dataset`
- [Network scenarios](https://github.com/cisco-ie/telemetry/tree/master/12): `12`
- [Event records](https://github.com/cisco-ie/telemetry/blob/master/11/Dataset/events.csv.gz): `11/Dataset/events.csv.gz`

### Network context

- [Topology documents](https://github.com/cisco-ie/telemetry/tree/master/topology_description_docs): `topology_description_docs`

### Other components

- **Researcher**

## Connections

- Researcher → Zero-load baseline: selects (evidence: `README.md`)
- Researcher → 500 Gbps baseline: selects (evidence: `README.md`)
- Researcher → BGP clear sets: selects (evidence: `README.md`)
- Researcher → Flap and admin sets: selects (evidence: `README.md`)
- Researcher → Transceiver pull: selects (evidence: `README.md`)
- Zero-load baseline → CSV measurements: includes CSV (evidence: `README.md`)
- Zero-load baseline → Header definitions: includes definitions (evidence: `README.md`)
- Researcher → Router telemetry: uses
- Researcher → Network scenarios: uses
- Researcher → Topology documents: consults (evidence: `README.md`)