improvements to CLI and new debug features #448

Merged

lx merged 9 commits from cli-improvements into main 2023-01-02 12:42:24 +00:00

Conversation 1 Commits 9 Files changed 24 +725 -190

lx commented 2022-12-13 10:50:58 +00:00

Owner

Copy link

CLI UX:

• Remove info and warning messages before the CLI does its thing, including when rpc_public_addr is not set
• Worker list is an actual table now
• New command worker info
• Rename resync-n-workers into resync-worker-count
• Improve status command with more info, including info from scrub/resync/etc - or put some of that in garage stats
• Something about paused scrubs resuming automatically / or don't resume automatically but show a warning everywhere during duration of pause
• prettier table in garage stats
• more things in garage stats

CLI debug features:

• garage block list-errors -> table of resync errored blocks, with (hash, rc, number of errors, time of last error/time of retry)
• garage block info <block> -> info about any block, including all objects that use it
• garage block retry-now [<hash> | ---all] -> retry resync of a block in errored status
• garage block purge <block>... -> delete all objects that reference a lost block

Non-CLI related:

• resync worker, use error! instead of warn! for "error when resyncing" block messages
• table lengths in metrics, if possible to have them fast (i.e. not with Sled)

CLI UX: - [x] Remove info and warning messages before the CLI does its thing, including when rpc_public_addr is not set - [x] Worker list is an actual table now - [x] New command `worker info` - [x] Rename `resync-n-workers` into `resync-worker-count` - [ ] Improve status command with more info, including info from scrub/resync/etc - or put some of that in garage stats - [ ] Something about paused scrubs resuming automatically / or don't resume automatically but show a warning everywhere during duration of pause - [x] prettier table in `garage stats` - [ ] more things in `garage stats` CLI debug features: - [x] `garage block list-errors` -> table of resync errored blocks, with (hash, rc, number of errors, time of last error/time of retry) - [x] `garage block info <block>` -> info about any block, including all objects that use it - [x] `garage block retry-now [<hash> | ---all]` -> retry resync of a block in errored status - [x] `garage block purge <block>...` -> delete all objects that reference a lost block Non-CLI related: - [x] resync worker, use `error!` instead of `warn!` for "error when resyncing" block messages - [x] table lengths in metrics, if possible to have them fast (i.e. not with Sled)

lx added 2 commits 2022-12-13 10:50:58 +00:00

Prettier worker list table; remove useless CLI log messages de9d6cddf7

cli: rename resync-n-workers into resync-worker-count a51e8d94c6

lx added 1 commit 2022-12-13 11:24:46 +00:00

cli: new worker info command 9d82196945

lx added 1 commit 2022-12-13 13:24:01 +00:00

Implement block list-errors and block info 687660b27f

lx added 1 commit 2022-12-13 14:02:58 +00:00

Implement block retry-now and block purge d7f90cabb0

lx added 1 commit 2022-12-13 14:43:35 +00:00

cli: prettier table in garage stats d6040e32a6

lx added 1 commit 2022-12-13 14:46:24 +00:00

cli: more info displayed on error in garage stats f8d5409894

lx added 1 commit 2022-12-13 14:54:19 +00:00

Add block.rc_size, table.size and table.merkle_tree_size metrics 041b60ed1d

lx added 1 commit 2022-12-13 15:18:08 +00:00

Fix error messages d1279e04f3

kaiyou commented 2022-12-25 12:36:58 +00:00

Contributor

Copy link

Quick feedback on the debug features (block list-errors & block info) and tabular display: been using on a production cluster them for debugging for the past week, with zero issue.

Quick feedback on the debug features (block list-errors & block info) and tabular display: been using on a production cluster them for debugging for the past week, with zero issue.

lx changed title from WIP: improvements to CLI and new debug features to improvements to CLI and new debug features 2023-01-02 12:42:13 +00:00

lx merged commit 7f7d53cfa9 into main 2023-01-02 12:42:24 +00:00

lx referenced this pull request from a commit 2023-01-02 12:42:25 +00:00

Merge pull request 'improvements to CLI and new debug features' (#448) from cli-improvements into main

lx deleted branch cli-improvements 2023-01-02 12:42:25 +00:00

Sign in to join this conversation.

Reviewers

No reviewers

Labels

Clear labels   

action

check-aws

The behaviour should be checked against AWS S3

  

action

discussion-needed

We need to discuss if the feature is desirable and/or better specify the envisioned behavior or technical implementation

  

action

for-external-contributors

Core team does not plan working on this in the near future however an external contribution will be reviewed & merged

  

action

for-newcomers

An issue that should be newcomer friendly.

  

action

more-info-needed

More information is needed to investigate this issue

  

action

need-funding

This issue represents lots of work, we need to find money to pay our core team work

  

action

triage-required

It's not very clear what we want to do with this issue yet, more thoughts is required

  

kind

correctness

Issues of theoretical correctness that may impact edge-case scenarios

  

kind

ideas

For abstract ideas/proposal to make Garage better, to better communicate our not yet achieved aims

  

kind

improvement

Feature requests that do not fall in other categories

  

kind

performance

Deceptive performance observed OR idea to improve performances

  

kind

testing

Functional tests, integration tests, Jepsen, etc.

  

kind

usability

Propositions to make Garage easier to operate, by improving error reporting, CLI, etc.

  

kind

wrong-behavior

Unintended behavior

  

prio

critical

Could impact integrity or availability of production clusters

  

prio

low

For issues that we don't want to spend time on until made absolutely necessary

  

scope

admin-api

Issues concerning the administration API

  

scope

background-healing

Background healing covers repair tasks, anti-entropy, merkle trees, etc. ; everything related to replicating data appropriately.

  

scope

build

Issues with Nix, Drone, Rust Compiler, etc.

  

scope

documentation

  

scope

k8s

Kubernetes related, including Helm Charts

  

scope

layout

Linked to the cluster layout and storage management

  

scope

metadata

Metadata Engine (LMDB, sqlite, etc.)

  

scope

ops

Operations related to operations/maintenance issue, tooling related (like CLI missing info ; impossible, too dangerous, too complicated migration, etc.)

  

scope

rpc

Linked to RPC

  

scope

s3-api

Related to the S3 API (especially compatibility issues).

  

scope

security

Cryptography-related, auth-related, authorization-related issues

  

scope

telemetry

OpenTelemetry (traces, metrics, etc.)

No labels

action

check-aws

action

discussion-needed

action

for-external-contributors

action

for-newcomers

action

more-info-needed

action

need-funding

action

triage-required

kind

correctness

kind

ideas

kind

improvement

kind

performance

kind

testing

kind

usability

kind

wrong-behavior

prio

critical

prio

low

scope

admin-api

scope

background-healing

scope

build

scope

documentation

scope

k8s

scope

layout

scope

metadata

scope

ops

scope

rpc

scope

s3-api

scope

security

scope

telemetry

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Deuxfleurs/garage#448

No description provided.