func DebugHandler(typstring)http.Handler

func RegisterDebugHandler(typstring, hhttp.Handler)

func StaticMessage(sstring) func(Args)string

type Argstring

type Args map[Arg]string

type Change struct {// ControlHealthChanged indicates it was health messages from the// control-plane server that changed.ControlHealthChangedbool// WarnableChanged indicates it was a client Warnable which changed state.WarnableChangedbool// Warnable is whose health changed, as indicated in UnhealthyState.Warnable *Warnable// UnhealthyState is set if the changed Warnable is now unhealthy, or nil// if Warnable is now healthy.UnhealthyState *UnhealthyState}

type ReceiveFuncint

const (ReceiveIPv4ReceiveFunc = 0ReceiveIPv6ReceiveFunc = 1ReceiveDERPReceiveFunc = 2)

ReceiveFunc indices for Tracker.MagicSockReceiveFuncs.

func (ReceiveFunc)String¶added inv1.66.0

func (fReceiveFunc) String()string

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

func (*ReceiveFuncStats)Enter¶added inv1.8.0

func (s *ReceiveFuncStats) Enter()

func (*ReceiveFuncStats)Exit¶added inv1.8.0

func (s *ReceiveFuncStats) Exit()

func (*ReceiveFuncStats)Name¶added inv1.72.0

func (s *ReceiveFuncStats) Name()string

Name returns the name of the receive func ("ReceiveIPv4", "ReceiveIPv6", etc).

type Severitystring

type State struct {// Each key-value pair in Warnings represents a Warnable that is currently// unhealthy. If a Warnable is healthy, it will not be present in this map.// When a Warnable is unhealthy and becomes healthy, its key-value pair// disappears in the next issued State. Observers should treat the absence of// a WarnableCode in this map as an indication that the Warnable became healthy,// and may use that to clear any notifications that were previously shown to the user.// If Warnings is nil, all Warnables are healthy and the backend is overall healthy.Warnings map[WarnableCode]UnhealthyState}

type Tracker struct {// MagicSockReceiveFuncs tracks the state of the three// magicsock receive functions: IPv4, IPv6, and DERP.MagicSockReceiveFuncs [3]ReceiveFuncStats// indexed by ReceiveFunc values// contains filtered or unexported fields}

funcNewTracker¶added inv1.90.0

func NewTracker(bus *eventbus.Bus) *Tracker

NewTracker contructs a newTracker and attaches the given eventbus.NewTracker will panic is no eventbus is given.

func (*Tracker)AppendWarnableDebugFlags¶added inv1.66.0

func (t *Tracker) AppendWarnableDebugFlags(base []string) []string

AppendWarnableDebugFlags appends to base any health items that are currently in failedstate and were created with MapDebugFlag.

func (*Tracker)CurrentState¶added inv1.70.0

func (t *Tracker) CurrentState() *State

CurrentState returns a snapshot of the current health status of the backend.It returns a State with nil Warnings if the backend is healthy (all Warnableshave no issues).The returned State is a snapshot of shared memory, and the caller should notmutate the returned value.

func (*Tracker)GetDERPRegionReceivedTime¶added inv1.66.0

func (t *Tracker) GetDERPRegionReceivedTime(regionint)time.Time

GetDERPRegionReceivedTime returns the last time that a frame was receivedfrom the given DERP region, or the zero time if no communication with thatregion has occurred.

func (*Tracker)GetInPollNetMap¶added inv1.66.0

func (t *Tracker) GetInPollNetMap()bool

GetInPollNetMap reports whether the client has an openHTTP long poll open to the control plane.

func (*Tracker)GotStreamedMapResponse¶added inv1.66.0

func (t *Tracker) GotStreamedMapResponse()

GotStreamedMapResponse notes that we got a tailcfg.MapResponsemessage in streaming mode, even if it's just a keep-alive message.

This also notes that a map poll is in progress. To unset that, callSetOutOfPollNetMap().

func (*Tracker)IsUnhealthy¶added inv1.84.0

func (t *Tracker) IsUnhealthy(w *Warnable)bool

IsUnhealthy reports whether the current state is unhealthy because the givenwarnable is set.

func (*Tracker)LastNoiseDialWasRecent¶added inv1.76.0

func (t *Tracker) LastNoiseDialWasRecent()bool

LastNoiseDialWasRecent notes that we're attempting to dial control via thets2021 noise protocol and reports whether the prior dial was "recent"(currently defined as 2 minutes but subject to change).

If t is nil, it reports false.

func (*Tracker)NoteDERPRegionReceivedFrame¶added inv1.66.0

func (t *Tracker) NoteDERPRegionReceivedFrame(regionint)

NoteDERPRegionReceivedFrame is called to note that a frame was received fromthe given DERP region at the current time.

func (*Tracker)NoteMapRequestHeard¶added inv1.66.0

func (t *Tracker) NoteMapRequestHeard(mr *tailcfg.MapRequest)

NoteMapRequestHeard notes whenever we successfully sent a map requestto control for which we received a 200 response.

func (*Tracker)OverallError¶added inv1.66.0

func (t *Tracker) OverallError()error

OverallError returns a summary of the health state.

If there are multiple problems, the error will be joined usingerrors.Join.

func (*Tracker)ReceiveFuncStats¶added inv1.66.0

func (t *Tracker) ReceiveFuncStats(whichReceiveFunc) *ReceiveFuncStats

ReceiveFuncStats returns the ReceiveFuncStats tracker for the given functype.

If t is nil, it returns nil.

func (*Tracker)SetAnyInterfaceUp¶added inv1.66.0

func (t *Tracker) SetAnyInterfaceUp(upbool)

SetAnyInterfaceUp sets whether any network interface is up.

func (*Tracker)SetAuthRoutineInError¶added inv1.66.0

func (t *Tracker) SetAuthRoutineInError(errerror)

SetAuthRoutineInError records the latest error encountered as a result of alogin attempt. Providing a nil error indicates successful login, or thatbeing logged in w/coordination is not currently desired.

func (*Tracker)SetAutoUpdatePrefs¶added inv1.70.0

func (t *Tracker) SetAutoUpdatePrefs(checkbool, applyopt.Bool)

SetAutoUpdatePrefs sets the client auto-update preferences. The argumentsmatch the fields of ipn.AutoUpdatePrefs, but we cannot pass that structdirectly due to a circular import.

func (*Tracker)SetControlHealth¶added inv1.66.0

func (t *Tracker) SetControlHealth(problems map[tailcfg.DisplayMessageID]tailcfg.DisplayMessage)

func (*Tracker)SetDERPMap¶added inv1.70.0

func (t *Tracker) SetDERPMap(dm *tailcfg.DERPMap)

SetDERPMap sets the last fetched DERP map in the Tracker. The DERP map is usedto provide a region name in user-facing DERP-related warnings.

func (*Tracker)SetDERPRegionConnectedState¶added inv1.66.0

func (t *Tracker) SetDERPRegionConnectedState(regionint, connectedbool)

func (*Tracker)SetDERPRegionHealth¶added inv1.66.0

func (t *Tracker) SetDERPRegionHealth(regionint, problemstring)

SetDERPRegionHealth sets or clears any problem associated with theprovided DERP region.

func (*Tracker)SetHealthy¶added inv1.70.0

func (t *Tracker) SetHealthy(w *Warnable)

SetHealthy removes any warningState for the given Warnable.

func (*Tracker)SetIPNState¶added inv1.66.0

func (t *Tracker) SetIPNState(statestring, wantRunningbool)

state is an ipn.State.String() value: "Running", "Stopped", "NeedsLogin", etc.

func (*Tracker)SetLatestVersion¶added inv1.66.0

func (t *Tracker) SetLatestVersion(v *tailcfg.ClientVersion)

SetLatestVersion records the latest version of the Tailscale client.v can be nil if unknown.

func (*Tracker)SetLocalLogConfigHealth¶added inv1.66.0

func (t *Tracker) SetLocalLogConfigHealth(errerror)

SetLocalLogConfigHealth sets the error state of this client's local log configuration.

func (*Tracker)SetMagicSockDERPHome¶added inv1.66.0

func (t *Tracker) SetMagicSockDERPHome(regionint, homelessbool)

SetMagicSockDERPHome notes what magicsock's view of its home DERP is.

The homeless parameter is whether magicsock is running in DERP-disconnectedmode, without discovering and maintaining a connection to its home DERP.

func (*Tracker)SetMetricsRegistry¶added inv1.76.0

func (t *Tracker) SetMetricsRegistry(reg *usermetric.Registry)

SetMetricsRegistry sets up the metrics for the Tracker. It takesa usermetric.Registry and registers the metrics there.

func (*Tracker)SetOutOfPollNetMap¶added inv1.66.0

func (t *Tracker) SetOutOfPollNetMap()

SetOutOfPollNetMap records that the client is no longer inan HTTP map request long poll to the control plane.

func (*Tracker)SetTLSConnectionError¶added inv1.66.0

func (t *Tracker) SetTLSConnectionError(hoststring, errerror)

SetTLSConnectionError sets the error state for connections to a specifichost. Setting the error to nil will clear any previously-set error.

func (*Tracker)SetUDP4Unbound¶added inv1.66.0

func (t *Tracker) SetUDP4Unbound(unboundbool)

SetUDP4Unbound sets whether the udp4 bind failed completely.

func (*Tracker)SetUnhealthy¶added inv1.70.0

func (t *Tracker) SetUnhealthy(w *Warnable, argsArgs)

SetUnhealthy sets a warningState for the given Warnable with the provided Args, and should becalled when a Warnable becomes unhealthy, or its unhealthy status needs to be updated.SetUnhealthy takes ownership of args. The args can be nil if no additional information isneeded for the unhealthy state.

func (*Tracker)Strings¶added inv1.70.0

func (t *Tracker) Strings() []string

Strings() returns a string array containing the Text of all Warnings andControlHealth messages currently known to the Tracker. These strings can bepresented to the user, although ideally you would use the Code property oneach Warning to show a localized version of them instead. This function ishere for legacy compatibility purposes and is deprecated.

type UnhealthyState struct {WarnableCodeWarnableCodeSeveritySeverityTitlestringTextstringBrokenSince         *time.Time            `json:",omitempty"`ArgsArgs                  `json:",omitempty"`DependsOn           []WarnableCode        `json:",omitempty"`ImpactsConnectivitybool                  `json:",omitempty"`PrimaryAction       *UnhealthyStateAction `json:",omitempty"`// ETag identifies a specific version of an UnhealthyState. If the contents// of the other fields of two UnhealthyStates are the same, the ETags will// be the same. If the contents differ, the ETags will also differ. The// implementation is not defined and the value is opaque: it might be a// hash, it might be a simple counter. Implementations should not rely on// any specific implementation detail or format of the ETag string other// than string (in)equality.ETagstring `json:",omitzero"`}

type UnhealthyStateAction struct {URLstringLabelstring}

type Warnable struct {// Code is a string that uniquely identifies this Warnable across the entire Tailscale backend,// and can be mapped to a user-displayable localized string.CodeWarnableCode// Title is a string that the GUI uses as title for any message involving this Warnable. The title// should be short and fit in a single line.Titlestring// Text is a function that generates an extended string that the GUI will display to the user when// this Warnable is in an unhealthy state. The function can use the Args map to provide dynamic// information to the user.Text func(argsArgs)string// Severity is the severity of the Warnable, which the GUI can use to determine how to display it.// For instance, a Warnable with SeverityHigh could trigger a modal view, while a Warnable with// SeverityLow could be displayed in a less intrusive way.// TODO(angott): turn this into a SeverityFunc, which allows the Warnable to change its severity based on// the Args of the unhappy state, just like we do in the Text function.SeveritySeverity// DependsOn is a set of Warnables that this Warnable depends on and need to be healthy// before this Warnable is relevant. The GUI can use this information to ignore// this Warnable if one of its dependencies is unhealthy.// That is, if any of these Warnables are unhealthy, then this Warnable is not relevant// and should be considered healthy to bother the user about.DependsOn []*Warnable// MapDebugFlag is a MapRequest.DebugFlag that is sent to control when this Warnable is unhealthy//// Deprecated: this is only used in one case, and will be removed in a future PRMapDebugFlagstring// ImpactsConnectivity is whether this Warnable in an unhealthy state will impact the user's// ability to connect to the Internet or other nodes on the tailnet. On platforms where// the client GUI supports a tray icon, the client will display an exclamation mark// on the tray icon when ImpactsConnectivity is set to true and the Warnable is unhealthy.ImpactsConnectivitybool// TimeToVisible is the Duration that the Warnable has to be in an unhealthy state before it// should be surfaced as unhealthy to the user. This is used to prevent transient errors from being// displayed to the user.TimeToVisibletime.Duration}

funcRegister¶added inv1.70.0

func Register(w *Warnable) *Warnable

Register registers a new Warnable with the health package and returns it.Register panics if the Warnable was already registered, because Warnablesshould be unique across the program.

func (*Warnable)IsVisible¶added inv1.70.0

func (w *Warnable) IsVisible(ws *warningState, clockNow func()time.Time)bool

IsVisible returns whether the Warnable should be visible to the user, based on the TimeToVisiblefield of the Warnable and the BrokenSince time when the Warnable became unhealthy.

type WarnableCodestring