temporal

Documentation

Index

• Variables
• func ClientProvider(params ProviderParameters) (client.Client, error)
• func ExtractLoggerMetadata(header *common.Header) (map[string]string, error)
• func InitializeTestWorkflowEnvironmentContextWithPrincipal(env *testsuite.TestWorkflowEnvironment, principal iam.ArmoryCloudPrincipal) error
• func NewLoggerContextPropagator() workflow.ContextPropagator
• func NewPrincipalContextPropagator() workflow.ContextPropagator
• func TrackFinishedActivity[T any](ctx workflow.Context, activityName string, ...) (T, error)
• func TrackFinishedWorkflow(ctx workflow.Context, workflowStatus string)
• func WithFields(ctx context.Context, fields ...LoggerField) context.Context
• func WithObservabilityParameters(ctx context.Context, entries ...string) context.Context
• func WithWorkflowFields(ctx workflow.Context, fields ...LoggerField) workflow.Context
• func WithWorkflowObservabilityParameters(ctx workflow.Context, entries ...string) workflow.Context
• type ActivityResult
  • func NewActivityErrorResult[T any](err error, attempts int, status string) ActivityResult[T]
  • func NewActivitySuccessResult[T any](result T, attempts int, status string) ActivityResult[T]
• type Configuration
• type LoggerField
• type ProviderParameters
• type WorkerProvider
  • func WorkerProviderProvider(tracingConfig opentelemetry.Configuration) WorkerProvider
  • func (w *WorkerProvider) NewWorker(c client.Client, taskQueue string) (worker.Worker, error)
  • func (w *WorkerProvider) NewWorkerWithOptions(c client.Client, taskQueue string, options *worker.Options) (worker.Worker, error)
• type ZapAdapter
  • func NewZapAdapter(zapLogger *zap.Logger) *ZapAdapter
  • func (log *ZapAdapter) Debug(msg string, keyvals ...interface{})
  • func (log *ZapAdapter) Error(msg string, keyvals ...interface{})
  • func (log *ZapAdapter) Info(msg string, keyvals ...interface{})
  • func (log *ZapAdapter) Warn(msg string, keyvals ...interface{})
  • func (log *ZapAdapter) With(keyvals ...interface{}) log.Logger

Variables

var Module = fx.Module(
	"temporal",
	fx.Provide(ClientProvider),
	fx.Provide(WorkerProviderProvider),
)

Functions

func ClientProvider

func ClientProvider(params ProviderParameters) (client.Client, error)

func ExtractLoggerMetadata

func ExtractLoggerMetadata(header *common.Header) (map[string]string, error)

func InitializeTestWorkflowEnvironmentContextWithPrincipal

func InitializeTestWorkflowEnvironmentContextWithPrincipal(env *testsuite.TestWorkflowEnvironment, principal iam.ArmoryCloudPrincipal) error

InitializeTestWorkflowEnvironmentContextWithPrincipal should only be used in tests.

func NewLoggerContextPropagator

func NewLoggerContextPropagator() workflow.ContextPropagator

func NewPrincipalContextPropagator

func NewPrincipalContextPropagator() workflow.ContextPropagator

func TrackFinishedActivity

func TrackFinishedActivity[T any](ctx workflow.Context, activityName string, activityRunner func() ActivityResult[T]) (T, error)

func TrackFinishedWorkflow

func TrackFinishedWorkflow(ctx workflow.Context, workflowStatus string)

func WithFields

func WithFields(ctx context.Context, fields ...LoggerField) context.Context

func WithObservabilityParameters

func WithObservabilityParameters(ctx context.Context, entries ...string) context.Context

func WithWorkflowFields

func WithWorkflowFields(ctx workflow.Context, fields ...LoggerField) workflow.Context

func WithWorkflowObservabilityParameters

func WithWorkflowObservabilityParameters(ctx workflow.Context, entries ...string) workflow.Context

Types

type ActivityResult

type ActivityResult[T any] struct {
	Result   T
	Err      error
	Attempts int
	Status   string
}

func NewActivityErrorResult

func NewActivityErrorResult[T any](err error, attempts int, status string) ActivityResult[T]

func NewActivitySuccessResult

func NewActivitySuccessResult[T any](result T, attempts int, status string) ActivityResult[T]

type Configuration

type Configuration struct {
	Namespace                   string
	Hostname                    string
	Port                        string
	CertPath                    string
	KeyPath                     string
	TemporalCloudEnabled        bool
	TemporalCloudAccountID      string
	ClientSideEncryptionEnabled bool
	ClientSideEncryptionCMKARNs string
}

type LoggerField

type LoggerField struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type ProviderParameters

type ProviderParameters struct {
	fx.In

	Logger         *zap.SugaredLogger
	Config         Configuration
	MetricsService metrics.MetricsSvc          `optional:"true"`
	Tracing        opentelemetry.Configuration `optional:"true"`
}

type WorkerProvider

type WorkerProvider struct {
	// contains filtered or unexported fields
}

func WorkerProviderProvider

func WorkerProviderProvider(tracingConfig opentelemetry.Configuration) WorkerProvider

func (*WorkerProvider) NewWorker

func (w *WorkerProvider) NewWorker(c client.Client, taskQueue string) (worker.Worker, error)

func (*WorkerProvider) NewWorkerWithOptions

func (w *WorkerProvider) NewWorkerWithOptions(c client.Client, taskQueue string, options *worker.Options) (worker.Worker, error)

type ZapAdapter

type ZapAdapter struct {
	// contains filtered or unexported fields
}

func NewZapAdapter

func NewZapAdapter(zapLogger *zap.Logger) *ZapAdapter

func (*ZapAdapter) Debug

func (log *ZapAdapter) Debug(msg string, keyvals ...interface{})

func (*ZapAdapter) Error

func (log *ZapAdapter) Error(msg string, keyvals ...interface{})

func (*ZapAdapter) Info

func (log *ZapAdapter) Info(msg string, keyvals ...interface{})

func (*ZapAdapter) Warn

func (log *ZapAdapter) Warn(msg string, keyvals ...interface{})

func (*ZapAdapter) With

func (log *ZapAdapter) With(keyvals ...interface{}) log.Logger