internal

Documentation

Index

• Constants
• Variables
• func AlignDuration(tm time.Time, interval time.Duration) time.Duration
• func AlignTime(tm time.Time, interval time.Duration) time.Time
• func AuthHandler(username, password, realm string, onError BasicAuthErrorFunc) func(h http.Handler) http.Handler
• func CombinedOutputTimeout(c *exec.Cmd, timeout time.Duration) ([]byte, error)
• func CompressWithGzip(data io.Reader) io.ReadCloser
• func ExitStatus(err error) (int, bool)
• func FormatFullVersion() string
• func GenericAuthHandler(credentials string, onError GenericAuthErrorFunc) func(h http.Handler) http.Handler
• func IPRangeHandler(networks []*net.IPNet, onError ErrorFunc) func(h http.Handler) http.Handler
• func NewGzipReader(r io.Reader) (io.Reader, error)
• func NewStreamContentDecoder(encoding string, r io.Reader) (io.Reader, error)
• func OnClientError(client *http.Client, err error)
• func ParseTimestamp(format string, timestamp interface{}, location *time.Location, ...) (time.Time, error)
• func ProductToken() string
• func RandomDuration(max time.Duration) time.Duration
• func RandomSleep(max time.Duration, shutdown chan struct{})
• func RandomString(n int) (string, error)
• func ReadLines(filename string) ([]string, error)
• func RunTimeout(c *exec.Cmd, timeout time.Duration) error
• func SleepContext(ctx context.Context, duration time.Duration) error
• func SnakeCase(in string) string
• func StdOutputTimeout(c *exec.Cmd, timeout time.Duration) ([]byte, error)
• func ToBool(value interface{}) (bool, error)
• func ToFloat64(value interface{}) (float64, error)
• func ToInt64(value interface{}) (int64, error)
• func ToString(value interface{}) (string, error)
• func ToUint64(value interface{}) (uint64, error)
• func WaitTimeout(c *exec.Cmd, timeout time.Duration) error
• type AutoDecoder
  • func NewAutoContentDecoder() *AutoDecoder
  • func (a *AutoDecoder) Decode(data []byte, maxDecompressionSize int64) ([]byte, error)
  • func (a *AutoDecoder) SetEncoding(encoding string)
• type BasicAuthErrorFunc
• type ContentDecoder
  • func NewContentDecoder(encoding string) (ContentDecoder, error)
• type ContentEncoder
  • func NewContentEncoder(encoding string) (ContentEncoder, error)
• type ErrorFunc
• type GenericAuthErrorFunc
• type GzipDecoder
  • func NewGzipDecoder() *GzipDecoder
  • func (d *GzipDecoder) Decode(data []byte, maxDecompressionSize int64) ([]byte, error)
  • func (*GzipDecoder) SetEncoding(string)
• type GzipEncoder
  • func NewGzipEncoder() *GzipEncoder
  • func (e *GzipEncoder) Encode(data []byte) ([]byte, error)
• type GzipReader
  • func (r *GzipReader) Read(b []byte) (int, error)
• type IdentityDecoder
  • func NewIdentityDecoder() *IdentityDecoder
  • func (*IdentityDecoder) Decode(data []byte, maxDecompressionSize int64) ([]byte, error)
  • func (*IdentityDecoder) SetEncoding(string)
• type IdentityEncoder
  • func NewIdentityEncoder() *IdentityEncoder
  • func (*IdentityEncoder) Encode(data []byte) ([]byte, error)
• type ReadWaitCloser
  • func (r *ReadWaitCloser) Close() error
• type ZlibDecoder
  • func NewZlibDecoder() *ZlibDecoder
  • func (d *ZlibDecoder) Decode(data []byte, maxDecompressionSize int64) ([]byte, error)
  • func (*ZlibDecoder) SetEncoding(string)
• type ZlibEncoder
  • func NewZlibEncoder() *ZlibEncoder
  • func (e *ZlibEncoder) Encode(data []byte) ([]byte, error)

Constants

const Customized = ""

const DefaultMaxDecompressionSize = 500 * 1024 * 1024 //500MB

const KillGrace = 5 * time.Second

KillGrace is the amount of time we allow a process to shutdown before sending a SIGKILL.

Variables

var (
	ErrTimeout        = errors.New("command timed out")
	ErrNotImplemented = errors.New("not implemented yet")
)

var (
	Version = "unknown"
	Branch  = ""
	Commit  = ""
)

