Documentation ¶
Overview ¶
Package probing is a simple but powerful ICMP echo (ping) library.
Here is a very simple example that sends and receives three packets:
pinger, err := probing.NewPinger("www.google.com") if err != nil { panic(err) } pinger.Count = 3 err = pinger.Run() // blocks until finished if err != nil { panic(err) } stats := pinger.Statistics() // get send/receive/rtt stats
Here is an example that emulates the traditional UNIX ping command:
pinger, err := probing.NewPinger("www.google.com") if err != nil { panic(err) } // Listen for Ctrl-C. c := make(chan os.Signal, 1) signal.Notify(c, os.Interrupt) go func() { for _ = range c { pinger.Stop() } }() pinger.OnRecv = func(pkt *probing.Packet) { fmt.Printf("%d bytes from %s: icmp_seq=%d time=%v\n", pkt.Nbytes, pkt.IPAddr, pkt.Seq, pkt.Rtt) } pinger.OnFinish = func(stats *probing.Statistics) { fmt.Printf("\n--- %s ping statistics ---\n", stats.Addr) fmt.Printf("%d packets transmitted, %d packets received, %v%% packet loss\n", stats.PacketsSent, stats.PacketsRecv, stats.PacketLoss) fmt.Printf("round-trip min/avg/max/stddev = %v/%v/%v/%v\n", stats.MinRtt, stats.AvgRtt, stats.MaxRtt, stats.StdDevRtt) } fmt.Printf("PING %s (%s):\n", pinger.Addr(), pinger.IPAddr()) err = pinger.Run() if err != nil { panic(err) }
It sends ICMP Echo Request packet(s) and waits for an Echo Reply in response. If it receives a response, it calls the OnRecv callback. When it's finished, it calls the OnFinish callback.
For a full ping example, see "cmd/ping/ping.go".
Index ¶
- Variables
- type HTTPCallInfo
- type HTTPCaller
- type HTTPCallerOption
- func WithHTTPCallerBody(body []byte) HTTPCallerOption
- func WithHTTPCallerCallFrequency(frequency time.Duration) HTTPCallerOption
- func WithHTTPCallerClient(client *http.Client) HTTPCallerOption
- func WithHTTPCallerHeaders(headers http.Header) HTTPCallerOption
- func WithHTTPCallerHost(host string) HTTPCallerOption
- func WithHTTPCallerIsValidResponse(isValid func(response *http.Response, body []byte) bool) HTTPCallerOption
- func WithHTTPCallerLogger(logger Logger) HTTPCallerOption
- func WithHTTPCallerMaxConcurrentCalls(max int) HTTPCallerOption
- func WithHTTPCallerMethod(method string) HTTPCallerOption
- func WithHTTPCallerOnConnDone(conConnDone func(suite *TraceSuite, network, addr string, err error)) HTTPCallerOption
- func WithHTTPCallerOnConnStart(onConnStart func(suite *TraceSuite, network, addr string)) HTTPCallerOption
- func WithHTTPCallerOnDNSDone(onDNSDone func(suite *TraceSuite, info httptrace.DNSDoneInfo)) HTTPCallerOption
- func WithHTTPCallerOnDNSStart(onDNSStart func(suite *TraceSuite, info httptrace.DNSStartInfo)) HTTPCallerOption
- func WithHTTPCallerOnFirstByteReceived(onGotFirstByte func(suite *TraceSuite)) HTTPCallerOption
- func WithHTTPCallerOnReq(onReq func(suite *TraceSuite)) HTTPCallerOption
- func WithHTTPCallerOnResp(onResp func(suite *TraceSuite, info *HTTPCallInfo)) HTTPCallerOption
- func WithHTTPCallerOnTLSDone(onTLSDone func(suite *TraceSuite, state tls.ConnectionState, err error)) HTTPCallerOption
- func WithHTTPCallerOnTLSStart(onTLSStart func(suite *TraceSuite)) HTTPCallerOption
- func WithHTTPCallerOnWroteRequest(onWroteRequest func(suite *TraceSuite)) HTTPCallerOption
- func WithHTTPCallerTimeout(timeout time.Duration) HTTPCallerOption
- type Logger
- type NoopLogger
- type Packet
- type Pinger
- func (p *Pinger) Addr() string
- func (p *Pinger) ID() int
- func (p *Pinger) IPAddr() *net.IPAddr
- func (p *Pinger) Mark() uint
- func (p *Pinger) Privileged() bool
- func (p *Pinger) Resolve() error
- func (p *Pinger) Run() error
- func (p *Pinger) RunWithContext(ctx context.Context) error
- func (p *Pinger) SetAddr(addr string) error
- func (p *Pinger) SetDoNotFragment(df bool)
- func (p *Pinger) SetID(id int)
- func (p *Pinger) SetIPAddr(ipaddr *net.IPAddr)
- func (p *Pinger) SetLogger(logger Logger)
- func (p *Pinger) SetMark(m uint)
- func (p *Pinger) SetNetwork(n string)
- func (p *Pinger) SetPrivileged(privileged bool)
- func (p *Pinger) Statistics() *Statistics
- func (p *Pinger) Stop()
- type Statistics
- type StdLogger
- type TraceSuite
- func (s *TraceSuite) GetConnEnd() time.Time
- func (s *TraceSuite) GetConnStart() time.Time
- func (s *TraceSuite) GetDNSEnd() time.Time
- func (s *TraceSuite) GetDNSStart() time.Time
- func (s *TraceSuite) GetFirstByteReceived() time.Time
- func (s *TraceSuite) GetGeneralEnd() time.Time
- func (s *TraceSuite) GetGeneralStart() time.Time
- func (s *TraceSuite) GetTLSEnd() time.Time
- func (s *TraceSuite) GetTLSStart() time.Time
- func (s *TraceSuite) GetWroteHeaders() time.Time
Constants ¶
This section is empty.
Variables ¶
var ( ErrMarkNotSupported = errors.New("setting SO_MARK socket option is not supported on this platform") ErrDFNotSupported = errors.New("setting do-not-fragment bit is not supported on this platform") )
Functions ¶
This section is empty.
Types ¶
type HTTPCallInfo ¶
type HTTPCallInfo struct { // StatusCode is a response status code StatusCode int // IsValidResponse represents a fact of whether a response is treated as valid. You can read more about it in // HTTPCaller annotation. IsValidResponse bool }
HTTPCallInfo represents a data set which passed as a function argument to an onResp callback.
type HTTPCaller ¶
type HTTPCaller struct {
// contains filtered or unexported fields
}
HTTPCaller represents a prober performing http calls and collecting relevant statistics.
func NewHttpCaller ¶
func NewHttpCaller(url string, options ...HTTPCallerOption) *HTTPCaller
NewHttpCaller returns a new HTTPCaller. URL parameter is the only required one, other options might be specified via functional parameters, otherwise default values will be used where applicable.
func (*HTTPCaller) RunWithContext ¶
func (c *HTTPCaller) RunWithContext(ctx context.Context)
RunWithContext starts execution of a probing and allows providing a context.
func (*HTTPCaller) Stop ¶
func (c *HTTPCaller) Stop()
Stop gracefully stops the execution of a HTTPCaller.
type HTTPCallerOption ¶
type HTTPCallerOption func(options *httpCallerOptions)
HTTPCallerOption represents a function type for a functional parameter passed to a NewHttpCaller constructor.
func WithHTTPCallerBody ¶
func WithHTTPCallerBody(body []byte) HTTPCallerOption
WithHTTPCallerBody is a functional parameter for a HTTPCaller which specifies a body that should be set in request.
func WithHTTPCallerCallFrequency ¶
func WithHTTPCallerCallFrequency(frequency time.Duration) HTTPCallerOption
WithHTTPCallerCallFrequency is a functional parameter for a HTTPCaller which specifies a call frequency. If this option is not provided the default one will be used. You can check default value in const defaultHTTPCallFrequency.
func WithHTTPCallerClient ¶
func WithHTTPCallerClient(client *http.Client) HTTPCallerOption
WithHTTPCallerClient is a functional parameter for a HTTPCaller which specifies a http.Client.
func WithHTTPCallerHeaders ¶
func WithHTTPCallerHeaders(headers http.Header) HTTPCallerOption
WithHTTPCallerHeaders is a functional parameter for a HTTPCaller which specifies headers that should be set in request. To override a Host header use a WithHTTPCallerHost method.
func WithHTTPCallerHost ¶
func WithHTTPCallerHost(host string) HTTPCallerOption
WithHTTPCallerHost is a functional parameter for a HTTPCaller which allowed to override a host header.
func WithHTTPCallerIsValidResponse ¶
func WithHTTPCallerIsValidResponse(isValid func(response *http.Response, body []byte) bool) HTTPCallerOption
WithHTTPCallerIsValidResponse is a functional parameter for a HTTPCaller which specifies a function that will be used to assess whether a response is valid. If not specified, all responses will be treated as valid. You can read more explanation about this parameter in HTTPCaller annotation.
func WithHTTPCallerLogger ¶
func WithHTTPCallerLogger(logger Logger) HTTPCallerOption
WithHTTPCallerLogger is a functional parameter for a HTTPCaller which specifies a logger. If not specified, logs will be omitted.
func WithHTTPCallerMaxConcurrentCalls ¶
func WithHTTPCallerMaxConcurrentCalls(max int) HTTPCallerOption
WithHTTPCallerMaxConcurrentCalls is a functional parameter for a HTTPCaller which specifies a number of maximum concurrent calls. If this option is not provided the default one will be used. You can check default value in const defaultHTTPMaxConcurrentCalls.
func WithHTTPCallerMethod ¶
func WithHTTPCallerMethod(method string) HTTPCallerOption
WithHTTPCallerMethod is a functional parameter for a HTTPCaller which specifies a method that should be set in request. If this option is not provided the default one will be used. You can check default value in const defaultHTTPMethod.
func WithHTTPCallerOnConnDone ¶
func WithHTTPCallerOnConnDone(conConnDone func(suite *TraceSuite, network, addr string, err error)) HTTPCallerOption
WithHTTPCallerOnConnDone is a functional parameter for a HTTPCaller which specifies a callback that will be called when connection establishment finished. You can read more explanation about this parameter in HTTPCaller annotation.
func WithHTTPCallerOnConnStart ¶
func WithHTTPCallerOnConnStart(onConnStart func(suite *TraceSuite, network, addr string)) HTTPCallerOption
WithHTTPCallerOnConnStart is a functional parameter for a HTTPCaller which specifies a callback that will be called when connection establishment started. You can read more explanation about this parameter in HTTPCaller annotation.
func WithHTTPCallerOnDNSDone ¶
func WithHTTPCallerOnDNSDone(onDNSDone func(suite *TraceSuite, info httptrace.DNSDoneInfo)) HTTPCallerOption
WithHTTPCallerOnDNSDone is a functional parameter for a HTTPCaller which specifies a callback that will be called when dns resolving ended. You can read more explanation about this parameter in HTTPCaller annotation.
func WithHTTPCallerOnDNSStart ¶
func WithHTTPCallerOnDNSStart(onDNSStart func(suite *TraceSuite, info httptrace.DNSStartInfo)) HTTPCallerOption
WithHTTPCallerOnDNSStart is a functional parameter for a HTTPCaller which specifies a callback that will be called when dns resolving starts. You can read more explanation about this parameter in HTTPCaller annotation.
func WithHTTPCallerOnFirstByteReceived ¶
func WithHTTPCallerOnFirstByteReceived(onGotFirstByte func(suite *TraceSuite)) HTTPCallerOption
WithHTTPCallerOnFirstByteReceived is a functional parameter for a HTTPCaller which specifies a callback that will be called when first response byte has been received. You can read more explanation about this parameter in HTTPCaller annotation.
func WithHTTPCallerOnReq ¶
func WithHTTPCallerOnReq(onReq func(suite *TraceSuite)) HTTPCallerOption
WithHTTPCallerOnReq is a functional parameter for a HTTPCaller which specifies a callback that will be called before the start of the http call execution. You can read more explanation about this parameter in HTTPCaller annotation.
func WithHTTPCallerOnResp ¶
func WithHTTPCallerOnResp(onResp func(suite *TraceSuite, info *HTTPCallInfo)) HTTPCallerOption
WithHTTPCallerOnResp is a functional parameter for a HTTPCaller which specifies a callback that will be called when response is received. You can read more explanation about this parameter in HTTPCaller annotation.
func WithHTTPCallerOnTLSDone ¶
func WithHTTPCallerOnTLSDone(onTLSDone func(suite *TraceSuite, state tls.ConnectionState, err error)) HTTPCallerOption
WithHTTPCallerOnTLSDone is a functional parameter for a HTTPCaller which specifies a callback that will be called when tls handshake ended. You can read more explanation about this parameter in HTTPCaller annotation.
func WithHTTPCallerOnTLSStart ¶
func WithHTTPCallerOnTLSStart(onTLSStart func(suite *TraceSuite)) HTTPCallerOption
WithHTTPCallerOnTLSStart is a functional parameter for a HTTPCaller which specifies a callback that will be called when tls handshake started. You can read more explanation about this parameter in HTTPCaller annotation.
func WithHTTPCallerOnWroteRequest ¶
func WithHTTPCallerOnWroteRequest(onWroteRequest func(suite *TraceSuite)) HTTPCallerOption
WithHTTPCallerOnWroteRequest is a functional parameter for a HTTPCaller which specifies a callback that will be called when request has been written. You can read more explanation about this parameter in HTTPCaller annotation.
func WithHTTPCallerTimeout ¶
func WithHTTPCallerTimeout(timeout time.Duration) HTTPCallerOption
WithHTTPCallerTimeout is a functional parameter for a HTTPCaller which specifies request timeout. If this option is not provided the default one will be used. You can check default value in const defaultTimeout.
type NoopLogger ¶
type NoopLogger struct { }
func (NoopLogger) Debugf ¶
func (l NoopLogger) Debugf(format string, v ...interface{})
func (NoopLogger) Errorf ¶
func (l NoopLogger) Errorf(format string, v ...interface{})
func (NoopLogger) Fatalf ¶
func (l NoopLogger) Fatalf(format string, v ...interface{})
func (NoopLogger) Infof ¶
func (l NoopLogger) Infof(format string, v ...interface{})
func (NoopLogger) Warnf ¶
func (l NoopLogger) Warnf(format string, v ...interface{})
type Packet ¶
type Packet struct { // Rtt is the round-trip time it took to ping. Rtt time.Duration // IPAddr is the address of the host being pinged. IPAddr *net.IPAddr // Addr is the string address of the host being pinged. Addr string // NBytes is the number of bytes in the message. Nbytes int // Seq is the ICMP sequence number. Seq int // TTL is the Time To Live on the packet. TTL int // ID is the ICMP identifier. ID int }
Packet represents a received and processed ICMP echo packet.
type Pinger ¶
type Pinger struct { // Interval is the wait time between each packet send. Default is 1s. Interval time.Duration // Timeout specifies a timeout before ping exits, regardless of how many // packets have been received. Timeout time.Duration // ResolveTimeout specifies a timeout to resolve an IP address or domain name ResolveTimeout time.Duration // Count tells pinger to stop after sending (and receiving) Count echo // packets. If this option is not specified, pinger will operate until // interrupted. Count int // Debug runs in debug mode Debug bool // Number of packets sent PacketsSent int // Number of packets received PacketsRecv int // Number of duplicate packets received PacketsRecvDuplicates int // If true, keep a record of rtts of all received packets. // Set to false to avoid memory bloat for long running pings. RecordRtts bool // OnSetup is called when Pinger has finished setting up the listening socket OnSetup func() // OnSend is called when Pinger sends a packet OnSend func(*Packet) // OnRecv is called when Pinger receives and processes a packet OnRecv func(*Packet) // OnFinish is called when Pinger exits OnFinish func(*Statistics) // OnDuplicateRecv is called when a packet is received that has already been received. OnDuplicateRecv func(*Packet) // OnSendError is called when an error occurs while Pinger attempts to send a packet OnSendError func(*Packet, error) // OnRecvError is called when an error occurs while Pinger attempts to receive a packet OnRecvError func(error) // Size of packet being sent Size int // Tracker: Used to uniquely identify packets - Deprecated Tracker uint64 // Source is the source IP address Source string TTL int // contains filtered or unexported fields }
Pinger represents a packet sender/receiver.
func (*Pinger) Privileged ¶
Privileged returns whether pinger is running in privileged mode.
func (*Pinger) Run ¶
Run runs the pinger. This is a blocking function that will exit when it's done. If Count or Interval are not specified, it will run continuously until it is interrupted.
func (*Pinger) RunWithContext ¶
RunWithContext runs the pinger with a context. This is a blocking function that will exit when it's done or if the context is canceled. If Count or Interval are not specified, it will run continuously until it is interrupted.
func (*Pinger) SetAddr ¶
SetAddr resolves and sets the ip address of the target host, addr can be a DNS name like "www.google.com" or IP like "127.0.0.1".
func (*Pinger) SetDoNotFragment ¶
SetDoNotFragment sets the do-not-fragment bit in the outer IP header to the desired value.
func (*Pinger) SetNetwork ¶
SetNetwork allows configuration of DNS resolution. * "ip" will automatically select IPv4 or IPv6. * "ip4" will select IPv4. * "ip6" will select IPv6.
func (*Pinger) SetPrivileged ¶
SetPrivileged sets the type of ping pinger will send. false means pinger will send an "unprivileged" UDP ping. true means pinger will send a "privileged" raw ICMP ping. NOTE: setting to true requires that it be run with super-user privileges.
func (*Pinger) Statistics ¶
func (p *Pinger) Statistics() *Statistics
Statistics returns the statistics of the pinger. This can be run while the pinger is running or after it is finished. OnFinish calls this function to get it's finished statistics.
type Statistics ¶
type Statistics struct { // PacketsRecv is the number of packets received. PacketsRecv int // PacketsSent is the number of packets sent. PacketsSent int // PacketsRecvDuplicates is the number of duplicate responses there were to a sent packet. PacketsRecvDuplicates int // PacketLoss is the percentage of packets lost. PacketLoss float64 // IPAddr is the address of the host being pinged. IPAddr *net.IPAddr // Addr is the string address of the host being pinged. Addr string // Rtts is all of the round-trip times sent via this pinger. Rtts []time.Duration // MinRtt is the minimum round-trip time sent via this pinger. MinRtt time.Duration // MaxRtt is the maximum round-trip time sent via this pinger. MaxRtt time.Duration // AvgRtt is the average round-trip time sent via this pinger. AvgRtt time.Duration // StdDevRtt is the standard deviation of the round-trip times sent via // this pinger. StdDevRtt time.Duration }
Statistics represent the stats of a currently running or finished pinger operation.
type TraceSuite ¶
type TraceSuite struct { Extra any // contains filtered or unexported fields }
TraceSuite is a struct that is passed to each callback. It contains a bunch of time helpers, that you can use with a corresponding getter. These timers are set before making a corresponding callback, meaning that when an onDNSStart callback will be called - TraceSuite will already have filled dnsStart field. In addition to that, it contains an Extra field of type any which you can use in any custom way you might need. Before each callback call, mutex is used, meaning all operations inside your callback are concurrent-safe. Keep in mind, that if your http client set up to follow redirects - timers will be overwritten.
func (*TraceSuite) GetConnEnd ¶
func (s *TraceSuite) GetConnEnd() time.Time
GetConnEnd returns a time of a connection dial end.
func (*TraceSuite) GetConnStart ¶
func (s *TraceSuite) GetConnStart() time.Time
GetConnStart returns a time of a connection dial start.
func (*TraceSuite) GetDNSEnd ¶
func (s *TraceSuite) GetDNSEnd() time.Time
GetDNSEnd returns a time of a dns lookup send.
func (*TraceSuite) GetDNSStart ¶
func (s *TraceSuite) GetDNSStart() time.Time
GetDNSStart returns a time of a dns lookup start.
func (*TraceSuite) GetFirstByteReceived ¶
func (s *TraceSuite) GetFirstByteReceived() time.Time
GetFirstByteReceived returns a time when first response bytes were received.
func (*TraceSuite) GetGeneralEnd ¶
func (s *TraceSuite) GetGeneralEnd() time.Time
GetGeneralEnd returns a general http response time.
func (*TraceSuite) GetGeneralStart ¶
func (s *TraceSuite) GetGeneralStart() time.Time
GetGeneralStart returns a general http request execution start time.
func (*TraceSuite) GetTLSEnd ¶
func (s *TraceSuite) GetTLSEnd() time.Time
GetTLSEnd returns a time of a tls handshake end.
func (*TraceSuite) GetTLSStart ¶
func (s *TraceSuite) GetTLSStart() time.Time
GetTLSStart returns a time of a tls handshake start.
func (*TraceSuite) GetWroteHeaders ¶
func (s *TraceSuite) GetWroteHeaders() time.Time
GetWroteHeaders returns a time when request headers were written.