617 lines
21 KiB
HTML
617 lines
21 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
|
|
<head>
|
|
<!-- Required meta tags -->
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
|
|
|
|
<!-- CSS -->
|
|
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
|
|
<link rel="stylesheet" href="https://pro.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-LRlmVvLKVApDVGuspQFnRQJjkv0P7/YFrw84YYQtmYG4nK8c+M+NlmYDCv0rKWpG" crossorigin="anonymous">
|
|
<link rel="stylesheet" href="styles.css">
|
|
<script src="main.js"></script>
|
|
|
|
<!-- Favicon -->
|
|
<link rel="icon" type="image/png" sizes="192x192" href="/assets/android-icon-192x192.png">
|
|
<link rel="icon" type="image/png" sizes="32x32" href="/assets/favicon-32x32.png">
|
|
<link rel="icon" type="image/png" sizes="96x96" href="/assets/favicon-96x96.png">
|
|
<link rel="icon" type="image/png" sizes="16x16" href="/assets/favicon-16x16.png">
|
|
|
|
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/default.min.css">
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
|
|
<title>systeminformation</title>
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<nav class="nav">
|
|
<div class="container">
|
|
<a href="."><img class="logo float-left" src="assets/logo.png">
|
|
<div class="title float-left">systeminformation</div>
|
|
</a>
|
|
<div class="text float-right github"><a href="https://github.com/sebhildebrandt/systeminformation">View on Github <i class="fab fa-github"></i></a></div>
|
|
<div class="text float-right todocs"><a href="./#docs">Docs Overview</a></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section class="container">
|
|
<div class="row">
|
|
<div class="col-12 col-md-4 col-lg-3 col-xl-2 menu" id="menu">
|
|
</div>
|
|
<div class="col-12 col-md-8 col-lg-9 col-xl-10 content">
|
|
<div class="row">
|
|
<div class="col-12 sectionheader">
|
|
<div class="title">Docker</div>
|
|
<div class="text">
|
|
<p>In this section you will learn how to get information about docker containers, stats and processes inside a docker container:</p>
|
|
<p>For function reference and examples we assume, that we imported <span class="code">systeminformation</span> as follows:</p>
|
|
<pre><code class="js">const si = require('systeminformation');</code></pre>
|
|
<h2>Container, Stats, Processes</h2>
|
|
<p>All functions in this section return a promise or can be called with a callback function (parameter <span class="code">cb</span> in the function reference)</p>
|
|
<table class="table table-sm table-bordered table-striped">
|
|
<thead>
|
|
<tr>
|
|
<th>Function</th>
|
|
<th>Result object</th>
|
|
<th>Linux</th>
|
|
<th>BSD</th>
|
|
<th>Mac</th>
|
|
<th>Win</th>
|
|
<th>Sun</th>
|
|
<th>Comments</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>si.dockerContainers(all, cb)</td>
|
|
<td>[{...}]</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>returns array of active/all docker containers</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].id</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>ID of container</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].name</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>name of container</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].image</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>name of image</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].imageID</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>ID of image</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].command</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>command</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].created</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>creation time (unix time)</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].started</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>started time (unix time)</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].finished</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>finished time (unix time)</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].createdAt</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>creation date time string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].startedAt</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>creation date time string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].finishedAt</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>creation date time string</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].state</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>created, running, exited</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].restartCount</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>restart count</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].platform</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>e.g. linux</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].driver</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>e.g. overlay2 or devicemapper</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].ports</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>array of ports</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].mounts</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>array of mounts</td>
|
|
</tr>
|
|
<tr>
|
|
<td>si.dockerContainerStats(ids, cb)</td>
|
|
<td>[{...}]</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>statistics for specific containers<br>container IDs: space or comma separated,<br>pass '*' for all containers</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>id</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>Container ID</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>mem_usage</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>memory usage in bytes</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>mem_limit</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>memory limit (max mem) in bytes</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>mem_percent</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>memory usage in percent</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>cpu_percent</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>cpu usage in percent</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>pids</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>number of processes</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>netIO.rx</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>received bytes via network</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>netIO.wx</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>sent bytes via network</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>blockIO.r</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>bytes read from BlockIO</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>blockIO.w</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>bytes written to BlockIO</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>restartCount</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>restart count</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>cpu_stats</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>detailed cpu stats</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>percpu_stats</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>detailed per cpu stats</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>memory_stats</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>detailed memory stats</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>networks</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>detailed network stats per interface</td>
|
|
</tr>
|
|
<tr>
|
|
<td>si.dockerContainerProcesses(id, cb)</td>
|
|
<td>[{...}]</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>array of processes inside a container</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].pid_host</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>process ID (host)</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].ppid</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>parent process ID</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].pgid</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>process group ID</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].user</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>effective user name</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].ruser</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>real user name</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].group</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>effective group name</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].rgroup</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>real group name</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].stat</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>process state</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].time</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>accumulated CPU time</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].elapsed</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>elapsed running time</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].nice</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>nice value</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].rss</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>resident set size</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].vsz</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>virtual size in Kbytes</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>[0].command</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>command and arguments</td>
|
|
</tr>
|
|
<tr>
|
|
<td>si.dockerAll(cb)</td>
|
|
<td>{...}</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>X</td>
|
|
<td>list of all containers including their stats<br />and processes in one single array</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<footer class="container-fluid">
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-lg-4 col-12">
|
|
<ul class="list-unstyled">
|
|
<li><a href=".">Home</a></li>
|
|
<li><a href="https://github.com/sebhildebrandt/systeminformation">Github <i class="fab fa-github"></i></a></li>
|
|
<li><a href="contributors.html">Contributors</a></li>
|
|
<li><a href="https://buymeacoff.ee/systeminfo">Buy me a coffee</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="col-lg-4 col-12">
|
|
<ul class="list-unstyled">
|
|
<li><a href="gettingstarted.html">Quick Start</a></li>
|
|
<li><a href="issues.html">Known Issues</a></li>
|
|
<li><a href="statsfunctions.html">Stats Functions</a></li>
|
|
<li><a href="history.html">Version history</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="col-lg-4 col-12">
|
|
<ul class="list-unstyled">
|
|
<li><a href="https://www.plus-innovations.com">© 2019 Sebastian Hildebrandt, +innovations</a></li>
|
|
<li><a href="copyright.html">Copyright & License</a></li>
|
|
<li><a href="trademarks.html">Trademarks</a></li>
|
|
<li><a href="https://github.com/sebhildebrandt/systeminformation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT license" /></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</footer>
|
|
|
|
<script>
|
|
window.onload = function (e) {
|
|
createMenu();
|
|
}
|
|
</script>
|
|
</body>
|
|
|
|
</html>
|