apple / apple/container

[Request]: Subcommand for validating system health.

Open
#381 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Swift
Stars
49.9k
Forks
1.8k
Avg merge
1d 20h
Merged PRs (30d)
22

Description

### Feature or enhancement request details

As a container user, I can run a CLI command to check system health, report any issues that could impair functionality, and suggest recovery steps where possible, so that I can readily identify and fix problems.

The scope of this feature is:

- Human friendly output
- Brief check only
- Ensure API server is running, and return `true` for overall health, along with version and the app data root path.

Over time, this check could include:
- Structured output via `--format` option.
- Creating a troubleshooting.md document for issue identification and remediation procedures.
- Plugin summary.
- To address the difficulty in reporting issues that occur after a CLI command detaches from the container services, collect warnings and errors from system logs. Structured log messages could include a field containing an anchor id into the troubleshooting doc.
- Ensuring are helpers are running and responsive.

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct

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.