blob: 983206cc15c454c7bc30aebe6accb1be007ab659 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>newtmgr taskstat &mdash; Apache Mynewt latest documentation</title>
<link rel="shortcut icon" href="../../_static/mynewt-logo-only-newt32x32.png"/>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/sphinx_theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/bootstrap-3.0.3.min.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/v2.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/restructuredtext.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/overrides.css" type="text/css" />
<link rel="index" title="Index"
href="../../genindex.html"/>
<link rel="search" title="Search" href="../../search.html"/>
<link rel="top" title="Apache Mynewt latest documentation" href="../../index.html"/>
<link rel="up" title="Command List" href="index.html"/>
<link rel="next" title="Install" href="../install/index.html"/>
<link rel="prev" title="newtmgr stat" href="newtmgr_stat.html"/>
<script src="../../_static/js/modernizr.min.js"></script>
<script>
(function(i, s, o, g, r, a, m) {
i["GoogleAnalyticsObject"] = r;
(i[r] =
i[r] ||
function() {
(i[r].q = i[r].q || []).push(arguments);
}),
(i[r].l = 1 * new Date());
(a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]);
a.async = 1;
a.src = g;
m.parentNode.insertBefore(a, m);
})(window, document, "script", "//www.google-analytics.com/analytics.js", "ga");
ga("create", "UA-72162311-1", "auto");
ga("send", "pageview");
</script>
</head>
<body class="not-front page-documentation" role="document" >
<div id="wrapper">
<div class="container">
<div id="banner" class="row v2-main-banner">
<a class="logo-cell" href="/">
<img class="logo" src="../../_static/img/logo.png">
</a>
<div class="tagline-cell">
<h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4>
</div>
<div class="news-cell">
<div class="well">
<h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.11.0, Apache NimBLE 1.6.0 </a> released September 7, 2023)
</div>
</div>
</div>
</div>
<header>
<nav id="navbar" class="navbar navbar-inverse" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a>
</li>
<li class="important">
<a href="/quick-start/">Quick Start</a>
</li>
<li>
<a href="/about/">About</a>
</li>
<li>
<a href="/talks/">Talks</a>
</li>
<li class="active">
<a href="/documentation/">Documentation</a>
</li>
<li>
<a href="/download/">Download</a>
</li>
<li>
<a href="/community/">Community</a>
</li>
<li>
<a href="/events/">Events</a>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
</ul>
</div>
</div>
</nav>
</header>
<!-- STARTS MAIN CONTENT -->
<div id="main-content">
<div id="breadcrumb">
<div class="container">
<a href="/documentation/">Docs</a> /
<a href="../index.html">Newt Manager Guide</a> /
<a href="index.html">Command List</a> /
newtmgr taskstat
<div class="sourcelink">
<a href="https://github.com/apache/mynewt-newtmgr/edit/master/docs/command_list/newtmgr_taskstats.rst" class="icon icon-github"
rel="nofollow"> Edit on GitHub</a>
</div>
</div>
</div>
<!-- STARTS CONTAINER -->
<div class="container">
<!-- STARTS .content -->
<div id="content" class="row">
<!-- STARTS .container-sidebar -->
<div class="container-sidebar col-xs-12 col-sm-3">
<div id="docSidebar" class="sticky-container">
<div role="search" class="sphinx-search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search documentation" class="search-documentation" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<!-- Note: only works when deployed -->
<select class="form-control" onchange="if (this.value) window.location.href=this.value">
<option value="/latest" selected>
Version: latest
</option>
<option value="/v1_11_0" >
Version: 1.11.0
</option>
<option value="/v1_10_0" selected="selected" >
Version: 1.10.0
</option>
<option value="/v1_9_0" >
Version: 1.9.0
</option>
<option value="/v1_8_0" >
Version: 1.8.0
</option>
<option value="/v1_7_0" >
Version: 1.7.0
</option>
<option value="/v1_6_0" >
Version: 1.6.0
</option>
<option value="/v1_5_0" >
Version: 1.5.0
</option>
<option value="/v1_4_0" >
Version: 1.4.0
</option>
<option value="/v1_3_0/os/introduction" >
Version: 1.3.0
</option>
<option value="/v1_2_0/os/introduction" >
Version: 1.2.0
</option>
<option value="/v1_1_0/os/introduction" >
Version: 1.1.0
</option>
<option value="/v1_0_0/os/introduction" >
Version: 1.0.0
</option>
<option value="/v0_9_0/os/introduction" >
Version: 0.9.0
</option>
</select>
<div class="region region-sidebar">
<div class="docs-menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../get_started/index.html">Setup &amp; Get Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/tutorials.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../external_links.html">Third-party Resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../os/os_user_guide.html">OS User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../network/index.html">BLE User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../newt/index.html">Newt Tool Guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Newt Manager Guide</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Command List</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="newtmgr_config.html">newtmgr config</a></li>
<li class="toctree-l3"><a class="reference internal" href="newtmgr_conn.html">newtmgr conn</a></li>
<li class="toctree-l3"><a class="reference internal" href="newtmgr_crash.html">newtmgr crash</a></li>
<li class="toctree-l3"><a class="reference internal" href="newtmgr_datetime.html">newtmgr datetime</a></li>
<li class="toctree-l3"><a class="reference internal" href="newtmgr_echo.html">newtmgr echo</a></li>
<li class="toctree-l3"><a class="reference internal" href="newtmgr_fs.html">newtmgr fs</a></li>
<li class="toctree-l3"><a class="reference internal" href="newtmgr_image.html">newtmgr image</a></li>
<li class="toctree-l3"><a class="reference internal" href="newtmgr_logs.html">newtmgr log</a></li>
<li class="toctree-l3"><a class="reference internal" href="newtmgr_mpstats.html">newtmgr mpstat</a></li>
<li class="toctree-l3"><a class="reference internal" href="newtmgr_reset.html">newtmgr reset</a></li>
<li class="toctree-l3"><a class="reference internal" href="newtmgr_run.html">newtmgr run</a></li>
<li class="toctree-l3"><a class="reference internal" href="newtmgr_stat.html">newtmgr stat</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">newtmgr taskstat</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../install/index.html">Install</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../mynewt_faq/index.html">Mynewt FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../misc/index.html">Appendix</a></li>
</ul>
</div>
</div>
</div>
<!-- ENDS STICKY CONTAINER -->
</div>
<!-- ENDS .container-sidebar -->
<div class="col-xs-12 col-sm-9">
<div class="alert alert-warning">
<p>
Version 1.10.0 is not the most recent version of the
Apache Mynewt documentation. Click <a href="/latest">here</a> to
read the latest version.
</p>
</div>
<div class="">
<div class="rst-content">
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="newtmgr-taskstat">
<h1>newtmgr taskstat<a class="headerlink" href="#newtmgr-taskstat" title="Permalink to this headline"></a></h1>
<p>Read task statistics from a device.</p>
<div class="section" id="usage">
<h2>Usage:<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">newtmgr taskstat -c &lt;conn_profile&gt; [flags]</span>
</pre></div>
</div>
</div>
<div class="section" id="global-flags">
<h2>Global Flags:<a class="headerlink" href="#global-flags" title="Permalink to this headline"></a></h2>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">-c, --conn string connection profile to use</span>
<span class="go">-h, --help help for newtmgr</span>
<span class="go">-l, --loglevel string log level to use (default &quot;info&quot;)</span>
<span class="go"> --name string name of target BLE device; overrides profile setting</span>
<span class="go">-t, --timeout float timeout in seconds (partial seconds allowed) (default 10)</span>
<span class="go">-r, --tries int total number of tries in case of timeout (default 1)</span>
</pre></div>
</div>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
<p>Reads and displays the task statistics from a device. Newtmgr uses the <code class="docutils literal notranslate"><span class="pre">conn_profile</span></code> connection profile to connect
to the device. It lists the following statistics for each task:</p>
<ul class="simple">
<li><p><strong>task</strong>: Task name</p></li>
<li><p><strong>pri</strong>: Task priority</p></li>
<li><p><strong>runtime</strong>: The time (ms) that the task has been running for</p></li>
<li><p><strong>csw</strong>: Number of times the task has switched context</p></li>
<li><p><strong>stksz</strong>: Stack size allocated for the task</p></li>
<li><p><strong>stkuse</strong>: Actual stack size the task uses</p></li>
<li><p><strong>last_checkin</strong>: Last sanity checkin with the <a class="reference internal" href="../../os/core_os/sanity/sanity.html"><span class="doc">Sanity Task</span></a></p></li>
<li><p><strong>next_checkin</strong>: Next sanity checkin</p></li>
</ul>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<table class="docutils align-default">
<colgroup>
<col style="width: 18%" />
<col style="width: 82%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Usage</p></th>
<th class="head"><p>Explanation</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">newtmgr</span> <span class="pre">taskstat-c</span> <span class="pre">profile0</span></code></p></td>
<td><p>Reads and displays the task statistics from a device. Newtmgr connects to the device over a connection specified in the <code class="docutils literal notranslate"><span class="pre">profile01</span></code> connection profile.</p></td>
</tr>
</tbody>
</table>
<p>Here is an example output for the <code class="docutils literal notranslate"><span class="pre">myble</span></code> application from the
<span class="xref std std-doc">Enabling Newt Manager in any app</span> tutorial:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>newtmgr<span class="w"> </span>taskstat<span class="w"> </span>-c<span class="w"> </span>myserial
<span class="go"> task pri tid runtime csw stksz stkuse last_checkin next_checkin</span>
<span class="go"> ble_ll 0 2 0 12 80 58 0 0</span>
<span class="go"> idle 255 0 16713 95 64 31 0 0</span>
<span class="go"> main 127 1 2 81 512 275 0 0</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="rst-footer-buttons row" role="navigation" aria-label="footer navigation">
<a href="../install/index.html" class="btn btn-neutral float-right" title="Install" accesskey="n">Next: Install <span class="fa fa-arrow-circle-right"></span></a>
<a href="newtmgr_stat.html" class="btn btn-neutral" title="newtmgr stat" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous: newtmgr stat</a>
</div>
</div>
</div>
</div>
<!-- ENDS CONTENT SECTION -->
</div>
<!-- ENDS .content -->
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-xs-12">
<p class="copyright">Apache Mynewt is available under Apache License, version 2.0.</p>
</div>
<div class="col-xs-12">
<div class="logos">
<img src="../../_static/img/asf_logo_wide_small.png" alt="Apache" title="Apache">
<small class="footnote">
Apache Mynewt, Mynewt, Apache, the Apache feather logo, and the Apache Mynewt project logo are either
registered trademarks or trademarks of the Apache Software Foundation in the United States and other countries.
</small>
<a href="">
<img src="../../_static/img/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" />
</a>
</div>
</div>
</div>
</div>
</footer>
</div>
<!-- ENDS #wrapper -->
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'latest',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
LINK_SUFFIX: '.html'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/js/bootstrap-3.0.3.min.js"></script>
<script type="text/javascript" src="../../_static/js/affix.js"></script>
<script type="text/javascript" src="../../_static/js/main.js"></script>
</body>
</html>