# sf-tap/documents architecture

> Architecture diagram of the GitHub repository sf-tap/documents, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sf-tap/documents
- Repository: https://github.com/sf-tap/documents

## Overview

SF-TAP is a documented platform for scalable L7 traffic analysis, with two principal components: Flow Abstractor and Cell Incubator. The main analysis workflow captures packets, reassembles and classifies flows, then exposes them through UNIX-domain-socket files for analyzers. Cell Incubator provides a separate distribution capability by forwarding flows to multiple NICs and analysis servers. The repository contains obsolete documentation, not implementation source; relationships below are limited to those stated in README.md.

Main entry points: [`README.md`](https://github.com/sf-tap/documents/blob/master/README.md) (Flow Abstractor)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_capture_analysis["Capture and analysis"]
  node_flow_abstractor["Flow Abstractor<br/>[README.md]"]
  node_packet_reassembly["Packet reassembly<br/>[README.md]"]
  node_l7_classification["L7 classification<br/>[README.md]"]
end

subgraph group_flow_access["Flow access"]
  node_socket_files["Socket files<br/>[README.md]"]
  node_l7_analyzers["L7 analyzers<br/>[README.md]"]
end

subgraph group_distribution["Flow distribution"]
  node_cell_incubator["Cell Incubator<br/>[README.md]"]
end

node_network_traffic(("Network traffic"))
node_capture_nic["Capture NIC"]
node_forward_nics["Forwarding NICs"]
node_analysis_servers["Analysis servers"]

node_network_traffic -->|"enters"| node_capture_nic
node_capture_nic -->|"captures via pcap"| node_flow_abstractor
node_flow_abstractor -->|"reassembles packets"| node_packet_reassembly
node_flow_abstractor -->|"classifies flows"| node_l7_classification
node_flow_abstractor -->|"outputs flows"| node_socket_files
node_l7_analyzers -->|"accesses flows"| node_socket_files
node_network_traffic -->|"captures"| node_cell_incubator
node_cell_incubator -->|"forwards flows"| node_forward_nics
node_forward_nics -->|"sends flows"| node_analysis_servers

click node_flow_abstractor "https://github.com/sf-tap/documents/blob/master/README.md"
click node_packet_reassembly "https://github.com/sf-tap/documents/blob/master/README.md"
click node_l7_classification "https://github.com/sf-tap/documents/blob/master/README.md"
click node_socket_files "https://github.com/sf-tap/documents/blob/master/README.md"
click node_l7_analyzers "https://github.com/sf-tap/documents/blob/master/README.md"
click node_cell_incubator "https://github.com/sf-tap/documents/blob/master/README.md"

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_flow_abstractor,node_packet_reassembly,node_l7_classification toneBlue
class node_socket_files,node_l7_analyzers toneAmber
class node_cell_incubator,node_analysis_servers toneMint
class node_network_traffic,node_capture_nic,node_forward_nics toneIndigo
```

## Components

### Capture and analysis

- [Flow Abstractor](https://github.com/sf-tap/documents/blob/master/README.md): `README.md`
- [Packet reassembly](https://github.com/sf-tap/documents/blob/master/README.md): `README.md`
- [L7 classification](https://github.com/sf-tap/documents/blob/master/README.md): `README.md`

### Flow access

- [Socket files](https://github.com/sf-tap/documents/blob/master/README.md): `README.md`
- [L7 analyzers](https://github.com/sf-tap/documents/blob/master/README.md): `README.md`

### Flow distribution

- [Cell Incubator](https://github.com/sf-tap/documents/blob/master/README.md): `README.md`

### Other components

- **Network traffic**
- **Capture NIC**
- **Forwarding NICs**
- **Analysis servers**

## Connections

- Network traffic → Capture NIC: enters (evidence: `README.md`)
- Capture NIC → Flow Abstractor: captures via pcap (evidence: `README.md`)
- Flow Abstractor → Packet reassembly: reassembles packets (evidence: `README.md`)
- Flow Abstractor → L7 classification: classifies flows (evidence: `README.md`)
- Flow Abstractor → Socket files: outputs flows (evidence: `README.md`)
- L7 analyzers → Socket files: accesses flows (evidence: `README.md`)
- Network traffic → Cell Incubator: captures (evidence: `README.md`)
- Cell Incubator → Forwarding NICs: forwards flows (evidence: `README.md`)
- Forwarding NICs → Analysis servers: sends flows (evidence: `README.md`)
