influxdata / influxdata/influx-cli

Consolidate logging to a single style

Open
#110 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

tech-debt
Dominant language
Go
Stars
75
Forks
22
PR merge metrics
No merged PRs in 30d

Description

Various CLI commands & utilities currently use the global log module to write logs (typically warnings). A few other commands pseudo-log by writing strings starting with WARNING: to stderr.

We should use a single logging style in the CLI to assist users who want to process log outputs via automation. We tend to prefer zap for logging in our server-side products, though it may not be the best choice here.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inventorying the CLI commands and utilities that use the global log module or write WARNING: to stderr. Review the logging needs for automated log processing and determine a single style, including whether zap fits this CLI. Done means the CLI uses one consistent logging approach.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.