static std::string statsHelp()
{
return HELP(
TLDR(
"Shows local system metrics."),
DESCRIPTION(
"> cpus_total Total number of available CPUs",
"> load_1min Average system load for last"
" minute in uptime(1) style",
"> load_5min Average system load for last"
" 5 minutes in uptime(1) style",
"> load_15min Average system load for last"
" 15 minutes in uptime(1) style",
"> memory_total_bytes Total system memory in bytes",
"> memory_free_bytes Free system memory in bytes"));
}
const std::string Logging::TOGGLE_HELP()
{
return HELP(
TLDR(
"Sets the logging verbosity level for a specified duration."),
DESCRIPTION(
"The libprocess library uses [glog][glog] for logging. The library",
"only uses verbose logging which means nothing will be output unless",
"the verbosity level is set (by default it's 0, libprocess uses"
"levels 1, 2, and 3).",
"",
"**NOTE:** If your application uses glog this will also affect",
"your verbose logging.",
"",
"Query parameters:",
"",
"> level=VALUE Verbosity level (e.g., 1, 2, 3)",
"> duration=VALUE Duration to keep verbosity level",
"> toggled (e.g., 10secs, 15mins, etc.)"),
REFERENCES(
"[glog]: https://code.google.com/p/google-glog"));
}
static const string VERSION_HELP()
{
// TODO(haosdent): generate the example in description automatically after we
// have json pretty printing.
return HELP(
TLDR(
"Provides version information."),
DESCRIPTION(
"Example:",
"",
"```",
"{",
" \"version\":\"0.26.0\",",
" \"build_user\":\"username\",",
" \"build_time\":1443894750,",
" \"build_date\":\"2015-10-04 01:52:30\"",
" \"git_branch\":\"branch\", // Optional",
" \"git_tag\":\"0.26.0-rc1\", // Optional",
" \"git_sha\":\"d31f096a4665650ad4b9eda372ac41d2c472a77c\","
" // Optional",
"}",
"```"));
}