log

Documentation

Overview

Package log provides utilities to collect logs.

Index

• type Collector
  • func StartCollector(ctx context.Context, host *ssh.Conn, p string, tailFollowNameSupported bool) (*Collector, error)
  • func (c *Collector) Close() error
  • func (c *Collector) Dump(w io.Writer) error

Types

type Collector

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

Collector watches a file on remote host and collects the appended contents.

func StartCollector

func StartCollector(ctx context.Context, host *ssh.Conn, p string, tailFollowNameSupported bool) (*Collector, error)

StartCollector spawns a log collector on file p on host.

Set tailFollowNameSupported to true if the host's tail implementation supports the "--follow=name" command to allow for tail following to stay at the same filename rather than follow the file if the name changes.

func (*Collector) Close

func (c *Collector) Close() error

Close stops the collector.

func (*Collector) Dump

func (c *Collector) Dump(w io.Writer) error

Dump copies the contents collected to w and resets the buffer.