pkg/

directory
v1.41.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 15, 2022 License: Apache-2.0, Apache-2.0

Directories

Path Synopsis
Package app has the static app info
Package app has the static app info
Package async has helper utilities for running async code with proper tracing.
Package async has helper utilities for running async code with proper tracing.
Package box implements the definitions of a box configuration file and tools to access it.
Package box implements the definitions of a box configuration file and tools to access it.
package caller provides info on the caller
package caller provides info on the caller
Package cfg manages config for outreach go services Every go app or package that needs config should define a strongly typed struct for it Example type HoneycombConfig struct { Disable bool `yaml:"Disable"` Dataset string `yaml:"Dataset"` APIHost string `yaml:"APIHost"` SampleRate float64 `yaml:"SampleRate"` Key cfg.Secret `yaml:"Key"` } func (x someComponent) someFunc(ctx context.Context) error { var hcConfig HoneycombConfig if err := cfg.Load("honeycomb.yaml", &hcConfig); err != nil { return err } ...
Package cfg manages config for outreach go services Every go app or package that needs config should define a strongly typed struct for it Example type HoneycombConfig struct { Disable bool `yaml:"Disable"` Dataset string `yaml:"Dataset"` APIHost string `yaml:"APIHost"` SampleRate float64 `yaml:"SampleRate"` Key cfg.Secret `yaml:"Key"` } func (x someComponent) someFunc(ctx context.Context) error { var hcConfig HoneycombConfig if err := cfg.Load("honeycomb.yaml", &hcConfig); err != nil { return err } ...
Package cleanup provides helpers to make it easy to do cleanups.
Package cleanup provides helpers to make it easy to do cleanups.
cli
Description: This file contains cli functions used in bootstrap and eventually in stencil.
Description: This file contains cli functions used in bootstrap and eventually in stencil.
aws
Package aws contains helpers for working with AWS in CLIs
Package aws contains helpers for working with AWS in CLIs
github
Description: Implements consistent ways to get Auth across platforms.
Description: Implements consistent ways to get Auth across platforms.
codec contains encoding/decoding utilities.
codec contains encoding/decoding utilities.
Package differs contains custom diffing test utilities See the example for how to use them
Package differs contains custom diffing test utilities See the example for how to use them
env provides environment specific overrides All the functions provided by this package are meant to be called at app initialization and will effectively not do anything at all in production.
env provides environment specific overrides All the functions provided by this package are meant to be called at app initialization and will effectively not do anything at all in production.
Package events defines the standard logging event structures This is based on https://docs.google.com/document/d/1V1py1iXX9B9NAb30veHYNGOuymZ9o_C2pYSU9E6qmsg/edit# and https://outreach-io.atlassian.net/wiki/spaces/EN/pages/691405109/Logging+Standards
Package events defines the standard logging event structures This is based on https://docs.google.com/document/d/1V1py1iXX9B9NAb30veHYNGOuymZ9o_C2pYSU9E6qmsg/edit# and https://outreach-io.atlassian.net/wiki/spaces/EN/pages/691405109/Logging+Standards
Package exec implements os/exec stdlib helpers
Package exec implements os/exec stdlib helpers
log
Package log implements standard go logging For logging: log.Info(ctx, "message", log.F{field: 42}) log.Error(...) log.Debug(...) log.Fatal(...) By default, log.Debug is not emitted but instead it is cached.
Package log implements standard go logging For logging: log.Info(ctx, "message", log.F{field: 42}) log.Error(...) log.Debug(...) log.Fatal(...) By default, log.Debug is not emitted but instead it is cached.
adapters
Description: This file integrates the logger with go-logr/logr
Description: This file integrates the logger with go-logr/logr
logtest
logtest provides the ability to test logs Usage: func MyTestFunc(t *testing.T) { logs := logTest.NewLogRecorder(t) defer logs.Close() .....
logtest provides the ability to test logs Usage: func MyTestFunc(t *testing.T) { logs := logTest.NewLogRecorder(t) defer logs.Close() .....
Package metrics implements the outreach metrics API This consists of the Count and Latency functions
Package metrics implements the outreach metrics API This consists of the Count and Latency functions
ometrics module
Package orerr implements outreach specific error utilities.
Package orerr implements outreach specific error utilities.
Package orio implements IO utilities.
Package orio implements IO utilities.
Description: This file contains the read through cache implementation for this package.
Description: This file contains the read through cache implementation for this package.
Package secrets manages secrets config for outreach applications All secrets are assumed to be stored securely in the filesystem.
Package secrets manages secrets config for outreach applications All secrets are assumed to be stored securely in the filesystem.
Package shuffler primarily provides the Suite struct that functions as a test runner and randomizer when embedded in your test struct.
Package shuffler primarily provides the Suite struct that functions as a test runner and randomizer when embedded in your test struct.
Package sshconfig implements a small ssh config parser based on the output of `ssh -G`.
Package sshconfig implements a small ssh config parser based on the output of `ssh -G`.
Package sshhelper is a toolkit for common ssh-related operations.
Package sshhelper is a toolkit for common ssh-related operations.
Package telefork contains basic telefork client and exposes tracing presend handler.
Package telefork contains basic telefork client and exposes tracing presend handler.
Package tester implements a test runner compatible with testing.T Usage: t := tester.New() tester.Run(t, "testA", func(t *tester.T) { ...
Package tester implements a test runner compatible with testing.T Usage: t := tester.New() tester.Run(t, "testA", func(t *tester.T) { ...
Package trace wraps standard tracing for outreach.
Package trace wraps standard tracing for outreach.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL