From a87e3850b9240900bca295ad9c4b2e49d0068e98 Mon Sep 17 00:00:00 2001 From: Daniel Templeton Date: Tue, 7 Feb 2017 16:39:22 -0800 Subject: [PATCH] YARN-6135. Node manager REST API documentation is not up to date (Contributed by Miklos Szegedi via Daniel Templeton) --- .../src/site/markdown/NodeManagerRest.md | 108 ++++++++++++------ 1 file changed, 75 insertions(+), 33 deletions(-) diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/NodeManagerRest.md b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/NodeManagerRest.md index c7600f0246b..26b21bec797 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/NodeManagerRest.md +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/NodeManagerRest.md @@ -64,7 +64,10 @@ Both of the following URI's give you the cluster information. | totalPmemAllocatedContainersMB | long | The amount of physical memory allocated for use by containers in MB | | totalVmemAllocatedContainersMB | long | The amount of virtual memory allocated for use by containers in MB | | totalVCoresAllocatedContainers | long | The number of virtual cores allocated for use by containers | +| vmemCheckEnabled | boolean | Whether virtual memory checking is enabled for preemption | +| pmemCheckEnabled | boolean | Whether physical memory checking is enabled for preemption | | lastNodeUpdateTime | long | The last timestamp at which the health report was received (in ms since epoch) | +| nmStartupTime | long | The timestamp at which the node was started (in ms since epoch) | | healthReport | string | The diagnostic health report of the node | | nodeHealthy | boolean | true/false indicator of if the node is healthy | | nodeManagerVersion | string | Version of the NodeManager | @@ -93,23 +96,27 @@ Response Body: ```json { - "nodeInfo" : { - "hadoopVersionBuiltOn" : "Mon Jan 9 14:58:42 UTC 2012", - "nodeManagerBuildVersion" : "0.23.1-SNAPSHOT from 1228355 by user1 source checksum 20647f76c36430e888cc7204826a445c", - "lastNodeUpdateTime" : 1326222266126, - "totalVmemAllocatedContainersMB" : 17203, - "totalVCoresAllocatedContainers" : 8, - "nodeHealthy" : true, - "healthReport" : "", - "totalPmemAllocatedContainersMB" : 8192, - "nodeManagerVersionBuiltOn" : "Mon Jan 9 15:01:59 UTC 2012", - "nodeManagerVersion" : "0.23.1-SNAPSHOT", - "id" : "host.domain.com:8041", - "hadoopBuildVersion" : "0.23.1-SNAPSHOT from 1228292 by user1 source checksum 3eba233f2248a089e9b28841a784dd00", - "nodeHostName" : "host.domain.com", - "hadoopVersion" : "0.23.1-SNAPSHOT" - } + "nodeInfo": { + "healthReport": "", + "totalVmemAllocatedContainersMB": 17203, + "totalPmemAllocatedContainersMB": 8192, + "totalVCoresAllocatedContainers": 8, + "vmemCheckEnabled": false, + "pmemCheckEnabled": true, + "lastNodeUpdateTime": 1485814574224, + "nodeHealthy": true, + "nodeManagerVersion": "3.0.0", + "nodeManagerBuildVersion": "3.0.0", + "nodeManagerVersionBuiltOn": "2017-01-30T17:42Z", + "hadoopVersion": "3.0.0", + "hadoopBuildVersion": "3.0.0", + "hadoopVersionBuiltOn": "2017-01-30T17:39Z", + "id": "host.domain.com:46077", + "nodeHostName": "host.domain.com", + "nmStartupTime": 1485800887841 + } } + ``` **XML response** @@ -131,20 +138,23 @@ Response Body: ```xml - - 17203 - 8192 - 8 - 1326222386134 - true - 0.23.1-SNAPSHOT - 0.23.1-SNAPSHOT from 1228355 by user1 source checksum 20647f76c36430e888cc7204826a445c - Mon Jan 9 15:01:59 UTC 2012 - 0.23.1-SNAPSHOT - 0.23.1-SNAPSHOT from 1228292 by user1 source checksum 3eba233f2248a089e9b28841a784dd00 - Mon Jan 9 14:58:42 UTC 2012 - host.domain.com:8041 - host.domain.com + + 17203 + 8192 + 8 + false + true + 1485815774203 + true + 3.0.0 + 3.0.0 + 2017-01-30T17:42Z + 3.0.0 + 3.0.0 + 2017-01-30T17:39Z + host.domain.com:46077 + host.domain.com + 1485800887841 ``` @@ -391,7 +401,13 @@ Response Body: "containerLogsLink" : "http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000001/user1", "user" : "user1", "id" : "container_1326121700862_0006_01_000001", - "exitCode" : -1000 + "exitCode" : -1000, + "executionType": "GUARANTEED", + "containerLogFiles": [ + "stdout", + "stderr", + "syslog" + ] }, { "nodeId" : "host.domain.com:8041", @@ -402,7 +418,13 @@ Response Body: "containerLogsLink" : "http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000003/user1", "user" : "user1", "id" : "container_1326121700862_0006_01_000003", - "exitCode" : -1000 + "exitCode" : -1000, + "executionType": "GUARANTEED", + "containerLogFiles": [ + "stdout", + "stderr", + "syslog" + ] } ] } @@ -438,6 +460,10 @@ Response Body: 1 http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000001/user1 host.domain.com:8041 + GUARANTEED + stdout + stderr + syslog container_1326121700862_0006_01_000003 @@ -449,6 +475,10 @@ Response Body: 2 http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000003/user1 host.domain.com:8041 + GUARANTEED + stdout + stderr + syslog ``` @@ -485,6 +515,8 @@ Use the following URI to obtain a Container Object, from a container identified | diagnostics | string | A diagnostic message for failed containers | | totalMemoryNeededMB | long | Total amout of memory needed by the container (in MB) | | totalVCoresNeeded | long | Total number of virtual cores needed by the container | +| executionType | string | Container type of GUARANTEED or OPPORTUNISTIC | +| containerLogFiles | array of strings | Container log file names | ### Response Examples @@ -514,7 +546,13 @@ Response Body: "containerLogsLink" : "http://host.domain.com:8042/node/containerlogs/container_1326121700862_0007_01_000001/user1", "user" : "user1", "id" : "container_1326121700862_0007_01_000001", - "exitCode" : -1000 + "exitCode" : -1000, + "executionType": "GUARANTEED", + "containerLogFiles": [ + "stdout", + "stderr", + "syslog" + ] } } ``` @@ -547,5 +585,9 @@ Response Body: 1 http://host.domain.com:8042/node/containerlogs/container_1326121700862_0007_01_000001/user1 host.domain.com:8041 + GUARANTEED + stdout + stderr + syslog ```