Set via LDFLAGS -X

var HostEndianess = binary.LittleEndian

Functions

func AlignDuration

func AlignDuration(tm time.Time, interval time.Duration) time.Duration

AlignDuration returns the duration until next aligned interval. If the current time is aligned a 0 duration is returned.

func AlignTime

func AlignTime(tm time.Time, interval time.Duration) time.Time

AlignTime returns the time of the next aligned interval. If the current time is aligned the current time is returned.

func AuthHandler

func AuthHandler(username, password, realm string, onError BasicAuthErrorFunc) func(h http.Handler) http.Handler

AuthHandler returns a http handler that requires HTTP basic auth credentials to match the given username and password.

func CombinedOutputTimeout

func CombinedOutputTimeout(c *exec.Cmd, timeout time.Duration) ([]byte, error)

CombinedOutputTimeout runs the given command with the given timeout and returns the combined output of stdout and stderr. If the command times out, it attempts to kill the process.

func CompressWithGzip

func CompressWithGzip(data io.Reader) io.ReadCloser

CompressWithGzip takes an io.Reader as input and pipes it through a gzip.Writer returning an io.Reader containing the gzipped data. Errors occurring during compression are returned to the instance reading from the returned reader via through the corresponding read call (e.g. io.Copy or io.ReadAll).

func ExitStatus

func ExitStatus(err error) (int, bool)

ExitStatus takes the error from exec.Command and returns the exit status and true if error is not exit status, will return 0 and false

func FormatFullVersion

func FormatFullVersion() string

func GenericAuthHandler

func GenericAuthHandler(credentials string, onError GenericAuthErrorFunc) func(h http.Handler) http.Handler

GenericAuthHandler returns a http handler that requires `Authorization: <credentials>`

func IPRangeHandler

func IPRangeHandler(networks []*net.IPNet, onError ErrorFunc) func(h http.Handler) http.Handler

IPRangeHandler returns a http handler that requires the remote address to be in the specified network.

func NewGzipReader

func NewGzipReader(r io.Reader) (io.Reader, error)

func NewStreamContentDecoder

func NewStreamContentDecoder(encoding string, r io.Reader) (io.Reader, error)

NewStreamContentDecoder returns a reader that will decode the stream according to the encoding type.

func OnClientError

func OnClientError(client *http.Client, err error)

func ParseTimestamp

func ParseTimestamp(format string, timestamp interface{}, location *time.Location, separator ...string) (time.Time, error)

ParseTimestamp parses a Time according to the standard Telegraf options. These are generally displayed in the toml similar to:

json_time_key= "timestamp"
json_time_format = "2006-01-02T15:04:05Z07:00"
json_timezone = "America/Los_Angeles"

The format can be one of "unix", "unix_ms", "unix_us", "unix_ns", or a Go time layout suitable for time.Parse.

When using the "unix" format, an optional fractional component is allowed. Specific unix time precisions cannot have a fractional component.

Unix times may be an int64, float64, or string. When using a Go format string the timestamp must be a string.

The location is a location string suitable for time.LoadLocation. Unix times do not use the location string, a unix time is always return in the UTC location.

func ProductToken

func ProductToken() string

ProductToken returns a tag for Telegraf that can be used in user agents.

func RandomDuration

func RandomDuration(max time.Duration) time.Duration

RandomDuration returns a random duration between 0 and max.

func RandomSleep

func RandomSleep(max time.Duration, shutdown chan struct{})

RandomSleep will sleep for a random amount of time up to max. If the shutdown channel is closed, it will return before it has finished sleeping.

func RandomString

func RandomString(n int) (string, error)

RandomString returns a random string of alphanumeric characters

func ReadLines

func ReadLines(filename string) ([]string, error)

ReadLines reads contents from a file and splits them by new lines.

func RunTimeout

func RunTimeout(c *exec.Cmd, timeout time.Duration) error

RunTimeout runs the given command with the given timeout. If the command times out, it attempts to kill the process.

func SleepContext

func SleepContext(ctx context.Context, duration time.Duration) error

SleepContext sleeps until the context is closed or the duration is reached.

func SnakeCase

func SnakeCase(in string) string

SnakeCase converts the given string to snake case following the Golang format: acronyms are converted to lower-case and preceded by an underscore.

func StdOutputTimeout

func StdOutputTimeout(c *exec.Cmd, timeout time.Duration) ([]byte, error)

