uber-go/zap

Dev: Colored console output

Open

#489 opened on Aug 15, 2017

View on GitHub
 (10 comments) (28 reactions) (0 assignees)Go (22,391 stars) (1,448 forks)batch import
help wanted

Description

We should color the output under the development config for better readability in a console.

Some ideas,

  • Color log lines based on levels
  • Use a muted color for stack traces belonging to vendored dependencies and something brighter for the main application
  • Color keys and values for key-value pairs differently

Contributor guide

Tech stack
go
Domain
backenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic GoFamiliarity with zap's configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the existing console encoder in zapcore to understand how output is formatted. Look into adding color based on log levels (e.g., red for errors, yellow for warnings) and consider using different colors for stack traces from vendored dependencies vs. application code. The issue mentions key value pair coloring; explore using ANSI escape codes. Check comments for any prior discussion or partial implementations.