dnsdisc

Documentation

Index

• func GetResolver(ctx context.Context, nameserver string) *net.Resolver
• func SetPrometheusRegisterer(reg prometheus.Registerer, logger *zap.Logger)
• type DNSDiscoveryOption
  • func WithNameserver(nameserver string) DNSDiscoveryOption
• type DiscoveredNode
  • func RetrieveNodes(ctx context.Context, url string, opts ...DNSDiscoveryOption) ([]DiscoveredNode, error)
• type Metrics

Functions

func GetResolver

func GetResolver(ctx context.Context, nameserver string) *net.Resolver

GetResolver returns a *net.Resolver object using a custom nameserver, or the default system resolver if no nameserver is specified

func SetPrometheusRegisterer

func SetPrometheusRegisterer(reg prometheus.Registerer, logger *zap.Logger)

SetPrometheusRegisterer is used to setup a custom prometheus registerer for metrics

Types

type DNSDiscoveryOption

type DNSDiscoveryOption func(*dnsDiscoveryParameters)

func WithNameserver

func WithNameserver(nameserver string) DNSDiscoveryOption

WithNameserver is a DnsDiscoveryOption that configures the nameserver to use

type DiscoveredNode

type DiscoveredNode struct {
	PeerID   peer.ID
	PeerInfo peer.AddrInfo
	ENR      *enode.Node
}

func RetrieveNodes

func RetrieveNodes(ctx context.Context, url string, opts ...DNSDiscoveryOption) ([]DiscoveredNode, error)

RetrieveNodes returns a list of multiaddress given a url to a DNS discoverable ENR tree

type Metrics

type Metrics interface {
	RecordDiscoveredNodes(numNodes int)
	RecordError(err metricsErrCategory)
}

Metrics exposes the functions required to update prometheus metrics for dnsdisc protocol