From 15f0622d33b35c449600bd89080e03247d22360c Mon Sep 17 00:00:00 2001 From: Sebastian Hildebrandt Date: Fri, 31 May 2019 23:55:31 +0200 Subject: [PATCH] dockerInfo() changed property naming style --- CHANGELOG.md | 1 + README.md | 92 +++++++++++++++---------------- docs/docker.html | 90 +++++++++++++++---------------- docs/history.html | 5 ++ docs/index.html | 2 +- lib/docker.js | 92 +++++++++++++++---------------- lib/index.d.ts | 134 ++++++++++++++++++++++++++++++---------------- 7 files changed, 231 insertions(+), 185 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d730970..16ba280 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,6 +30,7 @@ For major (breaking) changes - version 3 and 2 see end of page. | Version | Date | Comment | | -------------- | -------------- | -------- | +| 4.8.2 | 2019-05-31 | `dockerInfo()` changed property naming style | | 4.8.1 | 2019-05-31 | updated docs | | 4.8.0 | 2019-05-31 | added `vboxInfo()` detailed virtual box info | | 4.7.3 | 2019-05-30 | updated typescript typings | diff --git a/README.md b/README.md index fdb8875..b92f547 100644 --- a/README.md +++ b/README.md @@ -454,52 +454,52 @@ I also created a nice little command line tool called [mmon][mmon-github-url] ( | Function | Result object | Linux | BSD | Mac | Win | Sun | Comments | | --------------- | ------------- | ----- | ------- | --- | --- | --- | -------- | | si.dockerInfo(cb) | {...} | X | X | X | X | X | returns general docker info | -| | ID | X | X | X | X | X | Docker ID | -| | Containers | X | X | X | X | X | number of containers | -| | ContainersRunning | X | X | X | X | X | number of running containers | -| | ContainersPaused | X | X | X | X | X | number of paused containers | -| | ContainersStopped | X | X | X | X | X | number of stopped containers | -| | Images | X | X | X | X | X | number of images | -| | Driver | X | X | X | X | X | driver (e.g. 'devicemapper', 'overlay2') | -| | MemoryLimit | X | X | X | X | X | has memory limit | -| | SwapLimit | X | X | X | X | X | has swap limit | -| | KernelMemory | X | X | X | X | X | has kernal memory | -| | CpuCfsPeriod | X | X | X | X | X | has CpuCfsPeriod | -| | CpuCfsQuota | X | X | X | X | X | has CpuCfsQuota | -| | CPUShares | X | X | X | X | X | has CPUShares | -| | CPUSet | X | X | X | X | X | has CPUShares | -| | IPv4Forwarding | X | X | X | X | X | has IPv4Forwarding | -| | BridgeNfIptables | X | X | X | X | X | has BridgeNfIptables | -| | BridgeNfIp6tables | X | X | X | X | X | has BridgeNfIp6tables | -| | Debug | X | X | X | X | X | Debug on | -| | NFd | X | X | X | X | X | named data networking forwarding daemon | -| | OomKillDisable | X | X | X | X | X | out-of-memory kill disabled | -| | NGoroutines | X | X | X | X | X | number NGoroutines | -| | SystemTime | X | X | X | X | X | docker SystemTime | -| | LoggingDriver | X | X | X | X | X | logging driver e.g. 'json-file' | -| | CgroupDriver | X | X | X | X | X | cgroup driver e.g. 'cgroupfs' | -| | NEventsListener | X | X | X | X | X | number NEventsListeners | -| | KernelVersion | X | X | X | X | X | docker kernel version | -| | OperatingSystem | X | X | X | X | X | docker OS e.g. 'Docker for Mac' | -| | OSType | X | X | X | X | X | OSType e.g. 'linux' | -| | Architecture | X | X | X | X | X | architecture e.g. x86_64 | -| | NCPU | X | X | X | X | X | number of CPUs | -| | MemTotal | X | X | X | X | X | memory total | -| | DockerRootDir | X | X | X | X | X | docker root directory | -| | HttpProxy | X | X | X | X | X | http proxy | -| | HttpsProxy | X | X | X | X | X | https proxy | -| | NoProxy | X | X | X | X | X | NoProxy | -| | Name | X | X | X | X | X | Name | -| | Labels | X | X | X | X | X | array of labels | -| | ExperimentalBuild | X | X | X | X | X | is experimental build | -| | ServerVersion | X | X | X | X | X | server version | -| | ClusterStore | X | X | X | X | X | cluster store | -| | ClusterAdvertise | X | X | X | X | X | cluster advertise | -| | DefaultRuntime | X | X | X | X | X | default runtime e.g. 'runc' | -| | LiveRestoreEnabled | X | X | X | X | X | live store enabled | -| | Isolation | X | X | X | X | X | isolation | -| | InitBinary | X | X | X | X | X | init binary | -| | ProductLicense | X | X | X | X | X | product license | +| | id | X | X | X | X | X | Docker ID | +| | containers | X | X | X | X | X | number of containers | +| | containersRunning | X | X | X | X | X | number of running containers | +| | containersPaused | X | X | X | X | X | number of paused containers | +| | containersStopped | X | X | X | X | X | number of stopped containers | +| | images | X | X | X | X | X | number of images | +| | driver | X | X | X | X | X | driver (e.g. 'devicemapper', 'overlay2') | +| | memoryLimit | X | X | X | X | X | has memory limit | +| | swapLimit | X | X | X | X | X | has swap limit | +| | kernelMemory | X | X | X | X | X | has kernal memory | +| | cpuCfsPeriod | X | X | X | X | X | has CpuCfsPeriod | +| | cpuCfsQuota | X | X | X | X | X | has CpuCfsQuota | +| | cpuShares | X | X | X | X | X | has CPUShares | +| | cpuSet | X | X | X | X | X | has CPUShares | +| | ipv4Forwarding | X | X | X | X | X | has IPv4Forwarding | +| | bridgeNfIptables | X | X | X | X | X | has BridgeNfIptables | +| | bridgeNfIp6tables | X | X | X | X | X | has BridgeNfIp6tables | +| | debug | X | X | X | X | X | Debug on | +| | nfd | X | X | X | X | X | named data networking forwarding daemon | +| | oomKillDisable | X | X | X | X | X | out-of-memory kill disabled | +| | ngoroutines | X | X | X | X | X | number NGoroutines | +| | systemTime | X | X | X | X | X | docker SystemTime | +| | loggingDriver | X | X | X | X | X | logging driver e.g. 'json-file' | +| | cgroupDriver | X | X | X | X | X | cgroup driver e.g. 'cgroupfs' | +| | nEventsListener | X | X | X | X | X | number NEventsListeners | +| | kernelVersion | X | X | X | X | X | docker kernel version | +| | operatingSystem | X | X | X | X | X | docker OS e.g. 'Docker for Mac' | +| | osType | X | X | X | X | X | OSType e.g. 'linux' | +| | architecture | X | X | X | X | X | architecture e.g. x86_64 | +| | ncpu | X | X | X | X | X | number of CPUs | +| | memTotal | X | X | X | X | X | memory total | +| | dockerRootDir | X | X | X | X | X | docker root directory | +| | httpProxy | X | X | X | X | X | http proxy | +| | httpsProxy | X | X | X | X | X | https proxy | +| | noProxy | X | X | X | X | X | NoProxy | +| | name | X | X | X | X | X | Name | +| | labels | X | X | X | X | X | array of labels | +| | experimentalBuild | X | X | X | X | X | is experimental build | +| | serverVersion | X | X | X | X | X | server version | +| | clusterStore | X | X | X | X | X | cluster store | +| | clusterAdvertise | X | X | X | X | X | cluster advertise | +| | defaultRuntime | X | X | X | X | X | default runtime e.g. 'runc' | +| | liveRestoreEnabled | X | X | X | X | X | live store enabled | +| | isolation | X | X | X | X | X | isolation | +| | initBinary | X | X | X | X | X | init binary | +| | productLicense | X | X | X | X | X | product license | | si.dockerContainers(all, cb) | [{...}] | X | X | X | X | X | returns array of active/all docker containers | | | [0].id | X | X | X | X | X | ID of container | | | [0].name | X | X | X | X | X | name of container | diff --git a/docs/docker.html b/docs/docker.html index 7ec2cbc..0e8d936 100644 --- a/docs/docker.html +++ b/docs/docker.html @@ -77,7 +77,7 @@ - ID + id X X X @@ -87,7 +87,7 @@ - Containers + containers X X X @@ -97,7 +97,7 @@ - ContainersRunning + containersRunning X X X @@ -107,7 +107,7 @@ - ContainersPaused + containersPaused X X X @@ -117,7 +117,7 @@ - ContainersStopped + containersStopped X X X @@ -127,7 +127,7 @@ - Images + images X X X @@ -137,7 +137,7 @@ - Driver + driver X X X @@ -147,7 +147,7 @@ - MemoryLimit + memoryLimit X X X @@ -167,7 +167,7 @@ - KernelMemory + kernelMemory X X X @@ -177,7 +177,7 @@ - CpuCfsPeriod + cpuCfsPeriod X X X @@ -187,7 +187,7 @@ - CpuCfsQuota + cpuCfsQuota X X X @@ -197,7 +197,7 @@ - CPUShares + cpuShares X X X @@ -207,7 +207,7 @@ - CPUSet + cpuSet X X X @@ -217,7 +217,7 @@ - IPv4Forwarding + ipv4Forwarding X X X @@ -227,7 +227,7 @@ - BridgeNfIptables + bridgeNfIptables X X X @@ -237,7 +237,7 @@ - BridgeNfIp6tables + bridgeNfIp6tables X X X @@ -247,7 +247,7 @@ - Debug + debug X X X @@ -257,7 +257,7 @@ - NFd + nfd X X X @@ -267,7 +267,7 @@ - OomKillDisable + oomKillDisable X X X @@ -277,7 +277,7 @@ - NGoroutines + ngoroutines X X X @@ -287,7 +287,7 @@ - SystemTime + systemTime X X X @@ -297,7 +297,7 @@ - LoggingDriver + loggingDriver X X X @@ -307,7 +307,7 @@ - CgroupDriver + cgroupDriver X X X @@ -317,7 +317,7 @@ - NEventsListener + nEventsListener X X X @@ -327,7 +327,7 @@ - KernelVersion + kernelVersion X X X @@ -337,7 +337,7 @@ - OperatingSystem + operatingSystem X X X @@ -347,7 +347,7 @@ - OSType + osType X X X @@ -357,7 +357,7 @@ - Architecture + architecture X X X @@ -367,7 +367,7 @@ - NCPU + ncpu X X X @@ -377,7 +377,7 @@ - MemTotal + memTotal X X X @@ -387,7 +387,7 @@ - DockerRootDir + dockerRootDir X X X @@ -397,7 +397,7 @@ - HttpProxy + httpProxy X X X @@ -407,7 +407,7 @@ - HttpsProxy + httpsProxy X X X @@ -417,7 +417,7 @@ - NoProxy + noProxy X X X @@ -427,7 +427,7 @@ - Name + name X X X @@ -437,7 +437,7 @@ - Labels + labels X X X @@ -447,7 +447,7 @@ - ExperimentalBuild + experimentalBuild X X X @@ -457,7 +457,7 @@ - ServerVersion + serverVersion X X X @@ -467,7 +467,7 @@ - ClusterStore + clusterStore X X X @@ -477,7 +477,7 @@ - ClusterAdvertise + clusterAdvertise X X X @@ -487,7 +487,7 @@ - DefaultRuntime + defaultRuntime X X X @@ -497,7 +497,7 @@ - LiveRestoreEnabled + liveRestoreEnabled X X X @@ -507,7 +507,7 @@ - Isolation + isolation X X X @@ -517,7 +517,7 @@ - InitBinary + initBinary X X X @@ -527,7 +527,7 @@ - ProductLicense + productLicense X X X diff --git a/docs/history.html b/docs/history.html index 23f9ff2..0dba2c1 100644 --- a/docs/history.html +++ b/docs/history.html @@ -80,6 +80,11 @@ + + 4.8.2 + 2019-05-31 + dockerInfo() changed property naming style + 4.8.1 2019-05-31 diff --git a/docs/index.html b/docs/index.html index c165797..af9bca8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -170,7 +170,7 @@
systeminformation
-
Current Version: 4.8.1
+
Current Version: 4.8.2
diff --git a/lib/docker.js b/lib/docker.js index 9447324..9073e33 100644 --- a/lib/docker.js +++ b/lib/docker.js @@ -36,52 +36,52 @@ function dockerInfo(callback) { const result = {}; _docker_socket.getInfo(data => { - result.ID = data.ID; - result.Containers = data.Containers; - result.ContainersRunning = data.ContainersRunning; - result.ContainersPaused = data.ContainersPaused; - result.ContainersStopped = data.ContainersStopped; - result.Images = data.Images; - result.Driver = data.Driver; - result.MemoryLimit = data.MemoryLimit; - result.SwapLimit = data.SwapLimit; - result.KernelMemory = data.KernelMemory; - result.CpuCfsPeriod = data.CpuCfsPeriod; - result.CpuCfsQuota = data.CpuCfsQuota; - result.CPUShares = data.CPUShares; - result.CPUSet = data.CPUSet; - result.IPv4Forwarding = data.IPv4Forwarding; - result.BridgeNfIptables = data.BridgeNfIptables; - result.BridgeNfIp6tables = data.BridgeNfIp6tables; - result.Debug = data.Debug; - result.NFd = data.NFd; - result.OomKillDisable = data.OomKillDisable; - result.NGoroutines = data.NGoroutines; - result.SystemTime = data.SystemTime; - result.LoggingDriver = data.LoggingDriver; - result.CgroupDriver = data.CgroupDriver; - result.NEventsListener = data.NEventsListener; - result.KernelVersion = data.KernelVersion; - result.OperatingSystem = data.OperatingSystem; - result.OSType = data.OSType; - result.Architecture = data.Architecture; - result.NCPU = data.NCPU; - result.MemTotal = data.MemTotal; - result.DockerRootDir = data.DockerRootDir; - result.HttpProxy = data.HttpProxy; - result.HttpsProxy = data.HttpsProxy; - result.NoProxy = data.NoProxy; - result.Name = data.Name; - result.Labels = data.Labels; - result.ExperimentalBuild = data.ExperimentalBuild; - result.ServerVersion = data.ServerVersion; - result.ClusterStore = data.ClusterStore; - result.ClusterAdvertise = data.ClusterAdvertise; - result.DefaultRuntime = data.DefaultRuntime; - result.LiveRestoreEnabled = data.LiveRestoreEnabled; - result.Isolation = data.Isolation; - result.InitBinary = data.InitBinary; - result.ProductLicense = data.ProductLicense; + result.id = data.ID; + result.containers = data.Containers; + result.containersRunning = data.ContainersRunning; + result.containersPaused = data.ContainersPaused; + result.containersStopped = data.ContainersStopped; + result.images = data.Images; + result.driver = data.Driver; + result.memoryLimit = data.MemoryLimit; + result.swapLimit = data.SwapLimit; + result.kernelMemory = data.KernelMemory; + result.cpuCfsPeriod = data.CpuCfsPeriod; + result.cpuCfsQuota = data.CpuCfsQuota; + result.cpuShares = data.CPUShares; + result.cpuSet = data.CPUSet; + result.ipv4Forwarding = data.IPv4Forwarding; + result.bridgeNfIptables = data.BridgeNfIptables; + result.bridgeNfIp6tables = data.BridgeNfIp6tables; + result.debug = data.Debug; + result.nfd = data.NFd; + result.oomKillDisable = data.OomKillDisable; + result.ngoroutines = data.NGoroutines; + result.systemTime = data.SystemTime; + result.loggingDriver = data.LoggingDriver; + result.cgroupDriver = data.CgroupDriver; + result.nEventsListener = data.NEventsListener; + result.kernelVersion = data.KernelVersion; + result.pperatingSystem = data.OperatingSystem; + result.osType = data.OSType; + result.architecture = data.Architecture; + result.ncpu = data.NCPU; + result.memTotal = data.MemTotal; + result.dockerRootDir = data.DockerRootDir; + result.httpProxy = data.HttpProxy; + result.httpsProxy = data.HttpsProxy; + result.noProxy = data.NoProxy; + result.name = data.Name; + result.labels = data.Labels; + result.experimentalBuild = data.ExperimentalBuild; + result.serverVersion = data.ServerVersion; + result.clusterStore = data.ClusterStore; + result.clusterAdvertise = data.ClusterAdvertise; + result.defaultRuntime = data.DefaultRuntime; + result.liveRestoreEnabled = data.LiveRestoreEnabled; + result.isolation = data.Isolation; + result.initBinary = data.InitBinary; + result.productLicense = data.ProductLicense; if (callback) { callback(result); } resolve(result); }); diff --git a/lib/index.d.ts b/lib/index.d.ts index dd7fe88..a6c597c 100644 --- a/lib/index.d.ts +++ b/lib/index.d.ts @@ -422,52 +422,52 @@ export namespace Systeminformation { // 8. Docker interface DockerInfoData { - ID: string; - Containers: number; - ContainersRunning: number; - ContainersPaused: number; - ContainersStopped: number; - Images: number; - Driver: string; - MemoryLimit: boolean; - SwapLimit: boolean; - KernelMemory: boolean; - CpuCfsPeriod: boolean; - CpuCfsQuota: boolean; - CPUShares: boolean; - CPUSet: boolean; - IPv4Forwarding: boolean; - BridgeNfIptables: boolean; - BridgeNfIp6tables: boolean; - Debug: boolean; - NFd: number; - OomKillDisable: boolean; - NGoroutines: number; - SystemTime: string; - LoggingDriver: string; - CgroupDriver: string; - NEventsListener: number; - KernelVersion: string; - OperatingSystem: string; - OSType: string; - Architecture: string; - NCPU: number; - MemTotal: number; - DockerRootDir: string; - HttpProxy: string; - HttpsProxy: string; - NoProxy: string; - Name: string; - Labels: string[]; - ExperimentalBuild: boolean; - ServerVersion: string; - ClusterStore: string; - ClusterAdvertise: string; - DefaultRuntime: string; - LiveRestoreEnabled: boolean; - Isolation: string; - InitBinary: string; - ProductLicense: string; + id: string; + containers: number; + containersRunning: number; + containersPaused: number; + containersStopped: number; + images: number; + driver: string; + memoryLimit: boolean; + swapLimit: boolean; + kernelMemory: boolean; + cpuCfsPeriod: boolean; + cpuCfsQuota: boolean; + cpuShares: boolean; + cpuSet: boolean; + ipv4Forwarding: boolean; + bridgeNfIptables: boolean; + bridgeNfIp6tables: boolean; + debug: boolean; + mfd: number; + oomKillDisable: boolean; + ngoroutines: number; + systemTime: string; + loggingDriver: string; + cgroupDriver: string; + nEventsListener: number; + kernelVersion: string; + operatingSystem: string; + osType: string; + architecture: string; + ncpu: number; + memTotal: number; + dockerRootDir: string; + httpProxy: string; + httpsProxy: string; + noProxy: string; + name: string; + labels: string[]; + experimentalBuild: boolean; + serverVersion: string; + clusterStore: string; + clusterAdvertise: string; + defaultRuntime: string; + liveRestoreEnabled: boolean; + isolation: string; + initBinary: string; + productLicense: string; } interface DockerContainerData { @@ -520,7 +520,45 @@ export namespace Systeminformation { networks: any; } - // 9. "Get All at once" - functions + // 9. Virtual Box + + interface VboxInfoData { + id: string; + name: string; + running: boolean; + runningSince: number; + guestOS: string; + hardwareUUID: string; + memory: number; + vram: number; + cpus: number; + cpuExepCap: string; + cpuProfile: string; + chipset: string; + firmware: string; + pageFusion: boolean; + configFile: string; + snapshotFolder: string; + logFolder: string; + HPET: boolean; + PAE: boolean; + longMode: boolean; + tripleFaultReset: boolean; + APIC: boolean; + X2APIC: boolean; + ACPI: boolean; + IOAPIC: boolean; + biosAPICmode: string; + bootMenuMode: string; + bootDevice1: string; + bootDevice2: string; + bootDevice3: string; + bootDevice4: string; + timeOffset: string; + RTC: string; + } + + // 10. "Get All at once" - functions interface StaticData { version: string; @@ -593,6 +631,8 @@ export function dockerContainerStats(id?: string, cb?: (data: Systeminformation. export function dockerContainerProcesses(id?: string, cb?: (data: any) => any): Promise; export function dockerAll(cb?: (data: any) => any): Promise; +export function vboxInfo(cb?: (data: Systeminformation.VboxInfoData[]) => any): Promise; + export function getStaticData(cb?: (data: Systeminformation.StaticData) => any): Promise; export function getDynamicData(srv?: string, iface?: string, cb?: (data: any) => any): Promise; export function getAllData(srv?: string, iface?: string, cb?: (data: any) => any): Promise;