✨ Add system usage API endpoint

[linkdd]

Decision Record

The Docker CLI provides the command docker system df to see detailed disk space usage. This is backed by the engine API /system/df route (for more information, see this page).

In order to be able to report in Netbox the disk space usage of a host (in a Pie chart?), the agent need to be able to aggregate those information, hence the new /system/usage API endpoint.

Example response:

{
  "layers_size": 12321486189,
  "images": {
    "shared_size": 11717122867,
    "size": 21761376867,
    "virtual_size": 21761376867
  },
  "containers": {
    "size_rootfs": 1645637288
  },
  "volumes": 154790360,
  "build_cache": 14563481423
}

NB: Sizes are in "bytes".

A chart using ApexCharts has been added on the UI to visualize the data:

Changes

• 🚚 Rename/reorganize nodes in API - GET tab for readability
• ✨ Add /system/usage API endpoint that returns aggregated disk space usage
• 🗃️ Add /system/usage endpoint to OpenAPI schema
• ➕ Add ApexCharts library to UI
• 💄 Visualize data on UI home page with a Pie chart
• 🔖 v0.32.0

[lvenier]

Thanks for PR. Here what I would have added or done :

• in the UI I would have have added a tab to report the values. No need to graph but just display.
• in openapi I would have added the api entry so we have the swagger file still up to date even if not perfect yet in term of body content.
• I'm not sure I would have added this in the "GET" tab. I would have put it in the "EXTRA" tab.

[lvenier]

Comments provided in the conversation