func LogURL()string

func LogsDir(logflogger.Logf)string

func MakeDialFunc(netMon *netmon.Monitor, logflogger.Logf)netx.DialFunc

type Config struct {CollectionstringPrivateIDlogid.PrivateIDPublicIDlogid.PublicID}

funcConfigFromBytes¶

func ConfigFromBytes(jsonEnc []byte) (*Config,error)

ConfigFromBytes parses a Config from its JSON encoding.

funcConfigFromFile¶added inv1.28.0

func ConfigFromFile(statefilestring) (*Config,error)

ConfigFromFile reads a Config from a JSON file.

funcNewConfig¶added inv1.28.0

func NewConfig(collectionstring) *Config

NewConfig creates a Config with collection and a newly generated PrivateID.

func (*Config)Save¶added inv1.28.0

func (c *Config) Save(stateFilestring)error

Save writes the JSON representation of c to stateFile.

func (*Config)ToBytes¶

func (c *Config) ToBytes() []byte

ToBytes returns the JSON representation of c.

func (*Config)Validate¶added inv1.28.0

func (c *Config) Validate(collectionstring)error

Validate verifies that the Config matches the collection,and that the PrivateID and PublicID pair are sensible.

type Options struct {// Collection is a required collection to upload logs under.// Collection is a namespace for the type logs.// For example, logs for a node use "tailnode.log.tailscale.io".Collectionstring// Dir is an optional directory to store the log configuration.// If empty, [LogsDir] is used.Dirstring// CmdName is an optional name of the current binary.// If empty, [version.CmdName] is used.CmdNamestring// NetMon is an optional parameter for monitoring.// If non-nil, it's used to do faster interface lookups.NetMon *netmon.Monitor// Health is an optional parameter for health status.// If non-nil, it's used to construct the default HTTP client.Health *health.Tracker// Bus is an optional parameter for communication on the eventbus.// If non-nil, it's passed to logtail for use in interface monitoring.// TODO(cmol): Make this non-optional when it's plumbed in by the clients.Bus *eventbus.Bus// Logf is an optional logger to use.// If nil, [log.Printf] will be used instead.Logflogger.Logf// HTTPC is an optional client to use upload logs.// If nil, [TransportOptions.New] is used to construct a new client// with that particular transport sending logs to the default logs server.HTTPC *http.Client// MaxBufferSize is the maximum size of the log buffer.// This controls the amount of logs that can be temporarily stored// before the logs can be successfully upload.// If zero, a default buffer size is chosen.MaxBufferSizeint// MaxUploadSize is the maximum size per upload.// This should only be set by clients that have been authenticated// with the logging service as having a higher upload limit.// If zero, a default upload size is chosen.MaxUploadSizeint}

func (Options)New¶added inv1.80.0

func (optsOptions) New() *Policy

New returns a new log policy (a logger and its instance ID).

type Policy struct {// Logtail is the logger.Logtail *logtail.Logger// PublicID is the logger's instance identifier.// It may be the zero value if logging is not in use.PublicIDlogid.PublicID// Logf is where to write informational messages about this Logger.Logflogger.Logf}

func (*Policy)Close¶

func (p *Policy) Close()

Close immediately shuts down the logger.

func (*Policy)SetVerbosityLevel¶added inv1.4.0

func (p *Policy) SetVerbosityLevel(levelint)

SetVerbosityLevel controls the verbosity level that should bewritten to stderr. 0 is the default (not verbose). Levels 1 or higherare increasingly verbose.

It should not be changed concurrently with log writes.

func (*Policy)Shutdown¶

func (p *Policy) Shutdown(ctxcontext.Context)error

Shutdown gracefully shuts down the logger, finishing any currentlog upload if it can be done before ctx is canceled.

type TransportOptions struct {// Host is the optional hostname of the logs server.// If empty, then [logtail.DefaultHost] is used.Hoststring// NetMon is an optional parameter for monitoring.// If non-nil, it's used to do faster interface lookups.NetMon *netmon.Monitor// Health is an optional parameter for health status.// If non-nil, it's used to construct the default HTTP client.Health *health.Tracker// Logf is an optional logger to use.// If nil, [log.Printf] will be used instead.Logflogger.Logf// TLSClientConfig is an optional TLS configuration to use.// If non-nil, the configuration will be cloned.TLSClientConfig *tls.Config}

func (TransportOptions)New¶added inv1.80.0

func (optsTransportOptions) New()http.RoundTripper

New returns an HTTP Transport particularly suited to uploading logsto the given host name. See [DialContext] for details on how it works.