logpolicy

Documentation

Overview

Package logpolicy manages the creation or reuse of logtail loggers, caching collection instance state on disk for use on future runs of programs on the same machine.

Index

• func LogHost() string
• func LogURL() string
• func NewLogtailTransport(host string) *http.Transport
• type Config
  • func ConfigFromBytes(jsonEnc []byte) (*Config, error)
  • func ConfigFromFile(statefile string) (*Config, error)
  • func NewConfig(collection string) *Config
  • func (c *Config) Save(stateFile string) error
  • func (c *Config) ToBytes() []byte
  • func (c *Config) Validate(collection string) error
• type Policy
  • func New(collection string) *Policy
  • func NewWithConfigPath(collection, dir, cmdName string) *Policy
  • func (p *Policy) Close()
  • func (p *Policy) SetVerbosityLevel(level int)
  • func (p *Policy) Shutdown(ctx context.Context) error

Functions

func LogHost

func LogHost() string

LogHost returns the hostname only (without port) of the configured logtail server, or the default.

Deprecated: Use LogURL instead.

func LogURL

func LogURL() string

LogURL is the base URL for the configured logtail server, or the default. It is guaranteed to not terminate with any forward slashes.

func NewLogtailTransport

func NewLogtailTransport(host string) *http.Transport

NewLogtailTransport returns an HTTP Transport particularly suited to uploading logs to the given host name. This includes:

• If DNS lookup fails, consult the bootstrap DNS list of Tailscale hostnames.
• If TLS connection fails, try again using LetsEncrypt's built-in root certificate, for the benefit of older OS platforms which might not include it.

Types

type Config

type Config struct {
	Collection string
	PrivateID  logtail.PrivateID
	PublicID   logtail.PublicID
}

Config represents an instance of logs in a collection.

func ConfigFromBytes

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

ConfigFromBytes parses a Config from its JSON encoding.

func ConfigFromFile

func ConfigFromFile(statefile string) (*Config, error)

ConfigFromFile reads a Config from a JSON file.

func NewConfig

func NewConfig(collection string) *Config

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

func (*Config) Save

func (c *Config) Save(stateFile string) 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

func (c *Config) Validate(collection string) error

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

type Policy

type Policy struct {
	// Logtail is the logger.
	Logtail *logtail.Logger
	// PublicID is the logger's instance identifier.
	PublicID logtail.PublicID
}

Policy is a logger and its public ID.

func New

func New(collection string) *Policy

New returns a new log policy (a logger and its instance ID) for a given collection name.

func NewWithConfigPath

func NewWithConfigPath(collection, dir, cmdName string) *Policy

NewWithConfigPath is identical to New, but uses the specified directory and command name. If either is empty, it derives them automatically.

func (*Policy) Close

func (p *Policy) Close()

Close immediately shuts down the logger.

func (*Policy) SetVerbosityLevel

func (p *Policy) SetVerbosityLevel(level int)

SetVerbosityLevel controls the verbosity level that should be written to stderr. 0 is the default (not verbose). Levels 1 or higher are increasingly verbose.

It should not be changed concurrently with log writes.

func (*Policy) Shutdown

func (p *Policy) Shutdown(ctx context.Context) error

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