NETWAYS / NETWAYS/go-check

[Feature Request] Generic output formatting with global format parameter

Open
#65 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
15
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Idea

Implement the output generating code in a way to have one or multiple parameters to specify the output formatting as a whole.

For example, some monitoring systems still use a single line as output, one might want to have output fitting on a pager or, and this is speculation for the future, properly machine readable output might be a thing.

Ideally, in the end I can do something like this:

# my_check --foo bar
[OK] all ok
  \_ [OK] bar

# my_check --foo bar --output one-line
[OK] all ok - [OK] bar


# my_check --foo bar --output whatever
ok - all ok : ok - bar

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 locating the code that generates monitoring-plugin output and determine how command-line parameters are parsed. Compare the current multiline example with the proposed one-line and custom formats; done means a global output-format parameter supports a defined set of formats with clear behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.