logs

Documentation

Index

• Variables
• func ReadCompressedFile(filePath string) (io.Reader, error)
• func ReadJSONLog(ctx context.Context, logReader io.Reader, follow bool, c chan interface{}, ...)
• func ReadLog(ctx context.Context, logReader io.Reader, follow bool, c chan []byte, ...)
• type ApiBasePath
• type ILoggerFactory
  • func NewLoggerFactory(config LoggerFactoryConfig) ILoggerFactory
• type LogEntry
• type LogFileConfig
  • func GetDefaultLogFileConfig(logFilePath string) *LogFileConfig
• type LogSource
• type Logger
• type LoggerFactoryConfig
• type RemoteLogger
  • func (r *RemoteLogger) Cleanup() error
  • func (r *RemoteLogger) Close() error
  • func (r *RemoteLogger) ConstructJsonLogEntry(p []byte) ([]byte, error)
  • func (r *RemoteLogger) Write(p []byte) (n int, err error)
• type RemoteLoggerFactoryConfig

Variables

var LogDelimiter = "!-#_^*|\n"

Functions

func ReadCompressedFile

func ReadCompressedFile(filePath string) (io.Reader, error)

func ReadJSONLog

func ReadJSONLog(ctx context.Context, logReader io.Reader, follow bool, c chan interface{}, errChan chan error)

func ReadLog

func ReadLog(ctx context.Context, logReader io.Reader, follow bool, c chan []byte, errChan chan error)

Types

type ApiBasePath

type ApiBasePath string

var (
	ApiBasePathWorkspace ApiBasePath = "/log/workspace"
	ApiBasePathBuild     ApiBasePath = "/log/build"
	ApiBasePathRunner    ApiBasePath = "/log/runner"
	ApiBasePathTarget    ApiBasePath = "/log/target"
)

type ILoggerFactory

type ILoggerFactory interface {
	CreateLogger(id, label string, source LogSource) (Logger, error)
	CreateLogReader(id string) (io.Reader, error)
	CreateLogWriter(id string) (io.WriteCloser, error)
}

func NewLoggerFactory

func NewLoggerFactory(config LoggerFactoryConfig) ILoggerFactory

type LogEntry

type LogEntry struct {
	Source string `json:"source"`
	Label  string `json:"label"`
	Msg    string `json:"msg"`
	Level  string `json:"level"`
	Time   string `json:"time"`
}

type LogFileConfig

type LogFileConfig struct {
	Path       string `json:"path" validate:"required"`
	MaxSize    int32  `json:"maxSize" validate:"required"`
	MaxBackups int32  `json:"maxBackups" validate:"required"`
	MaxAge     int32  `json:"maxAge" validate:"required"`
	LocalTime  bool   `json:"localTime" validate:"optional"`
	Compress   bool   `json:"compress" validate:"optional"`

} // @name LogFileConfig

func GetDefaultLogFileConfig

func GetDefaultLogFileConfig(logFilePath string) *LogFileConfig

type LogSource

type LogSource string

const (
	LogSourceServer   LogSource = "server"
	LogSourceProvider LogSource = "provider"
	LogSourceBuilder  LogSource = "builder"
	LogSourceRunner   LogSource = "runner"
)

type Logger

type Logger interface {
	io.WriteCloser
	ConstructJsonLogEntry(p []byte) ([]byte, error)
	Cleanup() error
}

type LoggerFactoryConfig

type LoggerFactoryConfig struct {
	LogsDir     string
	ApiUrl      *string
	ApiKey      *string
	ApiBasePath *ApiBasePath
}

type RemoteLogger

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

func (*RemoteLogger) Cleanup

func (r *RemoteLogger) Cleanup() error

func (*RemoteLogger) Close

func (r *RemoteLogger) Close() error

func (*RemoteLogger) ConstructJsonLogEntry

func (r *RemoteLogger) ConstructJsonLogEntry(p []byte) ([]byte, error)

func (*RemoteLogger) Write

func (r *RemoteLogger) Write(p []byte) (n int, err error)

type RemoteLoggerFactoryConfig

type RemoteLoggerFactoryConfig struct {
	LogsDir     string
	ApiUrl      string
	ApiKey      string
	ApiBasePath ApiBasePath
}