observability

Documentation

Index

• Constants
• func AddSpanContextToLogger(ctx context.Context) context.Context
• func AddSpanToLogger(ctx context.Context, span trace.Span) (context.Context, trace.Span)
• func Init(ctx context.Context, isUserService bool, ...) error
• func NewOtelLogger(logger *log.Logger, level log.Level) logr.Logger
• func OpenDBAndInstrument(dsn string) (*sql.DB, error)
• func SuccessOrFailureStatusAttr(succeeded bool) attribute.KeyValue
• type Config
• type ExportOTELFlag
  • func (e *ExportOTELFlag) UnmarshalText(text []byte) error

Constants

const (
	ModuleNameAttribute          = "ftl.module.name"
	OutcomeStatusNameAttribute   = "ftl.outcome.status"
	RunnerDeploymentKeyAttribute = "ftl.deployment.key"

	SuccessStatus = "success"
	FailureStatus = "failure"
)

Functions

func AddSpanContextToLogger

func AddSpanContextToLogger(ctx context.Context) context.Context

func AddSpanToLogger

func AddSpanToLogger(ctx context.Context, span trace.Span) (context.Context, trace.Span)

func Init

func Init(ctx context.Context, isUserService bool, projectName, serviceName, serviceVersion string, config Config) error

func NewOtelLogger

func NewOtelLogger(logger *log.Logger, level log.Level) logr.Logger

func OpenDBAndInstrument

func OpenDBAndInstrument(dsn string) (*sql.DB, error)

func SuccessOrFailureStatusAttr

func SuccessOrFailureStatusAttr(succeeded bool) attribute.KeyValue

Types

type Config

type Config struct {
	LogLevel   log.Level      `default:"error" help:"OTEL log level." env:"FTL_O11Y_LOG_LEVEL"`
	ExportOTEL ExportOTELFlag `help:"Export observability data to OTEL." env:"OTEL_EXPORTER_OTLP_ENDPOINT"`
}

type ExportOTELFlag

type ExportOTELFlag bool

func (*ExportOTELFlag) UnmarshalText

func (e *ExportOTELFlag) UnmarshalText(text []byte) error