Documentation
¶
Index ¶
- func EnvHasConsulConfig() bool
- func NewClient(cfg *api.Config) (*api.Client, error)
- func NewConfig(cfg *api.Config) (*api.Config, error)
- func SpawnLock(ctx context.Context, cfg *LockConfig) (*lock, error)
- type HCLogAdapter
- func (a *HCLogAdapter) CreateEntry(args []interface{}) *logrus.Entry
- func (a *HCLogAdapter) Debug(msg string, args ...interface{})
- func (a *HCLogAdapter) Error(msg string, args ...interface{})
- func (a *HCLogAdapter) GetLevel() hclog.Level
- func (a *HCLogAdapter) ImpliedArgs() []interface{}
- func (a *HCLogAdapter) Info(msg string, args ...interface{})
- func (a *HCLogAdapter) IsDebug() bool
- func (a *HCLogAdapter) IsError() bool
- func (a *HCLogAdapter) IsInfo() bool
- func (a *HCLogAdapter) IsTrace() bool
- func (a *HCLogAdapter) IsWarn() bool
- func (a *HCLogAdapter) Log(level hclog.Level, msg string, args ...interface{})
- func (a *HCLogAdapter) Name() string
- func (a *HCLogAdapter) Named(name string) hclog.Logger
- func (a *HCLogAdapter) ResetNamed(name string) hclog.Logger
- func (a *HCLogAdapter) SetLevel(hclog.Level)
- func (a *HCLogAdapter) StandardLogger(opts *hclog.StandardLoggerOptions) *log.Logger
- func (a *HCLogAdapter) StandardWriter(opts *hclog.StandardLoggerOptions) io.Writer
- func (*HCLogAdapter) Trace(_ string, _ ...interface{})
- func (a *HCLogAdapter) Warn(msg string, args ...interface{})
- func (a *HCLogAdapter) With(args ...interface{}) hclog.Logger
- type Lock
- type LockConfig
- type Mock
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EnvHasConsulConfig ¶
func EnvHasConsulConfig() bool
EnvHasConsulConfig returns true if there are items in the local environment that have the prefix `CONSUL_`
func NewClient ¶
NewClient creates a new consul api.Client with the specified config, call NewConfig to complete the configuration by reading the local environment `CONSUL_` variables.
If no environment variables are set, and the passed cfg is nil, returns a client connected to 127.0.0.1:8500
func NewConfig ¶
NewConfig creates a new api.Config using environment variables. If an existing config is passed, it will fill in missing configuration using environment variables or defaults if they exists on the local system.
The config mirrors the same environment variables used by the consul CLI as documented here https://www.consul.io/commands
If no environment variables are set, and the passed cfg is nil, returns a default config pointing to 127.0.0.1:8500
Types ¶
type HCLogAdapter ¶
type HCLogAdapter struct {
// contains filtered or unexported fields
}
HCLogAdapter implements the hclog interface, and wraps it around a Logrus entry
func NewHCLogAdapter ¶
func NewHCLogAdapter(logger logrus.FieldLogger, name string) *HCLogAdapter
func (*HCLogAdapter) CreateEntry ¶
func (a *HCLogAdapter) CreateEntry(args []interface{}) *logrus.Entry
func (*HCLogAdapter) Debug ¶
func (a *HCLogAdapter) Debug(msg string, args ...interface{})
func (*HCLogAdapter) Error ¶
func (a *HCLogAdapter) Error(msg string, args ...interface{})
func (*HCLogAdapter) GetLevel ¶ added in v4.15.1
func (a *HCLogAdapter) GetLevel() hclog.Level
func (*HCLogAdapter) ImpliedArgs ¶
func (a *HCLogAdapter) ImpliedArgs() []interface{}
ImpliedArgs returns With key/value pairs
func (*HCLogAdapter) Info ¶
func (a *HCLogAdapter) Info(msg string, args ...interface{})
func (*HCLogAdapter) IsDebug ¶
func (a *HCLogAdapter) IsDebug() bool
func (*HCLogAdapter) IsError ¶
func (a *HCLogAdapter) IsError() bool
func (*HCLogAdapter) IsInfo ¶
func (a *HCLogAdapter) IsInfo() bool
func (*HCLogAdapter) IsTrace ¶
func (a *HCLogAdapter) IsTrace() bool
func (*HCLogAdapter) IsWarn ¶
func (a *HCLogAdapter) IsWarn() bool
func (*HCLogAdapter) Log ¶
func (a *HCLogAdapter) Log(level hclog.Level, msg string, args ...interface{})
func (*HCLogAdapter) Name ¶
func (a *HCLogAdapter) Name() string
func (*HCLogAdapter) Named ¶
func (a *HCLogAdapter) Named(name string) hclog.Logger
func (*HCLogAdapter) ResetNamed ¶
func (a *HCLogAdapter) ResetNamed(name string) hclog.Logger
func (*HCLogAdapter) SetLevel ¶
func (a *HCLogAdapter) SetLevel(hclog.Level)
func (*HCLogAdapter) StandardLogger ¶
func (a *HCLogAdapter) StandardLogger(opts *hclog.StandardLoggerOptions) *log.Logger
StandardLogger is meant to return a stdlib Logger type which wraps around hclog. It does this by providing an io.Writer and instantiating a new Logger. It then tries to interpret the log level by parsing the message.
Since we are not using `hclog` in a generic way, and I cannot find any calls to this method from go-plugin, we will poorly support this method. Rather than pull in all of hclog writer parsing logic, pass it a Logrus writer, and hardcode the level to INFO.
Apologies to those who find themselves here.
func (*HCLogAdapter) StandardWriter ¶
func (a *HCLogAdapter) StandardWriter(opts *hclog.StandardLoggerOptions) io.Writer
func (*HCLogAdapter) Trace ¶
func (*HCLogAdapter) Trace(_ string, _ ...interface{})
HCLog has one more level than we do. As such, we will never set trace level.
func (*HCLogAdapter) Warn ¶
func (a *HCLogAdapter) Warn(msg string, args ...interface{})
func (*HCLogAdapter) With ¶
func (a *HCLogAdapter) With(args ...interface{}) hclog.Logger
type Lock ¶
type Lock interface {
PutValue(ctx context.Context, b []byte) error
Unlock(b []byte)
HasLock() bool
}
Lock attempts to get a lock then continues to keep the lock until told to stop
Source Files