mirror of
https://github.com/opentofu/opentofu.git
synced 2025-02-25 18:45:20 -06:00
97d64581c6
Now we'll consider any message that doesn't start with a digit as a continuation. This is _definitely_ in loose, best-effort territory now since a continuation line could very well start with a digit, but ultimately this is still better than the totally broken behavior that preceded it. Just to make sure that none of these heuristics interfere with producing complete, accurate logs for TRACE, we'll skip the LevelFilter altogether in that case.
110 lines
2.7 KiB
Go
110 lines
2.7 KiB
Go
package logging
|
|
|
|
import (
|
|
"io"
|
|
"io/ioutil"
|
|
"log"
|
|
"os"
|
|
"strings"
|
|
"syscall"
|
|
)
|
|
|
|
// These are the environmental variables that determine if we log, and if
|
|
// we log whether or not the log should go to a file.
|
|
const (
|
|
EnvLog = "TF_LOG" // Set to True
|
|
EnvLogFile = "TF_LOG_PATH" // Set to a file
|
|
)
|
|
|
|
// ValidLevels are the log level names that Terraform recognizes.
|
|
var ValidLevels = []LogLevel{"TRACE", "DEBUG", "INFO", "WARN", "ERROR"}
|
|
|
|
// LogOutput determines where we should send logs (if anywhere) and the log level.
|
|
func LogOutput() (logOutput io.Writer, err error) {
|
|
logOutput = ioutil.Discard
|
|
|
|
logLevel := CurrentLogLevel()
|
|
if logLevel == "" {
|
|
return
|
|
}
|
|
|
|
logOutput = os.Stderr
|
|
if logPath := os.Getenv(EnvLogFile); logPath != "" {
|
|
var err error
|
|
logOutput, err = os.OpenFile(logPath, syscall.O_CREAT|syscall.O_RDWR|syscall.O_APPEND, 0666)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
if logLevel == "TRACE" {
|
|
// Just pass through logs directly then, without any level filtering at all.
|
|
return logOutput, nil
|
|
}
|
|
|
|
// Otherwise we'll use our level filter, which is a heuristic-based
|
|
// best effort thing that is not totally reliable but helps to reduce
|
|
// the volume of logs in some cases.
|
|
logOutput = &LevelFilter{
|
|
Levels: ValidLevels,
|
|
MinLevel: LogLevel(logLevel),
|
|
Writer: logOutput,
|
|
}
|
|
|
|
return logOutput, nil
|
|
}
|
|
|
|
// SetOutput checks for a log destination with LogOutput, and calls
|
|
// log.SetOutput with the result. If LogOutput returns nil, SetOutput uses
|
|
// ioutil.Discard. Any error from LogOutout is fatal.
|
|
func SetOutput() {
|
|
out, err := LogOutput()
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
|
|
if out == nil {
|
|
out = ioutil.Discard
|
|
}
|
|
|
|
log.SetOutput(out)
|
|
}
|
|
|
|
// CurrentLogLevel returns the current log level string based the environment vars
|
|
func CurrentLogLevel() string {
|
|
envLevel := os.Getenv(EnvLog)
|
|
if envLevel == "" {
|
|
return ""
|
|
}
|
|
|
|
logLevel := "TRACE"
|
|
if isValidLogLevel(envLevel) {
|
|
// allow following for better ux: info, Info or INFO
|
|
logLevel = strings.ToUpper(envLevel)
|
|
} else {
|
|
log.Printf("[WARN] Invalid log level: %q. Defaulting to level: TRACE. Valid levels are: %+v",
|
|
envLevel, ValidLevels)
|
|
}
|
|
if logLevel != "TRACE" {
|
|
log.Printf("[WARN] Log levels other than TRACE are currently unreliable, and are supported only for backward compatibility.\n Use TF_LOG=TRACE to see Terraform's internal logs.\n ----")
|
|
}
|
|
|
|
return logLevel
|
|
}
|
|
|
|
// IsDebugOrHigher returns whether or not the current log level is debug or trace
|
|
func IsDebugOrHigher() bool {
|
|
level := string(CurrentLogLevel())
|
|
return level == "DEBUG" || level == "TRACE"
|
|
}
|
|
|
|
func isValidLogLevel(level string) bool {
|
|
for _, l := range ValidLevels {
|
|
if strings.ToUpper(level) == string(l) {
|
|
return true
|
|
}
|
|
}
|
|
|
|
return false
|
|
}
|