dnslogging

README

CoreDNS dnslogging

This CoreDNS plugin forwards all DNS transactions to a Nats server specified by the config. Currently the format sent over the line is dictated by the cap'n proto files.

WIP Document

Documentation

Index

• Constants
• type Client
• type DNSLogging
  • func New() (*DNSLogging, error)
  • func (dl *DNSLogging) Close()
  • func (dl *DNSLogging) Initialize() (err error)
  • func (dl *DNSLogging) Name() string
  • func (dl *DNSLogging) ServeDNS(ctx context.Context, w dns.ResponseWriter, r *dns.Msg) (rc int, err error)
• type Error
  • func (e *Error) Error() string
• type KafkaClient
  • func NewKafkaClient(brokers []string, topic string) (kc *KafkaClient, err error)
  • func (kc *KafkaClient) Publish(log *Log) (err error)
• type Log
• type NatsClient
  • func NewNatsClient(natsURL string) (_ *NatsClient, err error)
  • func (nc *NatsClient) Publish(log *Log) error

Constants

const PluginName string = "dnslogging"

PluginName is the name of our plugin

Types

type Client

type Client interface {
	// Publish takes a request and publishes it to the streaming service, this should ideally be batching for performance, but that is left to programmer.
	Publish(req *dns.Msg, resp *dns.Msg) error
}

Client is the interface that other stremaing clients must implement to be used.

type DNSLogging

type DNSLogging struct {
	Next plugin.Handler
	// contains filtered or unexported fields
}

DNSLogging is our plugin struct. No configurations being persisted at this time

func New

func New() (*DNSLogging, error)

New creates a new instance of the DNSLogging type

func (*DNSLogging) Close

func (dl *DNSLogging) Close()

Close will drain and close of the nats connection

func (*DNSLogging) Initialize

func (dl *DNSLogging) Initialize() (err error)

Initialize handles the initial connection to the nats server.

func (*DNSLogging) Name

func (dl *DNSLogging) Name() string

Name is the name of our plugin

func (*DNSLogging) ServeDNS

func (dl *DNSLogging) ServeDNS(ctx context.Context, w dns.ResponseWriter, r *dns.Msg) (rc int, err error)

ServeDNS is doing the forwarding, this call can, and will fail since DNS resolution to the client should have succeeded by now

type Error

type Error struct {
	// contains filtered or unexported fields
}

Error type for the dns logging plugin

func (*Error) Error

func (e *Error) Error() string

type KafkaClient

type KafkaClient struct {
	// contains filtered or unexported fields
}

KafkaClient contains a kafka writer which can be used to async send messages to kafka

func NewKafkaClient

func NewKafkaClient(brokers []string, topic string) (kc *KafkaClient, err error)

NewKafkaClient creates a kafka client for the plugin to publish to

func (*KafkaClient) Publish

func (kc *KafkaClient) Publish(log *Log) (err error)

Publish sends a log object to kafka

type Log

type Log struct {
	Req  *dns.Msg
	Resp *dns.Msg
}

type NatsClient

type NatsClient struct {
	// contains filtered or unexported fields
}

func NewNatsClient

func NewNatsClient(natsURL string) (_ *NatsClient, err error)

NewNatsClient returns a connected Nats Client

func (*NatsClient) Publish

func (nc *NatsClient) Publish(log *Log) error