StdOutputTimeout runs the given command with the given timeout and returns the output of stdout. If the command times out, it attempts to kill the process.

func ToBool

func ToBool(value interface{}) (bool, error)

func ToFloat64

func ToFloat64(value interface{}) (float64, error)

func ToInt64

func ToInt64(value interface{}) (int64, error)

func ToString

func ToString(value interface{}) (string, error)

func ToUint64

func ToUint64(value interface{}) (uint64, error)

func WaitTimeout

func WaitTimeout(c *exec.Cmd, timeout time.Duration) error

WaitTimeout waits for the given command to finish with a timeout. It assumes the command has already been started. If the command times out, it attempts to kill the process.

Types

type AutoDecoder

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

func NewAutoContentDecoder

func NewAutoContentDecoder() *AutoDecoder

func (*AutoDecoder) Decode

func (a *AutoDecoder) Decode(data []byte, maxDecompressionSize int64) ([]byte, error)

func (*AutoDecoder) SetEncoding

func (a *AutoDecoder) SetEncoding(encoding string)

type BasicAuthErrorFunc

type BasicAuthErrorFunc func(rw http.ResponseWriter)

type ContentDecoder

type ContentDecoder interface {
	SetEncoding(string)
	Decode([]byte, int64) ([]byte, error)
}

ContentDecoder removes a wrapper encoding from byte buffers.

func NewContentDecoder

func NewContentDecoder(encoding string) (ContentDecoder, error)

NewContentDecoder returns a ContentDecoder for the encoding type.

type ContentEncoder

type ContentEncoder interface {
	Encode([]byte) ([]byte, error)
}

ContentEncoder applies a wrapper encoding to byte buffers.

func NewContentEncoder

func NewContentEncoder(encoding string) (ContentEncoder, error)

NewContentEncoder returns a ContentEncoder for the encoding type.

type ErrorFunc

type ErrorFunc func(rw http.ResponseWriter, code int)

ErrorFunc is a callback for writing an error response.

type GenericAuthErrorFunc

type GenericAuthErrorFunc func(rw http.ResponseWriter)

type GzipDecoder

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

GzipDecoder decompresses buffers with gzip compression.

func NewGzipDecoder

func NewGzipDecoder() *GzipDecoder

func (*GzipDecoder) Decode

func (d *GzipDecoder) Decode(data []byte, maxDecompressionSize int64) ([]byte, error)

func (*GzipDecoder) SetEncoding

func (*GzipDecoder) SetEncoding(string)

type GzipEncoder

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

GzipEncoder compresses the buffer using gzip at the default level.

func NewGzipEncoder

func NewGzipEncoder() *GzipEncoder

func (*GzipEncoder) Encode

func (e *GzipEncoder) Encode(data []byte) ([]byte, error)

type GzipReader

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

GzipReader is similar to gzip.Reader but reads only a single gzip stream per read.

func (*GzipReader) Read

func (r *GzipReader) Read(b []byte) (int, error)

type IdentityDecoder

type IdentityDecoder struct{}

IdentityDecoder is a null decoder that returns the input.

func NewIdentityDecoder

func NewIdentityDecoder() *IdentityDecoder

func (*IdentityDecoder) Decode

func (*IdentityDecoder) Decode(data []byte, maxDecompressionSize int64) ([]byte, error)

func (*IdentityDecoder) SetEncoding

func (*IdentityDecoder) SetEncoding(string)

type IdentityEncoder

type IdentityEncoder struct{}

IdentityEncoder is a null encoder that applies no transformation.

func NewIdentityEncoder

func NewIdentityEncoder() *IdentityEncoder

func (*IdentityEncoder) Encode

func (*IdentityEncoder) Encode(data []byte) ([]byte, error)

type ReadWaitCloser

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

func (*ReadWaitCloser) Close

func (r *ReadWaitCloser) Close() error

type ZlibDecoder

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

func NewZlibDecoder

func NewZlibDecoder() *ZlibDecoder

func (*ZlibDecoder) Decode

func (d *ZlibDecoder) Decode(data []byte, maxDecompressionSize int64) ([]byte, error)

func (*ZlibDecoder) SetEncoding

func (*ZlibDecoder) SetEncoding(string)

type ZlibEncoder

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

func NewZlibEncoder

func NewZlibEncoder() *ZlibEncoder

func (*ZlibEncoder) Encode

func (e *ZlibEncoder) Encode(data []byte) ([]byte, error)