juanfont/headscale

Support for Network Flow Logging?

Open

#1,687 opened on Jan 16, 2024

View on GitHub
 (11 comments) (28 reactions) (0 assignees)Go (38,374 stars) (2,104 forks)batch import
enhancementhelp wantedneeds design docneeds investigationno-stale-bot

Description

Would it be possible to add some kind of network flow logging to Headscale?

Perhaps something basic like byte counters between nodes to begin?

Contributor guide

Tech stack
go
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Understanding of GoFamiliarity with Headscale codebaseKnowledge of networkingDatabase design
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate existing headscale codebase for connection tracking mechanisms, such as in tailscale.go or control.go. Review comments in the issue for suggested approaches. Consider implementing byte counters between nodes using Prometheus metrics or database logging. Look at similar features in Tailscale for reference.