logp/config.go

// Licensed to Elasticsearch B.V. under one or more contributor
// license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright
// ownership. Elasticsearch B.V. licenses this file to you under
// the Apache License, Version 2.0 (the "License"); you may
// not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package logp

import (
	"time"
)

// Config contains the configuration options for the logger. To create a Config
// from a common.Config use logp/config.Build.
type Config struct {
	Beat      string   `config:",ignore"`   // Name of the Beat (for default file name).
	Level     Level    `config:"level"`     // Logging level (error, warning, info, debug).
	Selectors []string `config:"selectors"` // Selectors for debug level logging.

	toObserver  bool
	toIODiscard bool
	ToStderr    bool `config:"to_stderr" yaml:"to_stderr"`
	ToSyslog    bool `config:"to_syslog" yaml:"to_syslog"`
	ToFiles     bool `config:"to_files" yaml:"to_files"`
	ToEventLog  bool `config:"to_eventlog" yaml:"to_eventlog"`

	Files   FileConfig    `config:"files"`
	Metrics MetricsConfig `config:"metrics"`

	WithFields map[string]any `config:"with_fields" yaml:"with_fields"`

	environment Environment
	AddCaller   bool // Adds package and line number info to messages.
	development bool // Controls how DPanic behaves.
}

// FileConfig contains the configuration options for the file output.
type FileConfig struct {
	Path            string        `config:"path" yaml:"path"`
	Name            string        `config:"name" yaml:"name"`
	MaxSize         uint          `config:"rotateeverybytes" yaml:"rotateeverybytes" validate:"min=1"`
	MaxBackups      uint          `config:"keepfiles" yaml:"keepfiles" validate:"max=1024"`
	Permissions     uint32        `config:"permissions"`
	Interval        time.Duration `config:"interval"`
	RotateOnStartup bool          `config:"rotateonstartup"`
	RedirectStderr  bool          `config:"redirect_stderr" yaml:"redirect_stderr"`
}

// MetricsConfig contains configuration used by the monitor to output metrics into the logstream.
//
// Currently these options are not used through this object in beats (as monitoring is setup elsewhere).
type MetricsConfig struct {
	Enabled bool          `config:"enabled"`
	Period  time.Duration `config:"period"`
}

const (
	defaultLevel = InfoLevel
)

// DefaultConfig returns the default config options for a given environment the
// Beat is supposed to be run within.
func DefaultConfig(environment Environment) Config {
	toFiles := true
	toStderr := false

	// For container and systemd environments, we don't write to files by default.
	switch environment {
	case ContainerEnvironment, SystemdEnvironment:
		toFiles = false
		toStderr = true
	}

	return Config{
		Level:    defaultLevel,
		ToFiles:  toFiles,
		ToStderr: toStderr,
		Files: FileConfig{
			MaxSize:         10 * 1024 * 1024,
			MaxBackups:      7,
			Permissions:     0600,
			Interval:        0,
			RotateOnStartup: true,
		},
		Metrics: MetricsConfig{
			Enabled: true,
			Period:  30 * time.Second,
		},
		environment: environment,
		AddCaller:   true,
	}
}

// DefaultEventConfig returns the default config options for the event logger in
// a given environment the Beat is supposed to be run within.
func DefaultEventConfig(environment Environment) Config {
	return Config{
		Level:    defaultLevel,
		ToFiles:  true,
		ToStderr: false,
		Files: FileConfig{
			MaxSize:         5 * 1024 * 1024, // 5Mb
			MaxBackups:      2,
			Permissions:     0600,
			Interval:        0,
			RotateOnStartup: false,
			RedirectStderr:  false,
			Name:            "event-data",
		},
		Metrics: MetricsConfig{
			Enabled: false,
		},
		environment: environment,
		AddCaller:   true,
	}
}

// LogFilename returns the base filename to which logs will be written for
// the "files" log output. If another log output is used, or `logging.files.name`
// is unspecified, then the beat name will be returned.
func (cfg Config) LogFilename() string {
	name := cfg.Beat
	if cfg.Files.Name != "" {
		name = cfg.Files.Name
	}
	return name
}