https://github.com/balena-io-modules/device-diagnostics

on-device diagnostics tool
https://github.com/balena-io-modules/device-diagnostics

Last synced: 7 days ago
JSON representation

on-device diagnostics tool

• Host: GitHub
• URL: https://github.com/balena-io-modules/device-diagnostics
• Owner: balena-io-modules
• Created: 2016-08-02T17:17:17.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-24T13:58:46.000Z (7 months ago)
• Last Synced: 2024-04-25T13:51:13.390Z (7 months ago)
• Language: Shell
• Homepage:
• Size: 943 KB
• Stars: 9
• Watchers: 15
• Forks: 8
• Open Issues: 38
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# Device-diagnostics

## Usage

The diagnostics commands are triggered remotely via balenaCloud. Navigate to

`https://dashboard.balena-cloud.com/devices/{{UUID}}/diagnostics` to run and view the output.  Only

[multicontainer-capable devices (balenaOS v2.12.0 or higher)](https://www.balena.io/docs/learn/develop/multicontainer/)

are fully supported and tested (see https://github.com/balena-io/device-diagnostics/issues/126 for more discussion).

## Hacking

### Checks

To add more checks, first define the check function and then add the function to the `run_checks()` function in `checks.sh`.

Checks should be fail-first, and defensive when possible. If a failing check will emit stderr, it is better to redirect

away rather than allowing it to propagate through. All numerics should be declared as such if possible.

Additionally, all checks should be documented in [diagnostics.md](diagnostics.md).

### Diagnostic commands

To add more commands, simply add the command  to the `commands` array in `diagnose.sh`. Additionally, all comands should be documented in [device-diagnostics.md](diagnostics.md#device-diagnostics).

### Supervisor Diagnostic commands

Supervisor state diagnostics are documented in [supervisor-state.md](diagnostics.md#supervisor-state).