endpoint

Documentation

Index

• Constants
• Variables
• type DNSSnooper
  • func NewDNSSnooper() (*DNSSnooper, error)
  • func (s *DNSSnooper) CachedNamesForIP(ip string) []string
  • func (s *DNSSnooper) Stop()
• type Reporter
  • func NewReporter(conf ReporterConfig) *Reporter
  • func (Reporter) Name() string
  • func (r *Reporter) Report() (report.Report, error)
  • func (r *Reporter) Stop()
• type ReporterConfig

Constants

const (
	Addr            = "addr" // typically IPv4
	Port            = "port"
	Conntracked     = "conntracked"
	Procspied       = "procspied"
	ReverseDNSNames = "reverse_dns_names"
	SnoopedDNSNames = "snooped_dns_names"
)

Node metadata keys.

Variables

var IsConntrackSupported = func(procRoot string) error {
	procFile := filepath.Join(procRoot, procFileToCheck)
	_, err := os.Stat(procFile)
	return err
}

IsConntrackSupported returns true if conntrack is suppported by the kernel

var SpyDuration = prometheus.NewSummaryVec(
	prometheus.SummaryOpts{
		Namespace: "scope",
		Subsystem: "probe",
		Name:      "spy_duration_seconds",
		Help:      "Time in seconds spent spying on active connections.",
		MaxAge:    10 * time.Second,
	},
	[]string{},
)

SpyDuration is an exported prometheus metric

Types

type DNSSnooper

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

DNSSnooper is a snopper of DNS queries

func NewDNSSnooper

func NewDNSSnooper() (*DNSSnooper, error)

NewDNSSnooper creates a new snooper of DNS queries

func (*DNSSnooper) CachedNamesForIP

func (s *DNSSnooper) CachedNamesForIP(ip string) []string

CachedNamesForIP obtains the domains associated to an IP, obtained while snooping A-record queries

func (*DNSSnooper) Stop

func (s *DNSSnooper) Stop()

Stop makes the snooper stop inspecting DNS communications

type Reporter

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

Reporter generates Reports containing the Endpoint topology.

func NewReporter

func NewReporter(conf ReporterConfig) *Reporter

NewReporter creates a new Reporter that invokes procspy.Connections to generate a report.Report that contains every discovered (spied) connection on the host machine, at the granularity of host and port. That information is stored in the Endpoint topology. It optionally enriches that topology with process (PID) information.

func (Reporter) Name

func (Reporter) Name() string

Name of this reporter, for metrics gathering

func (*Reporter) Report

func (r *Reporter) Report() (report.Report, error)

Report implements Reporter.

func (*Reporter) Stop

func (r *Reporter) Stop()

Stop stop stop

type ReporterConfig

type ReporterConfig struct {
	HostID       string
	HostName     string
	SpyProcs     bool
	UseConntrack bool
	WalkProc     bool
	ProcRoot     string
	BufferSize   int
	Scanner      procspy.ConnectionScanner
	DNSSnooper   *DNSSnooper
}

ReporterConfig are the config options for the endpoint reporter.