Function NewFileLogger

base/logger_file.go:92–134

NewFileLogger returns a new FileLogger from a config.

(ctx context.Context, config *FileLoggerConfig, level LogLevel, name string, logFilePath string, minAge int, defaultMaxAgeOverride *int, buffer *strings.Builder)

// NewFileLogger returns a new FileLogger from a config.
func NewFileLogger(ctx context.Context, config *FileLoggerConfig, level LogLevel, name string, logFilePath string, minAge int, defaultMaxAgeOverride *int, buffer *strings.Builder) (*FileLogger, error) {
	if config == nil {
		config = &FileLoggerConfig{}
	}

	cancelCtx, cancelFunc := context.WithCancel(ctx)

	// validate and set defaults
	rotationDoneChan, err := config.init(cancelCtx, level, name, logFilePath, minAge, defaultMaxAgeOverride)
	if err != nil {
		cancelFunc()
		return nil, err
	}

	logger := &FileLogger{
		Enabled:          AtomicBool{},
		level:            level,
		name:             name,
		output:           config.Output,
		logger:           log.New(config.Output, "", 0),
		config:           *config,
		closed:           make(chan struct{}),
		cancelFunc:       cancelFunc,
		rotationDoneChan: rotationDoneChan,
	}
	logger.Enabled.Set(*config.Enabled)

	if buffer != nil {
		logger.buffer = *buffer
	}

	// Only create the collateBuffer channel and worker if required.
	if *config.CollationBufferSize > 1 {
		logger.collateBuffer = make(chan string, *config.CollationBufferSize)
		logger.flushChan = make(chan struct{}, 1)
		logger.collateBufferWg = &sync.WaitGroup{}

		// Start up a single worker to consume messages from the buffer
		go logCollationWorker(logger.closed, logger.collateBuffer, logger.flushChan, logger.collateBufferWg, logger.logger, *config.CollationBufferSize, fileLoggerCollateFlushTimeout)
	}

	return logger, nil
}

func (l *FileLogger) FlushBufferToLog() {
	// Need to clear hanging new line to avoid empty line