apache/beam

Support --verbose and/or --debug options so users don't have to tweak logging backend for basic output

Open

#18,695 opened on Jun 3, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4,097 forks)batch import
P3coregood first issuejavanew feature

Repository metrics

Stars
 (7,313 stars)
PR merge metrics
 (Avg merge 6d) (243 merged PRs in 30d)

Description

A good command line interface uses --verbose or --debug to control verbosity for users and contributors to get more info about what is going on in the program. Currently IIUC a user has to tweak JUL which is quite a poor experience and Java-centric rather than a good command line interface. We should add support for this alongside our other tools (like pipeline options parsing) for making it easy to build a pipeline main().

Note that this is for the construction & submission side / core SDK. Each runner has its own needs as far as how to control the worker logging, though it is probably still better to have a general way.

Imported from Jira BEAM-3475. Original Jira may contain additional context. Reported by: kenn.

Contributor guide

Research direction
Explore existing CLI argument parsing in Beam's pipeline options and JUL logging configuration to implement verbose and debug flags.
Tech stack
java
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Java
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65