healthcheck

Documentation

Index

• Variables
• type ConnectionInfo
  • func CheckConnection(host string, port int, protocol string, timeout time.Duration) ConnectionInfo
• type DnsResolveInfo
  • func DnsResolve(host string, resolver string) DnsResolveInfo
• type EnvironmentInfo
  • func CollectEnvironmentInfo(appVersion string) EnvironmentInfo
• type HealthCheckInfo
  • func Do(programVersion string, options *Options) (healthCheckInfo HealthCheckInfo)
• type Options
• type PathPermission
  • func CheckPathPermission(path string) (pathPermission PathPermission)
• type Ulimit

Variables

var (
	DefaultPathsToCheckPermission   = []string{filepath.Join(folderutil.HomeDirOrDefault(""), ".config", fileutil.ExecutableName())}
	DefaultHostsToCheckConnectivity = []string{"scanme.sh"}
	DefaultResolver                 = "1.1.1.1:53"
)

var DefaultOptions = Options{
	Paths:    DefaultPathsToCheckPermission,
	Hosts:    DefaultHostsToCheckConnectivity,
	Resolver: DefaultResolver,
}

Types

type ConnectionInfo

type ConnectionInfo struct {
	Host       string
	Successful bool
	Message    string
	Error      error
}

func CheckConnection

func CheckConnection(host string, port int, protocol string, timeout time.Duration) ConnectionInfo

type DnsResolveInfo

type DnsResolveInfo struct {
	Host        string
	Resolver    string
	Successful  bool
	IPAddresses []net.IPAddr
	Error       error
}

func DnsResolve

func DnsResolve(host string, resolver string) DnsResolveInfo

type EnvironmentInfo

type EnvironmentInfo struct {
	ExternalIPv4   string
	Admin          bool
	Arch           string
	Compiler       string
	GoVersion      string
	OSName         string
	ProgramVersion string
	OutboundIPv4   string
	OutboundIPv6   string
	Ulimit         Ulimit
	PathEnvVar     string
	Error          error
}

func CollectEnvironmentInfo

func CollectEnvironmentInfo(appVersion string) EnvironmentInfo

type HealthCheckInfo

type HealthCheckInfo struct {
	EnvironmentInfo EnvironmentInfo
	PathPermissions []PathPermission
	DnsResolveInfos []DnsResolveInfo
}

func Do

func Do(programVersion string, options *Options) (healthCheckInfo HealthCheckInfo)

type Options

type Options struct {
	Paths    []string
	Hosts    []string
	Resolver string
}

type PathPermission

type PathPermission struct {
	Error error
	// contains filtered or unexported fields
}

func CheckPathPermission

func CheckPathPermission(path string) (pathPermission PathPermission)

CheckPathPermission checks the permissions of the given file or directory.

type Ulimit

type Ulimit struct {
	Current uint64
	Max     uint64
}