Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.1.3

Oct 18, 2026

v1.1.2

Oct 17, 2026

Changes in this version

type CollectorStatus

+ ExcludedNamespacePackets uint64

+ NamespaceReadErrors uint64

v1.1.1

Oct 17, 2026

v1.1.0

Oct 17, 2026

v1.0.1

Oct 17, 2026

v1.0.0

Oct 17, 2026

Changes in this version

+ func DefaultSocketPath() string

+ func UserSocketPath() string

+ type AppUsageResponse struct

+ AppID int64

+ BytesIn int64

+ BytesOut int64

+ Category int

+ CategoryStr string

+ Identity *identity.AppIdentity

+ PacketsIn int64

+ PacketsOut int64

+ RateIn float64

+ RateOut float64

+ TotalBytes int64

+ type Client struct

+ func NewClient(socketPath string) *Client

+ func (c *Client) GetApps(date string, sort string, filter string) ([]AppUsageResponse, error)

+ func (c *Client) GetDoctor() (*DoctorReport, error)

+ func (c *Client) GetHistory(appKey string, days int) ([]storage.AppHistoryPoint, error)

+ func (c *Client) GetLive() (*LiveStatus, error)

+ func (c *Client) GetStatus() (*CollectorStatus, error)

+ func (c *Client) GetSummary(date string) (*storage.DaySummary, error)

+ type CollectorStatus struct

+ ActiveAppCount int

+ LastFlushTime time.Time

+ MapErrors uint64

+ RecoveredSockets uint64

+ RecoveryErrors uint64

+ SocketsRegistered uint64

+ StartTime time.Time

+ TotalEgressPackets uint64

+ TotalIngressPackets uint64

+ UnattributedEgress uint64

+ UnattributedIngress uint64

+ UptimeSeconds int64

+ Version string

+ type DataProvider interface

+ GetCollectorStatus func() CollectorStatus

+ GetDoctorReport func() DoctorReport

+ GetLiveStatus func() LiveStatus

+ type DoctorReport struct

+ BTFAvailable bool

+ CgroupV2Mounted bool

+ DBWritable bool

+ HasCAPBPF bool

+ HasCAPNetAdmin bool

+ KernelVersion string

+ SELinuxStatus string

+ SocketReachable bool

+ Warnings []string

+ type LiveAppRate struct

+ AppKey string

+ Category string

+ DisplayName string

+ RateIn float64

+ RateOut float64

+ TotalRate float64

+ type LiveStatus struct

+ AppRates []LiveAppRate

+ Timestamp time.Time

+ TotalRate float64

+ TotalRateIn float64

+ TotalRateOut float64

+ type Server struct

+ func NewServer(store *storage.Storage, provider DataProvider, socketPath string) *Server

+ func (s *Server) Start() error

+ func (s *Server) Stop() error