downtime

package module

v0.0.0-...-ded3fab Latest Latest Go to latest Published: Sep 22, 2023 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/RaphaelPour/downtime

Links

Open Source Insights

README ¶

downtime

Measures downtime by detecting the start and end of ICMP request timeouts (like ping -D -W 0.05 -i 0.1 <target>).

The tool needs sudo and the net raw capability to handle raw ICMP pakets:

sudo setcap cap_net_raw+ep <path to binary>

Quick start

install: go install github.com/RaphaelPour/downtime/cmd/downtime
set capability: sudo setcap cap_net_raw+ep <path to binary>
run: sudo downtime --target <target>

example:

   start: 2023-08-16 10:12:47.197488336 +0200 CEST m=+20.651438246
     end: 2023-08-16 10:13:06.331099665 +0200 CEST m=+39.785050063
duration: 19.133611817s

Usage

Usage of downtime:
      --duration duration   ICMP request interval (default 100ms)
      --target ip           target IP
      --timeout duration    ICMP reply timeout (default 50ms)

Documentation ¶

Index ¶

Variables
func IsDownCheck(reply icmp.ICMPReturn) bool
func IsUpCheck(reply icmp.ICMPReturn) bool
type DefaultICMP
- func (d DefaultICMP) SendICMP(localAddr string, dst net.Addr, target string, ttl, id int, ...) (icmp.ICMPReturn, error)
type ICMP
type ReplyChecker
type TimeSpan
- func (span TimeSpan) Duration() time.Duration
type Watcher
- func NewWatcher(target net.IP, options ...WatcherOption) Watcher
- func (w Watcher) Run() TimeSpan
- func (w Watcher) RunWithCheck(check ReplyChecker) time.Time
type WatcherOption

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	DefaultICMPInterface ICMP = new(DefaultICMP)
	DefaultIsDownCheck        = IsDownCheck
	DefaultIsUpCheck          = IsUpCheck
	DefaultTimeout            = time.Millisecond * 50
	DefaultInterval           = time.Millisecond * 100
)

Functions ¶

func IsDownCheck ¶

func IsDownCheck(reply icmp.ICMPReturn) bool

func IsUpCheck ¶

func IsUpCheck(reply icmp.ICMPReturn) bool

Types ¶

type DefaultICMP ¶

type DefaultICMP struct{}

func (DefaultICMP) SendICMP ¶

func (d DefaultICMP) SendICMP(
	localAddr string,
	dst net.Addr,
	target string,
	ttl, id int,
	timeout time.Duration,
	seq int,
) (icmp.ICMPReturn, error)

type ICMP ¶

type ICMP interface {
	SendICMP(localAddr string, dst net.Addr, target string, ttl, id int, timeout time.Duration, seq int) (icmp.ICMPReturn, error)
}

type ReplyChecker ¶

type ReplyChecker func(icmp.ICMPReturn) bool

type TimeSpan ¶

type TimeSpan struct {
	Start time.Time
	End   time.Time
}

func (TimeSpan) Duration ¶

func (span TimeSpan) Duration() time.Duration

type Watcher ¶

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

func NewWatcher ¶

func NewWatcher(target net.IP, options ...WatcherOption) Watcher

func (Watcher) Run ¶

func (w Watcher) Run() TimeSpan

func (Watcher) RunWithCheck ¶

func (w Watcher) RunWithCheck(check ReplyChecker) time.Time

type WatcherOption ¶

type WatcherOption func(*Watcher)

func WithInterval ¶

func WithInterval(interval time.Duration) WatcherOption

func WithIsDownCheck ¶

func WithIsDownCheck(check ReplyChecker) WatcherOption

func WithIsUpCheck ¶

func WithIsUpCheck(check ReplyChecker) WatcherOption

func WithTimeout ¶

func WithTimeout(timeout time.Duration) WatcherOption

func WithVerbosity ¶

func WithVerbosity(verbose bool) WatcherOption

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
downtime
mocks

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL