docs(architecture): update api types for new fields
- Add Timestamp field to api.LogRecord (nanoseconds since Unix epoch) - Add PacketBufferSize field to api.Config (default: 1000) Reflects changes from commits: -f362e32feat(api): add timestamp field to LogRecord -dfd5e49feat(config): add configurable packet channel buffer size Implements evolution.api_stability.rules.document_changes from architecture.yml Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
This commit is contained in:
@ -146,10 +146,11 @@ api:
|
|||||||
- name: "api.Config"
|
- name: "api.Config"
|
||||||
description: "Configuration réseau et TLS de base."
|
description: "Configuration réseau et TLS de base."
|
||||||
fields:
|
fields:
|
||||||
- { name: Interface, type: "string", description: "Nom de l'interface réseau (ex: eth0)." }
|
- { name: Interface, type: "string", description: "Nom de l'interface réseau (ex: eth0)." }
|
||||||
- { name: ListenPorts, type: "[]uint16", description: "Ports TCP à surveiller (ex: [443, 8443])." }
|
- { name: ListenPorts, type: "[]uint16", description: "Ports TCP à surveiller (ex: [443, 8443])." }
|
||||||
- { name: BPFFilter, type: "string", description: "Filtre BPF optionnel pour la capture." }
|
- { name: BPFFilter, type: "string", description: "Filtre BPF optionnel pour la capture." }
|
||||||
- { name: FlowTimeoutSec, type: "int", description: "Timeout en secondes pour l'extraction du handshake TLS (défaut: 30)." }
|
- { name: FlowTimeoutSec, type: "int", description: "Timeout en secondes pour l'extraction du handshake TLS (défaut: 30)." }
|
||||||
|
- { name: PacketBufferSize,type: "int", description: "Taille du buffer du canal de paquets (défaut: 1000). Pour les environnements à fort trafic." }
|
||||||
|
|
||||||
- name: "api.IPMeta"
|
- name: "api.IPMeta"
|
||||||
description: "Métadonnées IP pour fingerprinting de stack."
|
description: "Métadonnées IP pour fingerprinting de stack."
|
||||||
@ -219,6 +220,9 @@ api:
|
|||||||
- { name: JA3, type: "string", json_key: "ja3" }
|
- { name: JA3, type: "string", json_key: "ja3" }
|
||||||
- { name: JA3Hash, type: "string", json_key: "ja3_hash" }
|
- { name: JA3Hash, type: "string", json_key: "ja3_hash" }
|
||||||
|
|
||||||
|
# Timestamp
|
||||||
|
- { name: Timestamp, type: "int64", json_key: "timestamp", description: "Wall-clock timestamp in nanoseconds since Unix epoch (auto-filled by NewLogRecord)." }
|
||||||
|
|
||||||
|
|
||||||
- name: "api.OutputConfig"
|
- name: "api.OutputConfig"
|
||||||
description: "Configuration d’une sortie de logs."
|
description: "Configuration d’une sortie de logs."
|
||||||
|
|||||||
Reference in New Issue
Block a user