03a828ef51
Merge in DNS/adguard-home from golibs-errors to master
Squashed commit of the following:
commit 5aba278a31c5a213bd9e08273ce7277c57713b22
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Mon May 24 17:05:18 2021 +0300
all: imp code
commit f447eb875b81779fa9e391d98c31c1eeba7ef323
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Mon May 24 15:33:45 2021 +0300
replace agherr with golibs' errors
126 lines
3.0 KiB
Go
126 lines
3.0 KiB
Go
package querylog
|
|
|
|
import (
|
|
"net"
|
|
"net/http"
|
|
"path/filepath"
|
|
"time"
|
|
|
|
"github.com/AdguardTeam/AdGuardHome/internal/filtering"
|
|
"github.com/AdguardTeam/golibs/errors"
|
|
"github.com/AdguardTeam/golibs/log"
|
|
"github.com/miekg/dns"
|
|
)
|
|
|
|
// QueryLog - main interface
|
|
type QueryLog interface {
|
|
Start()
|
|
|
|
// Close query log object
|
|
Close()
|
|
|
|
// Add a log entry
|
|
Add(params AddParams)
|
|
|
|
// WriteDiskConfig - write configuration
|
|
WriteDiskConfig(c *Config)
|
|
}
|
|
|
|
// Config - configuration object
|
|
type Config struct {
|
|
// ConfigModified is called when the configuration is changed, for
|
|
// example by HTTP requests.
|
|
ConfigModified func()
|
|
|
|
// HTTPRegister registers an HTTP handler.
|
|
HTTPRegister func(string, string, func(http.ResponseWriter, *http.Request))
|
|
|
|
// FindClient returns client information by their IDs.
|
|
FindClient func(ids []string) (c *Client, err error)
|
|
|
|
// BaseDir is the base directory for log files.
|
|
BaseDir string
|
|
|
|
// RotationIvl is the interval for log rotation, in days. After that
|
|
// period, the old log file will be renamed, NOT deleted, so the actual
|
|
// log retention time is twice the interval.
|
|
RotationIvl uint32
|
|
|
|
// MemSize is the number of entries kept in a memory buffer before they
|
|
// are flushed to disk.
|
|
MemSize uint32
|
|
|
|
// Enabled tells if the query log is enabled.
|
|
Enabled bool
|
|
|
|
// FileEnabled tells if the query log writes logs to files.
|
|
FileEnabled bool
|
|
|
|
// AnonymizeClientIP tells if the query log should anonymize clients' IP
|
|
// addresses.
|
|
AnonymizeClientIP bool
|
|
}
|
|
|
|
// AddParams - parameters for Add()
|
|
type AddParams struct {
|
|
Question *dns.Msg
|
|
Answer *dns.Msg // The response we sent to the client (optional)
|
|
OrigAnswer *dns.Msg // The response from an upstream server (optional)
|
|
Result *filtering.Result // Filtering result (optional)
|
|
Elapsed time.Duration // Time spent for processing the request
|
|
ClientID string
|
|
ClientIP net.IP
|
|
Upstream string // Upstream server URL
|
|
ClientProto ClientProto
|
|
}
|
|
|
|
// validate returns an error if the parameters aren't valid.
|
|
func (p *AddParams) validate() (err error) {
|
|
switch {
|
|
case p.Question == nil:
|
|
return errors.Error("question is nil")
|
|
case len(p.Question.Question) != 1:
|
|
return errors.Error("more than one question")
|
|
case len(p.Question.Question[0].Name) == 0:
|
|
return errors.Error("no host in question")
|
|
case p.ClientIP == nil:
|
|
return errors.Error("no client ip")
|
|
default:
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// New creates a new instance of the query log.
|
|
func New(conf Config) (ql QueryLog) {
|
|
return newQueryLog(conf)
|
|
}
|
|
|
|
// newQueryLog crates a new queryLog.
|
|
func newQueryLog(conf Config) (l *queryLog) {
|
|
findClient := conf.FindClient
|
|
if findClient == nil {
|
|
findClient = func(_ []string) (_ *Client, _ error) {
|
|
return nil, nil
|
|
}
|
|
}
|
|
|
|
l = &queryLog{
|
|
findClient: findClient,
|
|
|
|
logFile: filepath.Join(conf.BaseDir, queryLogFileName),
|
|
}
|
|
|
|
l.conf = &Config{}
|
|
*l.conf = conf
|
|
|
|
if !checkInterval(conf.RotationIvl) {
|
|
log.Info(
|
|
"querylog: warning: unsupported rotation interval %d, setting to 1 day",
|
|
conf.RotationIvl,
|
|
)
|
|
l.conf.RotationIvl = 1
|
|
}
|
|
|
|
return l
|
|
}
|