Skip to content

Commit

Permalink
Include open files metric to service/process monitoring
Browse files Browse the repository at this point in the history
Update runbook
  • Loading branch information
dormant-user committed Sep 30, 2024
1 parent 434f7f2 commit 2914f05
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 8 deletions.
14 changes: 12 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1152,9 +1152,14 @@ <h1>PyNinja - Features<a class="headerlink" href="#pyninja-features" title="Perm
<dt class="sig sig-object py" id="pyninja.features.operations.process_monitor">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyninja.features.operations.</span></span><span class="sig-name descname"><span class="pre">process_monitor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">processes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pyninja.features.operations.process_monitor" title="Permalink to this definition"></a></dt>
<dd><p>Function to monitor processes and return their usage statistics.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>processes</strong> – List of process names to monitor.</p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p>Process names can be case in-sensitive.</p>
<p>Process names can be case in-sensitive as they are not strictly matched.</p>
<blockquote>
<div><ul class="simple">
<li><p>macOS/Linux: <cite>top | grep {{ process_name }}</cite></p></li>
Expand All @@ -1176,9 +1181,14 @@ <h1>PyNinja - Features<a class="headerlink" href="#pyninja-features" title="Perm
<dt class="sig sig-object py" id="pyninja.features.operations.service_monitor">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyninja.features.operations.</span></span><span class="sig-name descname"><span class="pre">service_monitor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">services</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pyninja.features.operations.service_monitor" title="Permalink to this definition"></a></dt>
<dd><p>Function to monitor services and return their usage statistics.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>services</strong> – List of service names to monitor.</p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p>Service names are case-sensitive, so use the following command to get the right name.</p>
<p>Service names are case-sensitive as they are strictly matched. Use the following command to get the right name.</p>
<blockquote>
<div><ul class="simple">
<li><p>macOS: <cite>launchctl list | grep {{ service_name }}</cite></p></li>
Expand Down
Loading

0 comments on commit 2914f05

Please sign in to comment.