apache / apache/accumulo

Provide standard options for computer-readable output from admin tooling

Open
#6,391 1 comment 0 reactions 1 assignee Claimed by @ArbaazKhan1 View on GitHub
enhancement
Dominant language
Java
Stars
1.2k
Forks
487
Avg merge
4d 5h
Merged PRs (30d)
13

Description

Many tools display data in a custom human-readable format. The fate admin command, and the zookeeper commands, are two examples.

It would be very convenient if there were standard options for computer readable output, similar to git's `--porcelain` or gpg's `--with-colons` that guarantees the output is well formatted for computer readability. The awscli tool also does something similar by returning JSON output for most, if not all, of its commands.

If we did go with JSON as a standard, then we should be able to add `--json` to many commands, to output in JSON format. Alternatively, we could just try to ensure that all output is always computer readable, but that gets tricky if we're displaying data that might have newlines in it, or non-printable characters.

It may be the case that different command will need different computer-readable output formats and options, but it would be nice if we could standardize.

For this ticket, it would be sufficient to make any progress towards creating computer-readable output in the zookeeper utilities, the fate admin utility, or another similar tool, to demonstrate and set a convention for other tools. Then, follow-on tickets could be made to implement the same capability in additional tools.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.