記錄錯誤日志的關鍵在于選擇合適的日志庫、配置日志級別、正確記錄錯誤信息、處理panic、輸出日志到不同地方及在分布式系統中追蹤日志。1. 日志庫推薦logrus（適合靈活配置）、zap和zerolog（適合高性能需求）；2. 日志級別按環境設置，開發設為debug，生產設為info或warn；3. 記錄錯誤需包含時間、位置、上下文，并使用%w包裝保留堆棧；4. 使用recover捕獲panic并記錄；5. 通過logrus的hook機制將日志輸出至文件、數據庫等；6. 在分布式系統中集成jaeger等追蹤系統，實現日志關聯與請求追蹤。
記錄錯誤日志，簡單來說，就是在你的Go程序里，當事情出錯的時候，把錯誤信息保存下來，方便你以后排查問題。這聽起來很簡單，但做好它能幫你省下大把的時間和精力。
記錄錯誤日志，通常涉及選擇合適的日志庫，配置日志級別，以及在代碼中正確地記錄錯誤信息。
如何選擇合適的golang日志庫？
Golang本身自帶了log包，但它功能比較基礎，只適合簡單的日志記錄。對于稍微復雜一點的項目，建議使用第三方的日志庫，比如logrus、zap、zerolog等等。
立即學習“go語言免費學習筆記（深入）”；
選擇哪個庫取決于你的需求：
- logrus: 功能全面，配置靈活，社區活躍，但性能相對較慢。適合對性能要求不高的項目，或者需要豐富配置的項目。
- zap: Uber開源的高性能日志庫，性能非常出色，但配置相對復雜。適合對性能要求高的項目。
- zerolog: 專注于零分配的日志庫，性能也很不錯，API簡潔。適合對性能有較高要求的項目。
我的個人經驗是，如果項目對性能要求不是特別高，logrus是一個不錯的選擇，它的配置非常靈活，可以滿足各種需求。如果對性能有極致的追求，zap或者zerolog會更適合。
如何配置日志級別？
日志級別決定了哪些信息會被記錄下來。常見的日志級別包括：
- Debug: 調試信息，一般用于開發階段。
- Info: 普通信息，用于記錄程序的運行狀態。
- Warn: 警告信息，表示程序可能存在問題，但不影響正常運行。
- Error: 錯誤信息，表示程序出現了錯誤，可能會影響正常運行。
- Fatal: 致命錯誤，表示程序無法繼續運行。
在生產環境中，通常會將日志級別設置為Info或者Warn，避免記錄過多的調試信息，影響性能。在開發環境中，可以設置為Debug，方便調試。
以logrus為例，配置日志級別的代碼如下：
import ( "github.com/sirupsen/logrus" ) func main() { logrus.SetLevel(logrus.DebugLevel) // 設置日志級別為Debug logrus.Debug("This is a debug message") logrus.Info("This is an info message") logrus.Warn("This is a warning message") logrus.Error("This is an error message") logrus.Fatal("This is a fatal message") }
如何在代碼中正確地記錄錯誤信息？
記錄錯誤信息，最重要的是要包含足夠的信息，方便以后排查問題。通常需要包含以下信息：
- 錯誤發生的時間
- 錯誤發生的位置（文件名、行號）
- 錯誤的詳細描述
- 相關的上下文信息
go語言的錯誤處理機制是基于返回值的，所以通常需要在函數中顯式地檢查錯誤，并記錄下來。
import ( "fmt" "os" "github.com/sirupsen/logrus" ) func readFile(filename string) ([]byte, error) { file, err := os.Open(filename) if err != nil { logrus.Errorf("Failed to open file %s: %v", filename, err) return nil, fmt.Errorf("failed to open file: %w", err) // 使用 %w 包裝原始錯誤 } defer file.Close() fileInfo, err := file.Stat() if err != nil { logrus.Errorf("Failed to get file info for %s: %v", filename, err) return nil, fmt.Errorf("failed to get file info: %w", err) } buffer := make([]byte, fileInfo.Size()) _, err = file.Read(buffer) if err != nil { logrus.Errorf("Failed to read file %s: %v", filename, err) return nil, fmt.Errorf("failed to read file: %w", err) } return buffer, nil } func main() { logrus.SetLevel(logrus.DebugLevel) content, err := readFile("nonexistent_file.txt") if err != nil { logrus.Errorf("Main function error: %v", err) // 在主函數中也記錄錯誤 return } fmt.Println(string(content)) }
這段代碼展示了如何使用logrus記錄錯誤信息，并且使用了%w來包裝原始錯誤，這樣可以保留錯誤的堆棧信息，方便以后排查問題。同時，在主函數中也記錄了錯誤，這樣可以更好地追蹤錯誤的來源。
如何處理panic？
panic是Golang中一種特殊的錯誤處理機制，表示程序遇到了無法恢復的錯誤。如果不處理panic，程序會直接崩潰。為了避免程序崩潰，可以使用recover來捕獲panic，并記錄下來。
import ( "fmt" "github.com/sirupsen/logrus" ) func recoverPanic() { if r := recover(); r != nil { logrus.Errorf("Recovered from panic: %v", r) // 這里可以做一些清理工作，比如關閉數據庫連接 } } func mightPanic() { defer recoverPanic() // 確保在函數退出時執行 recoverPanic panic("Something went wrong") } func main() { logrus.SetLevel(logrus.DebugLevel) mightPanic() fmt.Println("Program continues after panic") // 如果panic被recover，程序會繼續執行 }
這段代碼展示了如何使用recover捕獲panic，并記錄下來。需要注意的是，recover只能在defer函數中使用。
如何將日志輸出到不同的地方？
通常情況下，我們會將日志輸出到控制臺或者文件中。但有時候，我們需要將日志輸出到不同的地方，比如數據庫、消息隊列等等。
logrus提供了Hook機制，可以方便地將日志輸出到不同的地方。
import ( "github.com/sirupsen/logrus" "gopkg.in/olivere/elastic.v5" // 注意版本兼容性 ) type elasticsearchHook struct { client *elastic.Client index string } func NewElasticsearchHook(client *elastic.Client, index string) (*ElasticsearchHook, error) { return &ElasticsearchHook{client: client, index: index}, nil } func (hook *ElasticsearchHook) Levels() []logrus.Level { return []logrus.Level{ logrus.ErrorLevel, logrus.FatalLevel, logrus.PanicLevel, } } func (hook *ElasticsearchHook) Fire(entry *logrus.Entry) error { _, err := hook.client.Index(). Index(hook.index). Type("log"). BodyJson(entry.Data). Do() return err } func main() { logrus.SetLevel(logrus.DebugLevel) // Elasticsearch 配置 esClient, err := elastic.NewClient(elastic.SetURL("http://localhost:9200")) if err != nil { logrus.Fatalf("Failed to create Elasticsearch client: %v", err) } esHook, err := NewElasticsearchHook(esClient, "my-app-logs") if err != nil { logrus.Fatalf("Failed to create Elasticsearch hook: %v", err) } logrus.AddHook(esHook) logrus.Error("This is an error message that will be sent to Elasticsearch") }
這段代碼展示了如何使用logrus的Hook機制，將錯誤日志輸出到Elasticsearch中。需要注意的是，需要引入olivere/elastic.v5這個庫，并且需要配置Elasticsearch的連接信息。
如何在分布式系統中追蹤日志？
在分布式系統中，日志分散在不同的機器上，排查問題非常困難。為了解決這個問題，可以使用分布式追蹤系統，比如Jaeger、Zipkin等等。
這些系統可以追蹤請求在不同服務之間的調用關系，并將日志關聯起來，方便排查問題。
import ( "context" "fmt" "io" "net/http" "os" "github.com/opentracing/opentracing-go" "github.com/opentracing/opentracing-go/ext" "github.com/uber/jaeger-client-go" "github.com/uber/jaeger-client-go/config" ) func initJaeger(service string) (opentracing.Tracer, io.Closer, error) { cfg := &config.Configuration{ ServiceName: service, Sampler: &config.SamplerConfig{ Type: jaeger.SamplerTypeConst, Param: 1, }, Reporter: &config.ReporterConfig{ LogSpans: true, // 將span發送到jaeger agent CollectorEndpoint: "http://localhost:14268/api/traces", // 如果jaeger agent在本機，則無需配置以下兩項 //LocalAgentHostPort: "127.0.0.1:6832", }, } tracer, closer, err := cfg.NewTracer(config.Logger(jaeger.StdLogger)) if err != nil { return nil, nil, err } opentracing.SetGlobalTracer(tracer) return tracer, closer, nil } func main() { tracer, closer, err := initJaeger("my-go-service") if err != nil { fmt.Printf("Could not initialize jaeger tracer: %sn", err.Error()) os.Exit(1) } defer closer.Close() http.HandleFunc("/hello", func(w http.ResponseWriter, r *http.Request) { span := tracer.StartSpan("/hello") defer span.Finish() ctx := opentracing.ContextWithSpan(context.Background(), span) helloHandler(ctx, w, r) }) fmt.Println("Server listening on :8080") http.ListenAndServe(":8080", nil) } func helloHandler(ctx context.Context, w http.ResponseWriter, r *http.Request) { span := opentracing.SpanFromContext(ctx) span.LogKV("event", "handling request") // 添加日志 _, err := fmt.Fprintf(w, "Hello, world!n") if err != nil { ext.Error.Set(span, true) // 標記錯誤 span.LogKV("error", err.Error()) http.Error(w, err.Error(), http.StatusInternalServerError) return } }
這段代碼展示了如何使用Jaeger追蹤請求，并將日志關聯起來。需要注意的是，需要引入github.com/opentracing/opentracing-go和github.com/uber/jaeger-client-go這兩個庫，并且需要配置Jaeger的連接信息。
總而言之，記錄錯誤日志是一個非常重要的環節，它能幫助你快速定位問題，提高開發效率。選擇合適的日志庫，配置合適的日志級別，并在代碼中正確地記錄錯誤信息，是做好錯誤日志記錄的關鍵。
