You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by ji...@apache.org on 2016/04/22 18:25:01 UTC
mesos git commit: Update docs to reflect /containers endpoint.
Repository: mesos
Updated Branches:
refs/heads/master c5c0386ae -> 8ca09f5f9
Update docs to reflect /containers endpoint.
Docs are updated using support/generate-endpoint-help.py.
Review: https://reviews.apache.org/r/46075/
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/8ca09f5f
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/8ca09f5f
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/8ca09f5f
Branch: refs/heads/master
Commit: 8ca09f5f9ca0894d9da8a04e6e6447abca2d3248
Parents: c5c0386
Author: Jay Guo <gu...@cn.ibm.com>
Authored: Fri Apr 22 09:24:51 2016 -0700
Committer: Jie Yu <yu...@gmail.com>
Committed: Fri Apr 22 09:24:51 2016 -0700
----------------------------------------------------------------------
docs/endpoints/index.md | 7 ++-
docs/endpoints/monitor/statistics.json.md | 41 -----------------
docs/endpoints/monitor/statistics.md | 41 -----------------
docs/endpoints/slave/containers.md | 48 ++++++++++++++++++++
docs/endpoints/slave/monitor/statistics.json.md | 42 +++++++++++++++++
docs/endpoints/slave/monitor/statistics.md | 42 +++++++++++++++++
6 files changed, 135 insertions(+), 86 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/8ca09f5f/docs/endpoints/index.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/index.md b/docs/endpoints/index.md
index 4fc5583..d57239e 100644
--- a/docs/endpoints/index.md
+++ b/docs/endpoints/index.md
@@ -103,18 +103,17 @@ For example, http://agent.com:5051/files/browse
### metrics ###
* [/metrics/snapshot](metrics/snapshot.md)
-### monitor ###
-* [/monitor/statistics](monitor/statistics.md)
-* [/monitor/statistics.json](monitor/statistics.json.md)
-
### profiler ###
* [/profiler/start](profiler/start.md)
* [/profiler/stop](profiler/stop.md)
### slave(id) ###
* [/api/v1/executor](slave/api/v1/executor.md)
+* [/containers](slave/containers.md)
* [/flags](slave/flags.md)
* [/health](slave/health.md)
+* [/monitor/statistics](slave/monitor/statistics.md)
+* [/monitor/statistics.json](slave/monitor/statistics.json.md)
* [/state](slave/state.md)
* [/state.json](slave/state.json.md)
http://git-wip-us.apache.org/repos/asf/mesos/blob/8ca09f5f/docs/endpoints/monitor/statistics.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/monitor/statistics.json.md b/docs/endpoints/monitor/statistics.json.md
deleted file mode 100644
index 1830493..0000000
--- a/docs/endpoints/monitor/statistics.json.md
+++ /dev/null
@@ -1,41 +0,0 @@
----
-title: Apache Mesos - HTTP Endpoints - /monitor/statistics.json
-layout: documentation
----
-<!--- This is an automatically generated file. DO NOT EDIT! --->
-
-### USAGE ###
-> /monitor/statistics.json
-
-### TL;DR; ###
-Retrieve resource monitoring information.
-
-### DESCRIPTION ###
-Returns the current resource consumption data for containers
-running under this slave.
-
-Example:
-
-```
-[{
- "executor_id":"executor",
- "executor_name":"name",
- "framework_id":"framework",
- "source":"source",
- "statistics":
- {
- "cpus_limit":8.25,
- "cpus_nr_periods":769021,
- "cpus_nr_throttled":1046,
- "cpus_system_time_secs":34501.45,
- "cpus_throttled_time_secs":352.597023453,
- "cpus_user_time_secs":96348.84,
- "mem_anon_bytes":4845449216,
- "mem_file_bytes":260165632,
- "mem_limit_bytes":7650410496,
- "mem_mapped_file_bytes":7159808,
- "mem_rss_bytes":5105614848,
- "timestamp":1388534400.0
- }
-}]
-```
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/mesos/blob/8ca09f5f/docs/endpoints/monitor/statistics.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/monitor/statistics.md b/docs/endpoints/monitor/statistics.md
deleted file mode 100644
index 38dede0..0000000
--- a/docs/endpoints/monitor/statistics.md
+++ /dev/null
@@ -1,41 +0,0 @@
----
-title: Apache Mesos - HTTP Endpoints - /monitor/statistics
-layout: documentation
----
-<!--- This is an automatically generated file. DO NOT EDIT! --->
-
-### USAGE ###
-> /monitor/statistics
-
-### TL;DR; ###
-Retrieve resource monitoring information.
-
-### DESCRIPTION ###
-Returns the current resource consumption data for containers
-running under this slave.
-
-Example:
-
-```
-[{
- "executor_id":"executor",
- "executor_name":"name",
- "framework_id":"framework",
- "source":"source",
- "statistics":
- {
- "cpus_limit":8.25,
- "cpus_nr_periods":769021,
- "cpus_nr_throttled":1046,
- "cpus_system_time_secs":34501.45,
- "cpus_throttled_time_secs":352.597023453,
- "cpus_user_time_secs":96348.84,
- "mem_anon_bytes":4845449216,
- "mem_file_bytes":260165632,
- "mem_limit_bytes":7650410496,
- "mem_mapped_file_bytes":7159808,
- "mem_rss_bytes":5105614848,
- "timestamp":1388534400.0
- }
-}]
-```
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/mesos/blob/8ca09f5f/docs/endpoints/slave/containers.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/slave/containers.md b/docs/endpoints/slave/containers.md
new file mode 100644
index 0000000..ae6559b
--- /dev/null
+++ b/docs/endpoints/slave/containers.md
@@ -0,0 +1,48 @@
+---
+title: Apache Mesos - HTTP Endpoints - /containers
+layout: documentation
+---
+<!--- This is an automatically generated file. DO NOT EDIT! --->
+
+### USAGE ###
+> /containers
+> /slave(1)/containers
+
+### TL;DR; ###
+Retrieve container status and usage information.
+
+### DESCRIPTION ###
+Returns the current resource consumption data and status for
+containers running under this slave.
+
+Example (**Note**: this is not exhaustive):
+
+```
+[{
+ "container_id":"container",
+ "container_status":
+ {
+ "network_infos":
+ [{"ip_addresses":[{"ip_address":"192.168.1.1"}]}]
+ }
+ "executor_id":"executor",
+ "executor_name":"name",
+ "framework_id":"framework",
+ "source":"source",
+ "statistics":
+ {
+ "cpus_limit":8.25,
+ "cpus_nr_periods":769021,
+ "cpus_nr_throttled":1046,
+ "cpus_system_time_secs":34501.45,
+ "cpus_throttled_time_secs":352.597023453,
+ "cpus_user_time_secs":96348.84,
+ "mem_anon_bytes":4845449216,
+ "mem_file_bytes":260165632,
+ "mem_limit_bytes":7650410496,
+ "mem_mapped_file_bytes":7159808,
+ "mem_rss_bytes":5105614848,
+ "timestamp":1388534400.0
+ }
+}]
+```
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/mesos/blob/8ca09f5f/docs/endpoints/slave/monitor/statistics.json.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/slave/monitor/statistics.json.md b/docs/endpoints/slave/monitor/statistics.json.md
new file mode 100644
index 0000000..f409a21
--- /dev/null
+++ b/docs/endpoints/slave/monitor/statistics.json.md
@@ -0,0 +1,42 @@
+---
+title: Apache Mesos - HTTP Endpoints - /monitor/statistics.json
+layout: documentation
+---
+<!--- This is an automatically generated file. DO NOT EDIT! --->
+
+### USAGE ###
+> /monitor/statistics.json
+> /slave(1)/monitor/statistics.json
+
+### TL;DR; ###
+Retrieve resource monitoring information.
+
+### DESCRIPTION ###
+Returns the current resource consumption data for containers
+running under this slave.
+
+Example:
+
+```
+[{
+ "executor_id":"executor",
+ "executor_name":"name",
+ "framework_id":"framework",
+ "source":"source",
+ "statistics":
+ {
+ "cpus_limit":8.25,
+ "cpus_nr_periods":769021,
+ "cpus_nr_throttled":1046,
+ "cpus_system_time_secs":34501.45,
+ "cpus_throttled_time_secs":352.597023453,
+ "cpus_user_time_secs":96348.84,
+ "mem_anon_bytes":4845449216,
+ "mem_file_bytes":260165632,
+ "mem_limit_bytes":7650410496,
+ "mem_mapped_file_bytes":7159808,
+ "mem_rss_bytes":5105614848,
+ "timestamp":1388534400.0
+ }
+}]
+```
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/mesos/blob/8ca09f5f/docs/endpoints/slave/monitor/statistics.md
----------------------------------------------------------------------
diff --git a/docs/endpoints/slave/monitor/statistics.md b/docs/endpoints/slave/monitor/statistics.md
new file mode 100644
index 0000000..ec9f095
--- /dev/null
+++ b/docs/endpoints/slave/monitor/statistics.md
@@ -0,0 +1,42 @@
+---
+title: Apache Mesos - HTTP Endpoints - /monitor/statistics
+layout: documentation
+---
+<!--- This is an automatically generated file. DO NOT EDIT! --->
+
+### USAGE ###
+> /monitor/statistics
+> /slave(1)/monitor/statistics
+
+### TL;DR; ###
+Retrieve resource monitoring information.
+
+### DESCRIPTION ###
+Returns the current resource consumption data for containers
+running under this slave.
+
+Example:
+
+```
+[{
+ "executor_id":"executor",
+ "executor_name":"name",
+ "framework_id":"framework",
+ "source":"source",
+ "statistics":
+ {
+ "cpus_limit":8.25,
+ "cpus_nr_periods":769021,
+ "cpus_nr_throttled":1046,
+ "cpus_system_time_secs":34501.45,
+ "cpus_throttled_time_secs":352.597023453,
+ "cpus_user_time_secs":96348.84,
+ "mem_anon_bytes":4845449216,
+ "mem_file_bytes":260165632,
+ "mem_limit_bytes":7650410496,
+ "mem_mapped_file_bytes":7159808,
+ "mem_rss_bytes":5105614848,
+ "timestamp":1388534400.0
+ }
+}]
+```
\ No newline at end of file