config

Documentation

Index

• Variables
• type ApiConfig
• type CadenceConfig
• type Config
  • func NewConfig(configPath string) (*Config, error)
  • func (c Config) GetApiServiceAddressWithDefault() string
  • func (c Config) GetSignalWithStartOnWithDefault() string
  • func (c Config) GetWaitForOnWithDefault() string
• type DumpWorkflowInternalActivityConfig
• type Interpreter
• type InterpreterActivityConfig
• type Logger
  • func (cfg *Logger) NewZapLogger() (*zap.Logger, error)
• type QueryWorkflowFailedRetryPolicy
  • func QueryWorkflowFailedRetryPolicyWithDefaults(retryPolicy *QueryWorkflowFailedRetryPolicy) QueryWorkflowFailedRetryPolicy
• type TemporalConfig
• type WaitForStateCompletionMigration

Variables

var DefaultWorkflowConfig = &iwfidl.WorkflowConfig{
	ContinueAsNewThreshold: iwfidl.PtrInt32(100),
}

Types

type ApiConfig

type ApiConfig struct {
	// Port is the port on which the API service will bind to
	Port           int   `yaml:"port"`
	MaxWaitSeconds int64 `yaml:"maxWaitSeconds"`
	// omitRpcInputOutputInHistory is the flag to omit rpc input/output in history
	// the input/output is only for debugging purpose but could be too expensive to store
	OmitRpcInputOutputInHistory *bool `yaml:"omitRpcInputOutputInHistory"`
	// WaitForStateCompletionMigration is used to control workflowId of the WaitForStateCompletion system/internal workflows
	WaitForStateCompletionMigration WaitForStateCompletionMigration `yaml:"waitForStateCompletionMigration"`
	QueryWorkflowFailedRetryPolicy  QueryWorkflowFailedRetryPolicy  `yaml:"queryWorkflowFailedRetryPolicy"`
}

type CadenceConfig

type CadenceConfig struct {
	// HostPort to connect to, default to 127.0.0.1:7833
	HostPort string `yaml:"hostPort"`
	// Domain to connect to, default to default
	Domain        string `yaml:"domain"`
	WorkerOptions *cadenceWorker.Options
}

type Config

type Config struct {
	// Log is the logging config
	Log Logger `yaml:"log"`
	// Api is the API config
	Api ApiConfig `yaml:"api"`
	// Interpreter is the service behind, either Cadence or Temporal is required
	Interpreter Interpreter `yaml:"interpreter"`
}

func NewConfig

func NewConfig(configPath string) (*Config, error)

NewConfig returns a new decoded Config struct

func (Config) GetApiServiceAddressWithDefault

func (c Config) GetApiServiceAddressWithDefault() string

func (Config) GetSignalWithStartOnWithDefault

func (c Config) GetSignalWithStartOnWithDefault() string

func (Config) GetWaitForOnWithDefault

func (c Config) GetWaitForOnWithDefault() string

type DumpWorkflowInternalActivityConfig

type DumpWorkflowInternalActivityConfig struct {
	StartToCloseTimeout time.Duration
	RetryPolicy         *iwfidl.RetryPolicy
}

type Interpreter

type Interpreter struct {
	// Temporal config is the config to connect to Temporal
	Temporal *TemporalConfig `yaml:"temporal"`
	// Cadence config is the config to connect to Cadence
	Cadence                   *CadenceConfig            `yaml:"cadence"`
	DefaultWorkflowConfig     *iwfidl.WorkflowConfig    `json:"defaultWorkflowConfig"`
	InterpreterActivityConfig InterpreterActivityConfig `yaml:"interpreterActivityConfig"`
	VerboseDebug              bool
	FailAtMemoIncompatibility bool
}

type InterpreterActivityConfig

type InterpreterActivityConfig struct {
	// ApiServiceAddress is the address that core engine workflow talks to API service
	// It's used in DumpWorkflowInternal activity for continueAsNew
	// default is http://localhost:ApiConfig.Port
	ApiServiceAddress                  string                              `json:"serviceAddress"`
	DumpWorkflowInternalActivityConfig *DumpWorkflowInternalActivityConfig `json:"dumpWorkflowInternalActivityConfig"`
	DefaultHeaders                     map[string]string                   `json:"defaultHeaders"`
}

type Logger

type Logger struct {
	// Stdout is true then the output needs to goto standard out
	// By default this is false and output will go to standard error
	Stdout bool `yaml:"stdout"`
	// Level is the desired log level
	Level string `yaml:"level"`
	// OutputFile is the path to the log output file
	// Stdout must be false, otherwise Stdout will take precedence
	OutputFile string `yaml:"outputFile"`
	// LevelKey is the desired log level, defaults to "level"
	LevelKey string `yaml:"levelKey"`
	// Encoding decides the format, supports "console" and "json".
	// "json" will print the log in JSON format(better for machine), while "console" will print in plain-text format(more human friendly)
	// Default is "json"
	Encoding string `yaml:"encoding"`
}

Logger contains the config items for logger

func (*Logger) NewZapLogger

func (cfg *Logger) NewZapLogger() (*zap.Logger, error)

NewZapLogger builds and returns a new Zap logger for this logging configuration

type QueryWorkflowFailedRetryPolicy

type QueryWorkflowFailedRetryPolicy struct {
	// defaults to 1
	InitialIntervalSeconds int `yaml:"initialIntervalSeconds"`
	// defaults to 5
	MaximumAttempts int `yaml:"maximumAttempts"`
}

func QueryWorkflowFailedRetryPolicyWithDefaults

func QueryWorkflowFailedRetryPolicyWithDefaults(retryPolicy *QueryWorkflowFailedRetryPolicy) QueryWorkflowFailedRetryPolicy

type TemporalConfig

type TemporalConfig struct {
	// HostPort to connect to, default to localhost:7233
	HostPort string `yaml:"hostPort"`
	// Namespace to connect to, default to default
	Namespace string `yaml:"namespace"`
	// Prometheus is configuring the metric exposer
	Prometheus    *prometheus.Configuration `yaml:"prometheus"`
	WorkerOptions *temporalWorker.Options
}

type WaitForStateCompletionMigration

type WaitForStateCompletionMigration struct {
	// expected values: old/both/new; defaults to 'old'
	SignalWithStartOn string `yaml:"signalWithStartOn"`
	// expected values: old/new; defaults to 'old'
	WaitForOn string `yaml:"waitForOn"`
}