process

Documentation

Index

• Constants
• Variables
• func Bind(cmd *cobra.Command, config interface{}, opts ...cfgstruct.BindOpt)
• func Ctx(cmd *cobra.Command) (context.Context, context.CancelFunc)
• func Exec(cmd *cobra.Command)
• func ExecCustomDebug(cmd *cobra.Command)
• func ExecWithCustomConfig(cmd *cobra.Command, debugEnabled bool, ...)
• func InitMetrics(ctx context.Context, log *zap.Logger, r *monkit.Registry, instanceID string) (err error)
• func InitMetricsWithCertPath(ctx context.Context, log *zap.Logger, r *monkit.Registry, certPath string) error
• func InitMetricsWithHostname(ctx context.Context, log *zap.Logger, r *monkit.Registry) error
• func LoadConfig(cmd *cobra.Command, vip *viper.Viper) error
• func NewLogger() (*zap.Logger, error)
• func NewLoggerWithOutputPaths(outputPaths ...string) (*zap.Logger, error)
• func SaveConfig(cmd *cobra.Command, outfile string, opts ...SaveConfigOption) error
• func Viper(cmd *cobra.Command) (*viper.Viper, error)
• func ViperWithCustomConfig(cmd *cobra.Command, ...) (*viper.Viper, error)
• type SaveConfigOption
  • func SaveConfigRemovingDeprecated() SaveConfigOption
  • func SaveConfigWithOverride(name string, value interface{}) SaveConfigOption
  • func SaveConfigWithOverrides(overrides map[string]interface{}) SaveConfigOption
• type SaveConfigOptions

Constants

const DefaultCfgFilename = "config.yaml"

DefaultCfgFilename is the default filename used for storing a configuration.

Variables

var (
	// DebugAddrFlag for --debug.addr
	DebugAddrFlag = flag.String("debug.addr", "127.0.0.1:0", "address to listen on for debug endpoints")
)

var (
	// Error is a process error class
	Error = errs.Class("process error")
)

Functions

func Bind

func Bind(cmd *cobra.Command, config interface{}, opts ...cfgstruct.BindOpt)

Bind sets flags on a command that match the configuration struct 'config'. It ensures that the config has all of the values loaded into it when the command runs.

func Ctx

func Ctx(cmd *cobra.Command) (context.Context, context.CancelFunc)

Ctx returns the appropriate context.Context for ExecuteWithConfig commands

func Exec

func Exec(cmd *cobra.Command)

Exec runs a Cobra command. If a "config-dir" flag is defined it will be parsed and loaded using viper.

func ExecCustomDebug

func ExecCustomDebug(cmd *cobra.Command)

ExecCustomDebug runs default configuration except the default debug is disabled.

func ExecWithCustomConfig

func ExecWithCustomConfig(cmd *cobra.Command, debugEnabled bool, loadConfig func(cmd *cobra.Command, vip *viper.Viper) error)

ExecWithCustomConfig runs a Cobra command. Custom configuration can be loaded.

func InitMetrics

func InitMetrics(ctx context.Context, log *zap.Logger, r *monkit.Registry, instanceID string) (err error)

InitMetrics initializes telemetry reporting. Makes a telemetry.Client and calls its Run() method in a goroutine.

func InitMetricsWithCertPath

func InitMetricsWithCertPath(ctx context.Context, log *zap.Logger, r *monkit.Registry, certPath string) error

InitMetricsWithCertPath initializes telemetry reporting, using the node ID corresponding to the given certificate as the telemetry instance ID.

func InitMetricsWithHostname

func InitMetricsWithHostname(ctx context.Context, log *zap.Logger, r *monkit.Registry) error

InitMetricsWithHostname initializes telemetry reporting, using the hostname as the telemetry instance ID.

func LoadConfig

func LoadConfig(cmd *cobra.Command, vip *viper.Viper) error

LoadConfig loads configuration into *viper.Viper from file specified with "config-dir" flag.

func NewLogger

func NewLogger() (*zap.Logger, error)

NewLogger creates new logger configured by the process flags.

func NewLoggerWithOutputPaths

func NewLoggerWithOutputPaths(outputPaths ...string) (*zap.Logger, error)

NewLoggerWithOutputPaths is the same as NewLogger, but overrides the log output paths.

func SaveConfig

func SaveConfig(cmd *cobra.Command, outfile string, opts ...SaveConfigOption) error

SaveConfig will save only the user-specific flags with default values to outfile with specific values specified in 'overrides' overridden.

func Viper

func Viper(cmd *cobra.Command) (*viper.Viper, error)

Viper returns the appropriate *viper.Viper for the command, creating if necessary.

func ViperWithCustomConfig

func ViperWithCustomConfig(cmd *cobra.Command, loadConfig func(cmd *cobra.Command, vip *viper.Viper) error) (*viper.Viper, error)

ViperWithCustomConfig returns the appropriate *viper.Viper for the command, creating if necessary. Custom config load logic can be defined with "loadConfig" parameter.

Types

type SaveConfigOption

type SaveConfigOption func(*SaveConfigOptions)

SaveConfigOption is a function that updates the options for SaveConfig.

func SaveConfigRemovingDeprecated

func SaveConfigRemovingDeprecated() SaveConfigOption

SaveConfigRemovingDeprecated tells SaveConfig to not store deprecated flags.

func SaveConfigWithOverride

func SaveConfigWithOverride(name string, value interface{}) SaveConfigOption

SaveConfigWithOverride adds a single override to SaveConfig.

func SaveConfigWithOverrides

func SaveConfigWithOverrides(overrides map[string]interface{}) SaveConfigOption

SaveConfigWithOverrides sets the overrides to the provided map.

type SaveConfigOptions

type SaveConfigOptions struct {
	Overrides        map[string]interface{}
	RemoveDeprecated bool
}

SaveConfigOptions controls the behavior of SaveConfig.