Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow configuring an alternative logger #116

Merged
merged 2 commits into from
May 3, 2024
Merged

Allow configuring an alternative logger #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c296d9b
allow configuring an alternative logger (#3)
jcodybaker Feb 18, 2024
b6f893b
s/Log/Logger/ per PR comment
jcodybaker Apr 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ type QueryParam struct {
WantUnicastResponse bool // Unicast response desired, as per 5.4 in RFC
DisableIPv4 bool // Whether to disable usage of IPv4 for MDNS operations. Does not affect discovered addresses.
DisableIPv6 bool // Whether to disable usage of IPv6 for MDNS operations. Does not affect discovered addresses.
Logger *log.Logger // Optionally provide a *log.Logger to better manage log output.
}

// DefaultParams is used to return a default set of QueryParam's
Expand Down Expand Up @@ -78,8 +79,11 @@ func Query(params *QueryParam) error {
// either read or buffer. QueryContext will attempt to stop the query
// on cancellation.
func QueryContext(ctx context.Context, params *QueryParam) error {
if params.Logger == nil {
params.Logger = log.Default()
}
// Create a new client
client, err := newClient(!params.DisableIPv4, !params.DisableIPv6)
client, err := newClient(!params.DisableIPv4, !params.DisableIPv6, params.Logger)
if err != nil {
return err
}
Expand Down Expand Up @@ -134,11 +138,13 @@ type client struct {

closed int32
closedCh chan struct{} // TODO(reddaly): This doesn't appear to be used.

log *log.Logger
}

// NewClient creates a new mdns Client that can be used to query
// for records
func newClient(v4 bool, v6 bool) (*client, error) {
func newClient(v4 bool, v6 bool, logger *log.Logger) (*client, error) {
if !v4 && !v6 {
return nil, fmt.Errorf("Must enable at least one of IPv4 and IPv6 querying")
}
Expand All @@ -154,14 +160,14 @@ func newClient(v4 bool, v6 bool) (*client, error) {
if v4 {
uconn4, err = net.ListenUDP("udp4", &net.UDPAddr{IP: net.IPv4zero, Port: 0})
if err != nil {
log.Printf("[ERR] mdns: Failed to bind to udp4 port: %v", err)
logger.Printf("[ERR] mdns: Failed to bind to udp4 port: %v", err)
}
}

if v6 {
uconn6, err = net.ListenUDP("udp6", &net.UDPAddr{IP: net.IPv6zero, Port: 0})
if err != nil {
log.Printf("[ERR] mdns: Failed to bind to udp6 port: %v", err)
logger.Printf("[ERR] mdns: Failed to bind to udp6 port: %v", err)
}
}

Expand All @@ -172,13 +178,13 @@ func newClient(v4 bool, v6 bool) (*client, error) {
if v4 {
mconn4, err = net.ListenMulticastUDP("udp4", nil, ipv4Addr)
if err != nil {
log.Printf("[ERR] mdns: Failed to bind to udp4 port: %v", err)
logger.Printf("[ERR] mdns: Failed to bind to udp4 port: %v", err)
}
}
if v6 {
mconn6, err = net.ListenMulticastUDP("udp6", nil, ipv6Addr)
if err != nil {
log.Printf("[ERR] mdns: Failed to bind to udp6 port: %v", err)
logger.Printf("[ERR] mdns: Failed to bind to udp6 port: %v", err)
}
}

Expand All @@ -194,6 +200,7 @@ func newClient(v4 bool, v6 bool) (*client, error) {
ipv4UnicastConn: uconn4,
ipv6UnicastConn: uconn6,
closedCh: make(chan struct{}),
log: logger,
}
return c, nil
}
Expand All @@ -205,7 +212,7 @@ func (c *client) Close() error {
return nil
}

log.Printf("[INFO] mdns: Closing client %v", *c)
c.log.Printf("[INFO] mdns: Closing client %v", *c)
close(c.closedCh)

if c.ipv4UnicastConn != nil {
Expand Down Expand Up @@ -365,7 +372,7 @@ func (c *client) query(params *QueryParam) error {
m.SetQuestion(inp.Name, dns.TypePTR)
m.RecursionDesired = false
if err := c.sendQuery(m); err != nil {
log.Printf("[ERR] mdns: Failed to query instance %s: %v", inp.Name, err)
c.log.Printf("[ERR] mdns: Failed to query instance %s: %v", inp.Name, err)
}
}
case <-finish:
Expand Down Expand Up @@ -409,12 +416,12 @@ func (c *client) recv(l *net.UDPConn, msgCh chan *msgAddr) {
}

if err != nil {
log.Printf("[ERR] mdns: Failed to read packet: %v", err)
c.log.Printf("[ERR] mdns: Failed to read packet: %v", err)
continue
}
msg := new(dns.Msg)
if err := msg.Unpack(buf[:n]); err != nil {
log.Printf("[ERR] mdns: Failed to unpack packet: %v", err)
c.log.Printf("[ERR] mdns: Failed to unpack packet: %v", err)
continue
}
select {
Expand Down
13 changes: 10 additions & 3 deletions server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ type Config struct {
// LogEmptyResponses indicates the server should print an informative message
// when there is an mDNS query for which the server has no response.
LogEmptyResponses bool

// Logger can optionally be set to use an alternative logger instead of the default.
Logger *log.Logger
}

// mDNS server is used to listen for mDNS queries and respond if we
Expand All @@ -69,6 +72,10 @@ func NewServer(config *Config) (*Server, error) {
return nil, fmt.Errorf("no multicast listeners could be started")
}

if config.Logger == nil {
config.Logger = log.Default()
}

s := &Server{
config: config,
ipv4List: ipv4List,
Expand Down Expand Up @@ -118,7 +125,7 @@ func (s *Server) recv(c *net.UDPConn) {
continue
}
if err := s.parsePacket(buf[:n], from); err != nil {
log.Printf("[ERR] mdns: Failed to handle query: %v", err)
s.config.Logger.Printf("[ERR] mdns: Failed to handle query: %v", err)
}
}
}
Expand All @@ -127,7 +134,7 @@ func (s *Server) recv(c *net.UDPConn) {
func (s *Server) parsePacket(packet []byte, from net.Addr) error {
var msg dns.Msg
if err := msg.Unpack(packet); err != nil {
log.Printf("[ERR] mdns: Failed to unpack packet: %v", err)
s.config.Logger.Printf("[ERR] mdns: Failed to unpack packet: %v", err)
return err
}
return s.handleQuery(&msg, from)
Expand Down Expand Up @@ -226,7 +233,7 @@ func (s *Server) handleQuery(query *dns.Msg, from net.Addr) error {
for i, q := range query.Question {
questions[i] = q.Name
}
log.Printf("no responses for query with questions: %s", strings.Join(questions, ", "))
s.config.Logger.Printf("no responses for query with questions: %s", strings.Join(questions, ", "))
}

if mresp := resp(false); mresp != nil {
Expand Down
Loading