From 48a8c87b7e7c0dd990d5855d9c896c52de49e762 Mon Sep 17 00:00:00 2001 From: Elana Hashman Date: Wed, 10 Feb 2021 15:36:38 -0800 Subject: [PATCH] Add guidance for fatal exit codes --- .../sig-instrumentation/migration-to-structured-logging.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/contributors/devel/sig-instrumentation/migration-to-structured-logging.md b/contributors/devel/sig-instrumentation/migration-to-structured-logging.md index 36fe9f1e1..cd213297d 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