Use Zap logger in Go
Use Zap for all logging in Go code.
Bad:
```go
func processOrder(order Order) error {
fmt.Printf("Processing order %s\n", order.ID)
if err := validateOrder(order); err != nil {
Install this rule for wispbit
Add this rule to wispbit and it will run when you open a pull request
Install this rule for Coderabbit
Copy the configuration below and add it to your repository as .coderabbit.yml
in your project root.
reviews:
path_instructions:
- path: "*.go"
instructions: |
Use Zap for all logging in Go code.
Bad:
```go
func processOrder(order Order) error {
fmt.Printf("Processing order %s\n", order.ID)
if err := validateOrder(order); err != nil {
log.Printf("Error validating order: %v", err)
return err
}
fmt.Println("Order processed successfully")
return nil
}
```
Good:
```go
func processOrder(order Order) error {
logger := zap.L().With(zap.String("orderID", order.ID))
logger.Info("Processing order")
if err := validateOrder(order); err != nil {
logger.Error("Failed to validate order", zap.Error(err))
return err
}
logger.Info("Order processed successfully")
return nil
}
```
Install this rule for Greptile
Greptile rules can be added through the web interface. Please see this documentation for details on how to add custom rules and context.
Use Zap for all logging in Go code.
Bad:
```go
func processOrder(order Order) error {
fmt.Printf("Processing order %s\n", order.ID)
if err := validateOrder(order); err != nil {
log.Printf("Error validating order: %v", err)
return err
}
fmt.Println("Order processed successfully")
return nil
}
```
Good:
```go
func processOrder(order Order) error {
logger := zap.L().With(zap.String("orderID", order.ID))
logger.Info("Processing order")
if err := validateOrder(order); err != nil {
logger.Error("Failed to validate order", zap.Error(err))
return err
}
logger.Info("Order processed successfully")
return nil
}
```
File Path Patterns:
Install this rule for GitHub Copilot
Copilot instructions can be added through the interface. See the documentation for details on how to create coding guidelines.
Use Zap for all logging in Go code.
Bad:
```go
func processOrder(order Order) error {
fmt.Printf("Processing order %s\n", order.ID)
if err := validateOrder(order); err != nil {
log.Printf("Error validating order: %v", err)
return err
}
fmt.Println("Order processed successfully")
return nil
}
```
Good:
```go
func processOrder(order Order) error {
logger := zap.L().With(zap.String("orderID", order.ID))
logger.Info("Processing order")
if err := validateOrder(order); err != nil {
logger.Error("Failed to validate order", zap.Error(err))
return err
}
logger.Info("Order processed successfully")
return nil
}
```
File Path Patterns:
Install this rule for Graphite Diamond
Diamond custom rules can be added through the interface. See the documentation for details on how to create custom rules.
Use Zap for all logging in Go code.
Bad:
```go
func processOrder(order Order) error {
fmt.Printf("Processing order %s\n", order.ID)
if err := validateOrder(order); err != nil {
log.Printf("Error validating order: %v", err)
return err
}
fmt.Println("Order processed successfully")
return nil
}
```
Good:
```go
func processOrder(order Order) error {
logger := zap.L().With(zap.String("orderID", order.ID))
logger.Info("Processing order")
if err := validateOrder(order); err != nil {
logger.Error("Failed to validate order", zap.Error(err))
return err
}
logger.Info("Order processed successfully")
return nil
}
```
File Path Patterns:
Use with Cline
Copy the rule below and ask Cline to review your code using this rule
Use Zap for all logging in Go code.
Bad:
```go
func processOrder(order Order) error {
fmt.Printf("Processing order %s\n", order.ID)
if err := validateOrder(order); err != nil {
log.Printf("Error validating order: %v", err)
return err
}
fmt.Println("Order processed successfully")
return nil
}
```
Good:
```go
func processOrder(order Order) error {
logger := zap.L().With(zap.String("orderID", order.ID))
logger.Info("Processing order")
if err := validateOrder(order); err != nil {
logger.Error("Failed to validate order", zap.Error(err))
return err
}
logger.Info("Order processed successfully")
return nil
}
```
Use with OpenAI Codex
Copy the rule below and ask OpenAI Codex to review your code using this rule
Use Zap for all logging in Go code.
Bad:
```go
func processOrder(order Order) error {
fmt.Printf("Processing order %s\n", order.ID)
if err := validateOrder(order); err != nil {
log.Printf("Error validating order: %v", err)
return err
}
fmt.Println("Order processed successfully")
return nil
}
```
Good:
```go
func processOrder(order Order) error {
logger := zap.L().With(zap.String("orderID", order.ID))
logger.Info("Processing order")
if err := validateOrder(order); err != nil {
logger.Error("Failed to validate order", zap.Error(err))
return err
}
logger.Info("Order processed successfully")
return nil
}
```
Use with Cursor
Copy the rule below and ask Cursor to review your code using this rule
Use Zap for all logging in Go code.
Bad:
```go
func processOrder(order Order) error {
fmt.Printf("Processing order %s\n", order.ID)
if err := validateOrder(order); err != nil {
log.Printf("Error validating order: %v", err)
return err
}
fmt.Println("Order processed successfully")
return nil
}
```
Good:
```go
func processOrder(order Order) error {
logger := zap.L().With(zap.String("orderID", order.ID))
logger.Info("Processing order")
if err := validateOrder(order); err != nil {
logger.Error("Failed to validate order", zap.Error(err))
return err
}
logger.Info("Order processed successfully")
return nil
}
```
Use with Claude Code
Copy the rule below and ask Claude Code to review your code using this rule
Use Zap for all logging in Go code.
Bad:
```go
func processOrder(order Order) error {
fmt.Printf("Processing order %s\n", order.ID)
if err := validateOrder(order); err != nil {
log.Printf("Error validating order: %v", err)
return err
}
fmt.Println("Order processed successfully")
return nil
}
```
Good:
```go
func processOrder(order Order) error {
logger := zap.L().With(zap.String("orderID", order.ID))
logger.Info("Processing order")
if err := validateOrder(order); err != nil {
logger.Error("Failed to validate order", zap.Error(err))
return err
}
logger.Info("Order processed successfully")
return nil
}
```
Install this rule for Windsurf
To set up rules for Windsurf Reviews, please see this documentation
Use Zap for all logging in Go code.
Bad:
```go
func processOrder(order Order) error {
fmt.Printf("Processing order %s\n", order.ID)
if err := validateOrder(order); err != nil {
log.Printf("Error validating order: %v", err)
return err
}
fmt.Println("Order processed successfully")
return nil
}
```
Good:
```go
func processOrder(order Order) error {
logger := zap.L().With(zap.String("orderID", order.ID))
logger.Info("Processing order")
if err := validateOrder(order); err != nil {
logger.Error("Failed to validate order", zap.Error(err))
return err
}
logger.Info("Order processed successfully")
return nil
}
```