canary

Documentation

Index

• Constants
• type BatchParams
• type Config
• type Runnable
• type RuntimeContext

Constants

const (
	// ConfigurationKey is the config YAML key for the canary module
	ConfigurationKey = "canary"
)

Types

type BatchParams

type BatchParams struct {
	DomainName string
	Query      string
	Reason     string
	BatchType  string
}

BatchParams is from server repo TODO: to get rid of it:

after batch job has an API, we should use the API: https://github.com/uber/cadence/issues/2225

type Config

type Config struct {
	Domains  []string `yaml:"domains"`
	Excludes []string `yaml:"excludes"`
}

Config contains the configurable yaml properties for the canary runtime

type Runnable

type Runnable interface {
	Run() error
}

Runnable is an interface for anything that exposes a Run method

type RuntimeContext

type RuntimeContext struct {
	Env string
	// contains filtered or unexported fields
}

RuntimeContext contains all the context information needed to run the canary