contextutils

Documentation

Overview

Contains common flyte context utils.

Index

• func GetLogFields(ctx context.Context) map[string]interface{}
• func Value(ctx context.Context, key Key) string
• func Values(ctx context.Context, keys ...Key) map[string]string
• func WithAppName(ctx context.Context, appName string) context.Context
• func WithExecutionID(ctx context.Context, execID string) context.Context
• func WithGoroutineLabel(ctx context.Context, routineLabel string) context.Context
• func WithJobID(ctx context.Context, jobID string) context.Context
• func WithLaunchPlanID(ctx context.Context, launchPlan string) context.Context
• func WithNamespace(ctx context.Context, namespace string) context.Context
• func WithNodeID(ctx context.Context, nodeID string) context.Context
• func WithPhase(ctx context.Context, phase string) context.Context
• func WithProjectDomain(ctx context.Context, project, domain string) context.Context
• func WithTaskID(ctx context.Context, taskID string) context.Context
• func WithTaskType(ctx context.Context, taskType string) context.Context
• func WithWorkflowID(ctx context.Context, workflow string) context.Context
• type Key
  • func (k Key) String() string

Functions

func GetLogFields

func GetLogFields(ctx context.Context) map[string]interface{}

Gets a map of all known logKeys set on the context. logKeys are special and should be used incase, context fields are to be added to the log lines.

func Value

func Value(ctx context.Context, key Key) string

func Values

func Values(ctx context.Context, keys ...Key) map[string]string

func WithAppName

func WithAppName(ctx context.Context, appName string) context.Context

Gets a new context with AppName set.

func WithExecutionID

func WithExecutionID(ctx context.Context, execID string) context.Context

Gets a new context with ExecutionID set.

func WithGoroutineLabel

func WithGoroutineLabel(ctx context.Context, routineLabel string) context.Context

Gets a new context with Go Routine label key set and a label assigned to the context using pprof.Labels. You can then call pprof.SetGoroutineLabels(ctx) to annotate the current go-routine and have that show up in pprof analysis.

func WithJobID

func WithJobID(ctx context.Context, jobID string) context.Context

Gets a new context with JobId set. If the existing context already has a job id, the new context will have <old_jobID>/<new_jobID> set as the job id.

func WithLaunchPlanID

func WithLaunchPlanID(ctx context.Context, launchPlan string) context.Context

Gets a new context with a launch plan ID set.

func WithNamespace

func WithNamespace(ctx context.Context, namespace string) context.Context

Gets a new context with namespace set.

func WithNodeID

func WithNodeID(ctx context.Context, nodeID string) context.Context

Gets a new context with NodeID (nested) set.

func WithPhase

func WithPhase(ctx context.Context, phase string) context.Context

Gets a new context with Phase set.

func WithProjectDomain

func WithProjectDomain(ctx context.Context, project, domain string) context.Context

Get new context with Project and Domain values set

func WithTaskID

func WithTaskID(ctx context.Context, taskID string) context.Context

Gets a new context with WorkflowName set.

func WithTaskType

func WithTaskType(ctx context.Context, taskType string) context.Context

Gets a new context with TaskType set.

func WithWorkflowID

func WithWorkflowID(ctx context.Context, workflow string) context.Context

Gets a new context with WorkflowName set.

Types

type Key

type Key string

const (
	AppNameKey      Key = "app_name"
	NamespaceKey    Key = "ns"
	TaskTypeKey     Key = "tasktype"
	ProjectKey      Key = "project"
	DomainKey       Key = "domain"
	WorkflowIDKey   Key = "wf"
	NodeIDKey       Key = "node"
	TaskIDKey       Key = "task"
	ExecIDKey       Key = "exec_id"
	JobIDKey        Key = "job_id"
	PhaseKey        Key = "phase"
	RoutineLabelKey Key = "routine"
	LaunchPlanIDKey Key = "lp"
)

func (Key) String

func (k Key) String() string