Documentation
¶
Overview ¶
Package querylog provides query log functions and interfaces.
Index ¶
Constants ¶
const ( ErrTSNotFound errors.Error = "ts not found" ErrTSTooLate errors.Error = "ts too late" ErrTSTooEarly errors.Error = "ts too early" )
Timestamp not found errors.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddParams ¶
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
}
AddParams - parameters for Add()
type Client ¶ added in v0.106.0
type Client struct {
WHOIS *ClientWHOIS `json:"whois,omitempty"`
Name string `json:"name"`
DisallowedRule string `json:"disallowed_rule"`
Disallowed bool `json:"disallowed"`
}
Client is the information required by the query log to match against clients during searches.
type ClientProto ¶
type ClientProto string
ClientProto values are names of the client protocols.
const ( ClientProtoDoH ClientProto = "doh" ClientProtoDoQ ClientProto = "doq" ClientProtoDoT ClientProto = "dot" ClientProtoDNSCrypt ClientProto = "dnscrypt" ClientProtoPlain ClientProto = "" )
Client protocol names.
func NewClientProto ¶
func NewClientProto(s string) (cp ClientProto, err error)
NewClientProto validates that the client protocol name is valid and returns the name as a ClientProto.
type ClientWHOIS ¶ added in v0.107.0
type ClientWHOIS struct {
City string `json:"city,omitempty"`
Country string `json:"country,omitempty"`
Orgname string `json:"orgname,omitempty"`
}
ClientWHOIS is the filtered WHOIS data for the client.
TODO(a.garipov): Merge with home.RuntimeClientWHOISInfo after the refactoring is done.
type Config ¶
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. After that period, the
// old log file will be renamed, NOT deleted, so the actual log
// retention time is twice the interval. The value must be one of:
//
// 6 * time.Hour
// 24 * time.Hour
// 7 * 24 * time.Hour
// 30 * 24 * time.Hour
// 90 * 24 * time.Hour
//
RotationIvl time.Duration
// 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
}
Config - configuration object
type QLogFile ¶
type QLogFile struct {
// contains filtered or unexported fields
}
QLogFile represents a single query log file It allows reading from the file in the reverse order
Please note that this is a stateful object. Internally, it contains a pointer to a specific position in the file, and it reads lines in reverse order starting from that position.
func NewQLogFile ¶
NewQLogFile initializes a new instance of the QLogFile
func (*QLogFile) ReadNext ¶
ReadNext reads the next line (in the reverse order) from the file and shifts the current position left to the next (actually prev) line. returns io.EOF if there's nothing to read more
func (*QLogFile) SeekStart ¶
SeekStart changes the current position to the end of the file Please note that we're reading query log in the reverse order and that's why log start is actually the end of file
Returns nil if we were able to change the current position. Returns error in any other case.
func (*QLogFile) SeekTS ¶ added in v0.105.0
SeekTS performs binary search in the query log file looking for a record with the specified timestamp. Once the record is found, it sets "position" so that the next ReadNext call returned that record.
The algorithm is rather simple: 1. It starts with the position in the middle of a file 2. Shifts back to the beginning of the line 3. Checks the log record timestamp 4. If it is lower than the timestamp we are looking for, it shifts seek position to 3/4 of the file. Otherwise, to 1/4 of the file. 5. It performs the search again, every time the search scope is narrowed twice.
Returns: * It returns the position of the the line with the timestamp we were looking for so that when we call "ReadNext" this line was returned. * Depth of the search (how many times we compared timestamps). * If we could not find it, it returns one of the errors described above.
type QLogReader ¶
type QLogReader struct {
// contains filtered or unexported fields
}
QLogReader allows reading from multiple query log files in the reverse order.
Please note that this is a stateful object. Internally, it contains a pointer to a particular query log file, and to a specific position in this file, and it reads lines in reverse order starting from that position.
func NewQLogReader ¶
func NewQLogReader(files []string) (*QLogReader, error)
NewQLogReader initializes a QLogReader instance with the specified files
func (*QLogReader) ReadNext ¶
func (r *QLogReader) ReadNext() (string, error)
ReadNext reads the next line (in the reverse order) from the query log files. and shifts the current position left to the next (actually prev) line (or the next file). returns io.EOF if there's nothing to read more.
func (*QLogReader) SeekStart ¶
func (r *QLogReader) SeekStart() error
SeekStart changes the current position to the end of the newest file Please note that we're reading query log in the reverse order and that's why log start is actually the end of file
Returns nil if we were able to change the current position. Returns error in any other case.
func (*QLogReader) SeekTS ¶ added in v0.105.0
func (r *QLogReader) SeekTS(timestamp int64) (err error)
SeekTS performs binary search of a query log record with the specified timestamp. If the record is found, it sets QLogReader's position to point to that line, so that the next ReadNext call returned this line.
Source Files