diff options
| author | Kubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com> | 2021-02-11 02:24:16 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-11 02:24:16 -0800 |
| commit | eec1ce76b270a43b1a92bef58aace9cfce2fac8d (patch) | |
| tree | 7c0bbfecb17a68260510f26417508b487a0d651f | |
| parent | f0d4b23531b3ef76dbef8b4f9e4195377557b882 (diff) | |
| parent | 48a8c87b7e7c0dd990d5855d9c896c52de49e762 (diff) | |
Merge pull request #5486 from ehashman/fatal-logs
Add guidance for fatal exit codes
| -rw-r--r-- | contributors/devel/sig-instrumentation/migration-to-structured-logging.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/contributors/devel/sig-instrumentation/migration-to-structured-logging.md b/contributors/devel/sig-instrumentation/migration-to-structured-logging.md index 36fe9f1e..cd213297 100644 --- a/contributors/devel/sig-instrumentation/migration-to-structured-logging.md +++ b/contributors/devel/sig-instrumentation/migration-to-structured-logging.md @@ -150,6 +150,8 @@ origin point. For expected errors (`errors` that can happen during routine opera Use of Fatal should be discouraged and it's not available in new functions. Instead of depending on the logger to exit the process, you should call `os.Exit()` yourself. +Fatal calls use a default exit code of 255. When migrating, please use an exit code of 1 and include an "ACTION REQUIRED:" release note. + ## Remove string formatting from log message With structured logging, log messages are no longer formatted, leaving argument marshalling up to the logging client |