setup

Documentation

Index

• func BuildBlockBuilder(userSettings config.Block, client *http.Client) (blockBuilder *blockbuilder.Builder, err error)
• type Cache
  • func BuildCache(userSettings config.Cache, metrics CacheMetrics) (cache Cache, err error)
• type CacheMetrics
  • func BuildCacheMetrics(userSettings config.Metrics, registry PrometheusRegistry) (metrics CacheMetrics, err error)
• type DoHMetrics
• type DoTMetrics
• type Filter
• type FilterMetrics
  • func BuildFilterMetrics(userSettings config.Metrics, registry PrometheusRegistry) (metrics FilterMetrics, err error)
• type Logger
• type LoggerConstructor
• type Middleware
• type PrometheusRegistry
• type Service
  • func DNS(userSettings config.Settings, ipv6Support bool, cache Cache, filter Filter, ...) (server Service, err error)

Functions

func BuildBlockBuilder

func BuildBlockBuilder(userSettings config.Block,
	client *http.Client) (blockBuilder *blockbuilder.Builder, err error)

Types

type Cache

type Cache interface {
	Add(request, response *dns.Msg)
	Get(request *dns.Msg) (response *dns.Msg)
}

func BuildCache

func BuildCache(userSettings config.Cache,
	metrics CacheMetrics) (cache Cache, err error)

type CacheMetrics

type CacheMetrics interface {
	SetCacheType(cacheType string)
	CacheInsertInc()
	CacheRemoveInc()
	CacheMoveInc()
	CacheGetEmptyInc()
	CacheInsertEmptyInc()
	CacheRemoveEmptyInc()
	CacheHitInc()
	CacheMissInc()
	CacheExpiredInc()
	CacheMaxEntriesSet(maxEntries int)
}

func BuildCacheMetrics

func BuildCacheMetrics(userSettings config.Metrics,
	registry PrometheusRegistry) (
	metrics CacheMetrics, err error)

type DoHMetrics

type DoHMetrics interface {
	DoHDialInc(url string)
	DoTDialInc(provider, address, outcome string)
	DNSDialInc(address, outcome string)
}

type DoTMetrics

type DoTMetrics interface {
	DoTDialInc(provider, address, outcome string)
	DNSDialInc(address, outcome string)
}

type Filter

type Filter interface {
	FilterRequest(request *dns.Msg) (blocked bool)
	FilterResponse(response *dns.Msg) (blocked bool)
	Update(settings update.Settings) (err error)
}

type FilterMetrics

type FilterMetrics interface {
	SetBlockedHostnames(n int)
	SetBlockedIPs(n int)
	SetBlockedIPPrefixes(n int)
	HostnamesFilteredInc(qClass, qType string)
	IPsFilteredInc(rrtype string)
}

func BuildFilterMetrics

func BuildFilterMetrics(userSettings config.Metrics,
	registry PrometheusRegistry) (
	metrics FilterMetrics, err error)

type Logger

type Logger interface {
	Debug(s string)
	Info(s string)
	Warn(s string)
	Error(s string)
}

type LoggerConstructor

type LoggerConstructor interface {
	New(options ...log.Option) *log.Logger
}

type Middleware

type Middleware interface {
	String() string
	Wrap(next dns.Handler) dns.Handler
	Stop() (err error)
}

type PrometheusRegistry

type PrometheusRegistry interface {
	prometheus.Registerer
}

type Service

type Service interface {
	String() string
	Start() (runError <-chan error, startErr error)
	Stop() (err error)
}

func DNS

func DNS(userSettings config.Settings, ipv6Support bool,
	cache Cache, filter Filter, loggerConstructor LoggerConstructor,
	promRegistry PrometheusRegistry) (server Service, err error)