Page MenuHomeVyOS Platform
Create Task
Maniphest T4413

Add an API endpoint with basic system stats
Closed, ResolvedPublic
Actions

Description

The local UI and third-party clients will want to display a basic status page: host name, version, uptime, and basic CPU/RAM/storage consumption data.

Making multiple requests for it is both inconvenient for the programmer is also slower for the client program. We likely want an endpoints that provides that all in one response.

What I believe should be included:

  • VyOS version.
  • Host name.
  • Normalized CPU load.
  • RAM usage.
  • Storage stats.

A possible REST endpoint could be /status.

Details

Difficulty level
Unknown (require assessment)
Version
-
Why the issue appeared?
Will be filled on close
Is it a breaking change?
Perfectly compatible
Issue type
Improvement (missing useful functionality)

Event Timeline

dmbaturin created this task.May 5 2022, 7:33 AM
pasik added a subscriber: pasik.May 5 2022, 9:33 AM
jestabro added a comment.May 17 2022, 6:52 PM

An initial implementation has been provided to Andrew Moshensky for testing with the local UI.

jestabro added a comment.EditedMay 17 2022, 9:04 PM

Details of adding a query such as this (20 lines of meaningful code/50 of boilerplate):
https://github.com/vyos/vyos-1x/commit/b62f5df2c796d0567b370e27fcec2005a02a4cd3

jestabro closed this task as Resolved.Aug 16 2022, 1:21 PM
jestabro moved this task from Need Triage to Finished on the VyOS 1.4 Sagitta board.