feature: abctl: explanation of / (filter) function

Open Beginner friendly
#867 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
go
Domain
cli

Research direction

In the abctl TUI, locate the code that displays the / filter prompt and inspect how the prompt text is assembled. Update the wording so it explains that filtering matches substrings in METHOD values, then verify the prompt and existing filter behavior in the TUI.

Written by the indexing model from the issue text.

Description

nice to have
Feature Description

More TUI verbiage around what the / key, filter, which lets the user filter to a subset of events based on substring matches to the METHOD, does.

This isn't obvious. The TUI merely presents the string "filter..." and the user doesn't know what is happening. Some users expected a query language, to filter on something like DURATION > 5s.

Proposed Solution

Step 1 is to replace the filter ... prompt with something like METHOD name filter...

We can also discuss offering something like JQuery language to allow users to filter for e.g. DURATION > 5s.

Want to contribute?
  • I would like to work on this issue.
Additional Context

No response

Dominant language
Go
Stars
13
Forks
40
Avg merge
12h 9m
Merged PRs (30d)
164

Contributor guide

Open the contributing guide

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.

More from rossoctl/cortex

All issues in rossoctl/cortex

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.