prometheus/cadvisor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update API doc with new machine API output.

Browse Source
This commit is contained in:
Rohit Jnagal 2015-01-06 22:51:52 +00:00
parent 12289bdac5
commit bb02481289
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api.md
View File

@ -64,11 +64,15 @@ The actual object is the marshalled JSON of the `ContainerInfo` struct found in
The resource name for machine information is as follows:
`/api/v1.0/machine`
`/api/vX.Y/machine`
This resource is read-only. The machine information is returned as a JSON object containing:
- Number of schedulable logical CPU cores
- Memory capacity (in bytes)
- Maximum supported CPU frequency (in kHz)
- Available filesystems: major, minor numbers and capacity (in bytes)
- Network devices: mac addresses, MTU, and speed (if available)
- Machine topology: Nodes, cores, threads, per-node memory, and caches
The actual object is the marshalled JSON of the `MachineInfo` struct found in [info/machine.go](info/machine.go)