mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-11-22 04:55:33 +03:00
d2cf3233b8
Merge in DNS/adguard-home from 3890-fix-stats to master
Updates #3890.
Squashed commit of the following:
commit a77a6204bc8a58f62a4fac70efdcae4267a64810
Merge: 834493a2 90e65b66
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Mon Dec 6 17:22:16 2021 +0300
Merge branch 'master' into 3890-fix-stats
commit 834493a22ae79199efcc44e0715e2ac6f6272963
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Mon Dec 6 17:09:30 2021 +0300
querylog: load once
commit b8000e7ba7a998fcd4553230ec5e5f9c90106e31
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Mon Dec 6 16:54:41 2021 +0300
querylog: fix docs
commit 7db99ccfa19b58100950c11d67b23bca7af3e5cb
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Mon Dec 6 16:51:31 2021 +0300
querylog: imp docs
commit 2a84650bd7ac5195730a7ab47b9562a83f721499
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Mon Dec 6 15:48:09 2021 +0300
querylog: imp anonyization
commit 0f63feb1ff5f006fc528c3b681ef3b9d2199581e
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Mon Dec 6 14:44:37 2021 +0300
all: imp code & docs
commit c4ccdcbb7248897edd178fd5cb77127e39ada73d
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Mon Dec 6 14:24:30 2021 +0300
all: log changes
commit 60bb777a5aff36bba129a078fa11ae566298178a
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Mon Dec 6 14:08:41 2021 +0300
all: use atomic value
commit c45886bd20eee2212b42686ff369830d8c08fe36
Author: Eugene Burkov <E.Burkov@AdGuard.COM>
Date: Tue Nov 30 18:50:02 2021 +0300
all: anonymize separately
88 lines
1.9 KiB
Go
88 lines
1.9 KiB
Go
// Package stats provides units for managing statistics of the filtering DNS
|
|
// server.
|
|
package stats
|
|
|
|
import (
|
|
"net"
|
|
"net/http"
|
|
)
|
|
|
|
type unitIDCallback func() uint32
|
|
|
|
// DiskConfig - configuration settings that are stored on disk
|
|
type DiskConfig struct {
|
|
Interval uint32 `yaml:"statistics_interval"` // time interval for statistics (in days)
|
|
}
|
|
|
|
// Config - module configuration
|
|
type Config struct {
|
|
Filename string // database file name
|
|
LimitDays uint32 // time limit (in days)
|
|
UnitID unitIDCallback // user function to get the current unit ID. If nil, the current time hour is used.
|
|
|
|
// Called when the configuration is changed by HTTP request
|
|
ConfigModified func()
|
|
|
|
// Register an HTTP handler
|
|
HTTPRegister func(string, string, func(http.ResponseWriter, *http.Request))
|
|
|
|
limit uint32 // maximum time we need to keep data for (in hours)
|
|
}
|
|
|
|
// New - create object
|
|
func New(conf Config) (Stats, error) {
|
|
return createObject(conf)
|
|
}
|
|
|
|
// Stats - main interface
|
|
type Stats interface {
|
|
Start()
|
|
|
|
// Close object.
|
|
// This function is not thread safe
|
|
// (can't be called in parallel with any other function of this interface).
|
|
Close()
|
|
|
|
// Update counters
|
|
Update(e Entry)
|
|
|
|
// Get IP addresses of the clients with the most number of requests
|
|
GetTopClientsIP(limit uint) []net.IP
|
|
|
|
// WriteDiskConfig - write configuration
|
|
WriteDiskConfig(dc *DiskConfig)
|
|
}
|
|
|
|
// TimeUnit - time unit
|
|
type TimeUnit int
|
|
|
|
// Supported time units
|
|
const (
|
|
Hours TimeUnit = iota
|
|
Days
|
|
)
|
|
|
|
// Result of DNS request processing
|
|
type Result int
|
|
|
|
// Supported result values
|
|
const (
|
|
RNotFiltered Result = iota + 1
|
|
RFiltered
|
|
RSafeBrowsing
|
|
RSafeSearch
|
|
RParental
|
|
rLast
|
|
)
|
|
|
|
// Entry is a statistics data entry.
|
|
type Entry struct {
|
|
// Clients is the client's primary ID.
|
|
//
|
|
// TODO(a.garipov): Make this a {net.IP, string} enum?
|
|
Client string
|
|
|
|
Domain string
|
|
Result Result
|
|
Time uint32 // processing time (msec)
|
|
}
|