Page MenuHomeVyOS Platform

Add an API endpoint with basic system stats
Open, Requires assessmentPublic

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

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

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