util

Documentation

Index

• Constants
• Variables
• func AddGlobalGRPCDialOption(opt grpc.DialOption)
• func AddGlobalGRPCServerOption(opt grpc.ServerOption)
• func GetEndpointTLS(service string) (*grpc.ClientConn, error)
• func GrpcServerOptions(unaryInterceptor grpc.UnaryServerInterceptor, ...) []grpc.ServerOption
• func GrpcStart(server **grpc.Server, name, bind string, register func(srv *grpc.Server)) error
• func InitTelemetry(conf *Config, svcName, imName string) (func(), error)
• func MatchesRegex(s string) bool
• func MatchesVarRegex(s string) bool
• func SanitizeAsField(as string) string
• func Trace(ctx context.Context, msg string)
• func TraceHTTPRequest(ctx context.Context, r *http.Request) (cleanup func())
• func TransplantTelemetryContextInformation(a, b context.Context) context.Context
• type Config
  • func ReadConfig(file string) (*Config, error)
  • func (cfg *Config) GetFunctionsTimeout() time.Duration
  • func (cfg *Config) GetTelemetryBackendAddr() string
• type GenericTelemetryCarrier
  • func (c *GenericTelemetryCarrier) Get(key string) string
  • func (c *GenericTelemetryCarrier) Keys() []string
  • func (c *GenericTelemetryCarrier) Set(key, val string)

Constants

const (
	DBConn                   = "DIREKTIV_DB"
	DirektivDebug            = "DIREKTIV_DEBUG"
	DirektivServiceNamespace = "DIREKTIV_SERVICE_NAMESPACE"
	DirektivNamespace        = "DIREKTIV_NAMESPACE"

	DirektivFlowEndpoint      = "DIREKTIV_FLOW_ENDPOINT"
	DirektivFunctionsEndpoint = "DIREKTIV_FUNCTIONS_ENDPOINT"
	DirektivIngressEndpoint   = "DIREKTIV_INTERNAL_ENDPOINT"

	DirektivLogJSON       = "DIREKTIV_LOG_JSON"
	DirektivOpentelemetry = "DIREKTIV_OTLP"
)

Environtment variable keys

const (
	InodeTypeGit       = "git"
	InodeTypeDirectory = "directory"
	InodeTypeWorkflow  = "workflow"
)

const (
	InstanceStatusPending  = "pending"
	InstanceStatusFailed   = "failed"
	InstanceStatusCrashed  = "crashed"
	InstanceStatusComplete = "complete"
)

const (
	MirrorActivityTypeInit        = "init"
	MirrorActivityTypeReconfigure = "reconfigure"
	MirrorActivityTypeLocked      = "locked"
	MirrorActivityTypeUnlocked    = "unlocked"
	MirrorActivityTypeCronSync    = "scheduled-sync"
	MirrorActivityTypeSync        = "sync"
)

const (
	MirrorActivityStatusComplete  = "complete"
	MirrorActivityStatusPending   = "pending"
	MirrorActivityStatusExecuting = "executing"
	MirrorActivityStatusFailed    = "failed"
)

const NameRegexFragment = `(([a-z][a-z0-9_\-\.]*[a-z0-9])|([a-z]))`

const NameRegexPattern = `^` + NameRegexFragment + `$`

const RefRegexFragment = `(([a-zA-Z0-9][a-zA-Z0-9_\-\.]*[a-zA-Z0-9])|([a-zA-Z0-9]))`

const RefRegexPattern = `^` + RefRegexFragment + `$`

const RegexPattern = NameRegexPattern

const URIRegexPattern = `^(` + NameRegexFragment + `[\/]?)*$`

const VarNameRegexPattern = `^(([a-zA-Z][a-zA-Z0-9_\-\.]*[a-zA-Z0-9])|([a-zA-Z]))$`

const VarRegexPattern = VarNameRegexPattern

Variables

var NameRegex = regexp.MustCompile(NameRegexPattern)

var RefRegex = regexp.MustCompile(RefRegexPattern)

var TelemetryMiddleware = func(h http.Handler) http.Handler {
	return h
}

var URIRegex = regexp.MustCompile(URIRegexPattern)

var VarNameRegex = regexp.MustCompile(VarNameRegexPattern)

Functions

func AddGlobalGRPCDialOption

func AddGlobalGRPCDialOption(opt grpc.DialOption)

func AddGlobalGRPCServerOption

func AddGlobalGRPCServerOption(opt grpc.ServerOption)

func GetEndpointTLS

func GetEndpointTLS(service string) (*grpc.ClientConn, error)

GetEndpointTLS creates a grpc client

func GrpcServerOptions

func GrpcServerOptions(unaryInterceptor grpc.UnaryServerInterceptor, streamInterceptor grpc.StreamServerInterceptor) []grpc.ServerOption

func GrpcStart

func GrpcStart(server **grpc.Server, name, bind string, register func(srv *grpc.Server)) error

GrpcStart starts a grpc server

func InitTelemetry

func InitTelemetry(conf *Config, svcName, imName string) (func(), error)

func MatchesRegex

func MatchesRegex(s string) bool

MatchesRegex responds true if the provided string matches the RegexPattern constant defined in this package.

func MatchesVarRegex

func MatchesVarRegex(s string) bool

func SanitizeAsField

func SanitizeAsField(as string) string

SanitizeAsField removes initial slash if one exists and returns the new value

func Trace

func Trace(ctx context.Context, msg string)

func TraceHTTPRequest

func TraceHTTPRequest(ctx context.Context, r *http.Request) (cleanup func())

func TransplantTelemetryContextInformation

func TransplantTelemetryContextInformation(a, b context.Context) context.Context

Types

type Config

type Config struct {
	FunctionsService string `yaml:"functions-service"`

	// FunctionsTimeout : Action timeout in milliseconds
	FunctionsTimeout int64 `yaml:"functions-timeout"`

	FlowService string `yaml:"flow-service"`

	PrometheusBackend    string `yaml:"prometheus-backend"`
	OpenTelemetryBackend string `yaml:"opentelemetry-backend"`

	Eventing bool `yaml:"eventing"`
}

Config contain direktiv configuration

func ReadConfig

func ReadConfig(file string) (*Config, error)

ReadConfig reads direktiv config file

func (*Config) GetFunctionsTimeout

func (cfg *Config) GetFunctionsTimeout() time.Duration

func (*Config) GetTelemetryBackendAddr

func (cfg *Config) GetTelemetryBackendAddr() string

type GenericTelemetryCarrier

type GenericTelemetryCarrier struct {
	Trace map[string]string
}

func (*GenericTelemetryCarrier) Get

func (c *GenericTelemetryCarrier) Get(key string) string

func (*GenericTelemetryCarrier) Keys

func (c *GenericTelemetryCarrier) Keys() []string

func (*GenericTelemetryCarrier) Set

func (c *GenericTelemetryCarrier) Set(key, val string)