big-data/hadoop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

YARN-6135. Node manager REST API documentation is not up to date (Contributed by Miklos Szegedi via Daniel Templeton)

Browse Source
This commit is contained in:
Daniel Templeton 2017-02-07 16:39:22 -08:00
parent 307ec58ffb
commit a87e3850b9
1 changed files with 75 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/NodeManagerRest.md
View File

@ -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
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<nodeInfo>
<healthReport/>
<totalVmemAllocatedContainersMB>17203</totalVmemAllocatedContainersMB>
<totalPmemAllocatedContainersMB>8192</totalPmemAllocatedContainersMB>
<totalVCoresAllocatedContainers>8</totalVCoresAllocatedContainers>
<lastNodeUpdateTime>1326222386134</lastNodeUpdateTime>
<nodeHealthy>true</nodeHealthy>
<nodeManagerVersion>0.23.1-SNAPSHOT</nodeManagerVersion>
<nodeManagerBuildVersion>0.23.1-SNAPSHOT from 1228355 by user1 source checksum 20647f76c36430e888cc7204826a445c</nodeManagerBuildVersion>
<nodeManagerVersionBuiltOn>Mon Jan 9 15:01:59 UTC 2012</nodeManagerVersionBuiltOn>
<hadoopVersion>0.23.1-SNAPSHOT</hadoopVersion>
<hadoopBuildVersion>0.23.1-SNAPSHOT from 1228292 by user1 source checksum 3eba233f2248a089e9b28841a784dd00</hadoopBuildVersion>
<hadoopVersionBuiltOn>Mon Jan 9 14:58:42 UTC 2012</hadoopVersionBuiltOn>
<id>host.domain.com:8041</id>
<nodeHostName>host.domain.com</nodeHostName>
<healthReport></healthReport>
<totalVmemAllocatedContainersMB>17203</totalVmemAllocatedContainersMB>
<totalPmemAllocatedContainersMB>8192</totalPmemAllocatedContainersMB>
<totalVCoresAllocatedContainers>8</totalVCoresAllocatedContainers>
<vmemCheckEnabled>false</vmemCheckEnabled>
<pmemCheckEnabled>true</pmemCheckEnabled>
<lastNodeUpdateTime>1485815774203</lastNodeUpdateTime>
<nodeHealthy>true</nodeHealthy>
<nodeManagerVersion>3.0.0</nodeManagerVersion>
<nodeManagerBuildVersion>3.0.0</nodeManagerBuildVersion>
<nodeManagerVersionBuiltOn>2017-01-30T17:42Z</nodeManagerVersionBuiltOn>
<hadoopVersion>3.0.0</hadoopVersion>
<hadoopBuildVersion>3.0.0</hadoopBuildVersion>
<hadoopVersionBuiltOn>2017-01-30T17:39Z</hadoopVersionBuiltOn>
<id>host.domain.com:46077</id>
<nodeHostName>host.domain.com</nodeHostName>
<nmStartupTime>1485800887841</nmStartupTime>
</nodeInfo>
```
@ -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:
<totalVCoresNeeded>1</totalVCoresNeeded>
<containerLogsLink>http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000001/user1</containerLogsLink>
<nodeId>host.domain.com:8041</nodeId>
<executionType>GUARANTEED</executionType>
<containerLogFiles>stdout</containerLogFiles>
<containerLogFiles>stderr</containerLogFiles>
<containerLogFiles>syslog</containerLogFiles>
</container>
<container>
<id>container_1326121700862_0006_01_000003</id>
@ -449,6 +475,10 @@ Response Body:
<totalVCoresNeeded>2</totalVCoresNeeded>
<containerLogsLink>http://host.domain.com:8042/node/containerlogs/container_1326121700862_0006_01_000003/user1</containerLogsLink>
<nodeId>host.domain.com:8041</nodeId>
<executionType>GUARANTEED</executionType>
<containerLogFiles>stdout</containerLogFiles>
<containerLogFiles>stderr</containerLogFiles>
<containerLogFiles>syslog</containerLogFiles>
</container>
</containers>
```
@ -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:
<totalVCoresNeeded>1</totalVCoresNeeded>
<containerLogsLink>http://host.domain.com:8042/node/containerlogs/container_1326121700862_0007_01_000001/user1</containerLogsLink>
<nodeId>host.domain.com:8041</nodeId>
<executionType>GUARANTEED</executionType>
<containerLogFiles>stdout</containerLogFiles>
<containerLogFiles>stderr</containerLogFiles>
<containerLogFiles>syslog</containerLogFiles>
</container>
```