doctor

Documentation

Overview

Package doctor contains more in-depth healthchecks that can be run to aid in diagnosing Tailscale issues.

Index

• func RunChecks(ctx context.Context, log logger.Logf, checks ...Check)
• type Check
  • func CheckFunc(name string, run func(context.Context, logger.Logf) error) Check

Functions

func RunChecks

func RunChecks(ctx context.Context, log logger.Logf, checks ...Check)

RunChecks runs a list of checks in parallel, and logs any returned errors after all checks have returned.

Types

type Check

type Check interface {
	// Name should return a name describing this check, in lower-kebab-case
	// (i.e. "my-check", not "MyCheck" or "my_check").
	Name() string
	// Run executes the check, logging diagnostic information to the
	// provided logger function.
	Run(context.Context, logger.Logf) error
}

Check is the interface defining a singular check.

A check should log information that it gathers using the provided log function, and should attempt to make as much progress as possible in error conditions.

func CheckFunc

func CheckFunc(name string, run func(context.Context, logger.Logf) error) Check

CheckFunc creates a Check from a name and a function.