mirror of
https://github.com/jomjol/AI-on-the-edge-device-docs.git
synced 2025-12-11 22:17:03 +03:00
Deployed da0fa88 with MkDocs version: 1.6.0
This commit is contained in:
github-actions[bot]
@@ -9,7 +9,7 @@
|
||||
<link href="../New-Releases-Notification/" rel="prev"/>
|
||||
<link href="../Error-Codes/" rel="next"/>
|
||||
<link href="../img/favicon.ico" rel="icon"/>
|
||||
<meta content="mkdocs-1.6.0, mkdocs-material-9.5.32" name="generator"/>
|
||||
<meta content="mkdocs-1.6.0, mkdocs-material-9.5.33" name="generator"/>
|
||||
<title>Prometheus/OpenMetrics - AI on the Edge Device</title>
|
||||
<link href="../assets/stylesheets/main.3cba04c6.min.css" rel="stylesheet"/>
|
||||
<link href="../assets/stylesheets/palette.06af60db.min.css" rel="stylesheet"/>
|
||||
@@ -513,6 +513,13 @@
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
<li class="md-nav__item">
|
||||
<a class="md-nav__link" href="../Webhook/">
|
||||
<span class="md-ellipsis">
|
||||
Webhook
|
||||
</span>
|
||||
</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</li>
|
||||
@@ -630,35 +637,35 @@
|
||||
<h1 id="prometheusopenmetrics"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.</span> Prometheus/OpenMetrics</h1>
|
||||
<p>A set of metrics is exported via the <code>/metrics</code> REST API path on the device. Besides the current value, a set of device properties are exported. Multiple sequences (aka <em>numbers</em>) are supported via a label. The metrics are provided in text wire format.</p>
|
||||
<p>Example:</p>
|
||||
<pre><code class="language-bash">$ curl http://<IP>/metrics
|
||||
# HELP ai_on_the_edge_device_flow_value current value of meter readout
|
||||
# TYPE ai_on_the_edge_device_flow_value gauge
|
||||
ai_on_the_edge_device_flow_value{sequence="main"} 240.7064
|
||||
# HELP ai_on_the_edge_device_cpu_temperature_celsius current cpu temperature in celsius
|
||||
# TYPE ai_on_the_edge_device_cpu_temperature_celsius gauge
|
||||
ai_on_the_edge_device_cpu_temperature_celsius 41
|
||||
# HELP ai_on_the_edge_device_rssi_dbm current WiFi signal strength in dBm
|
||||
# TYPE ai_on_the_edge_device_rssi_dbm gauge
|
||||
ai_on_the_edge_device_rssi_dbm -67
|
||||
# HELP ai_on_the_edge_device_memory_heap_free_bytes available heap memory
|
||||
# TYPE ai_on_the_edge_device_memory_heap_free_bytes gauge
|
||||
ai_on_the_edge_device_memory_heap_free_bytes 716303
|
||||
# HELP ai_on_the_edge_device_uptime_seconds device uptime in seconds
|
||||
# TYPE ai_on_the_edge_device_uptime_seconds gauge
|
||||
ai_on_the_edge_device_uptime_seconds 214267
|
||||
# HELP ai_on_the_edge_device_rounds_total data aquisition rounds since device startup
|
||||
# TYPE ai_on_the_edge_device_rounds_total counter
|
||||
ai_on_the_edge_device_rounds_total 239
|
||||
</code></pre>
|
||||
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a href="#__codelineno-0-1" id="__codelineno-0-1" name="__codelineno-0-1"></a>$<span class="w"> </span>curl<span class="w"> </span>http://<IP>/metrics
|
||||
</span><span id="__span-0-2"><a href="#__codelineno-0-2" id="__codelineno-0-2" name="__codelineno-0-2"></a><span class="c1"># HELP ai_on_the_edge_device_flow_value current value of meter readout</span>
|
||||
</span><span id="__span-0-3"><a href="#__codelineno-0-3" id="__codelineno-0-3" name="__codelineno-0-3"></a><span class="c1"># TYPE ai_on_the_edge_device_flow_value gauge</span>
|
||||
</span><span id="__span-0-4"><a href="#__codelineno-0-4" id="__codelineno-0-4" name="__codelineno-0-4"></a>ai_on_the_edge_device_flow_value<span class="o">{</span><span class="nv">sequence</span><span class="o">=</span><span class="s2">"main"</span><span class="o">}</span><span class="w"> </span><span class="m">240</span>.7064
|
||||
</span><span id="__span-0-5"><a href="#__codelineno-0-5" id="__codelineno-0-5" name="__codelineno-0-5"></a><span class="c1"># HELP ai_on_the_edge_device_cpu_temperature_celsius current cpu temperature in celsius</span>
|
||||
</span><span id="__span-0-6"><a href="#__codelineno-0-6" id="__codelineno-0-6" name="__codelineno-0-6"></a><span class="c1"># TYPE ai_on_the_edge_device_cpu_temperature_celsius gauge</span>
|
||||
</span><span id="__span-0-7"><a href="#__codelineno-0-7" id="__codelineno-0-7" name="__codelineno-0-7"></a>ai_on_the_edge_device_cpu_temperature_celsius<span class="w"> </span><span class="m">41</span>
|
||||
</span><span id="__span-0-8"><a href="#__codelineno-0-8" id="__codelineno-0-8" name="__codelineno-0-8"></a><span class="c1"># HELP ai_on_the_edge_device_rssi_dbm current WiFi signal strength in dBm</span>
|
||||
</span><span id="__span-0-9"><a href="#__codelineno-0-9" id="__codelineno-0-9" name="__codelineno-0-9"></a><span class="c1"># TYPE ai_on_the_edge_device_rssi_dbm gauge</span>
|
||||
</span><span id="__span-0-10"><a href="#__codelineno-0-10" id="__codelineno-0-10" name="__codelineno-0-10"></a>ai_on_the_edge_device_rssi_dbm<span class="w"> </span>-67
|
||||
</span><span id="__span-0-11"><a href="#__codelineno-0-11" id="__codelineno-0-11" name="__codelineno-0-11"></a><span class="c1"># HELP ai_on_the_edge_device_memory_heap_free_bytes available heap memory</span>
|
||||
</span><span id="__span-0-12"><a href="#__codelineno-0-12" id="__codelineno-0-12" name="__codelineno-0-12"></a><span class="c1"># TYPE ai_on_the_edge_device_memory_heap_free_bytes gauge</span>
|
||||
</span><span id="__span-0-13"><a href="#__codelineno-0-13" id="__codelineno-0-13" name="__codelineno-0-13"></a>ai_on_the_edge_device_memory_heap_free_bytes<span class="w"> </span><span class="m">716303</span>
|
||||
</span><span id="__span-0-14"><a href="#__codelineno-0-14" id="__codelineno-0-14" name="__codelineno-0-14"></a><span class="c1"># HELP ai_on_the_edge_device_uptime_seconds device uptime in seconds</span>
|
||||
</span><span id="__span-0-15"><a href="#__codelineno-0-15" id="__codelineno-0-15" name="__codelineno-0-15"></a><span class="c1"># TYPE ai_on_the_edge_device_uptime_seconds gauge</span>
|
||||
</span><span id="__span-0-16"><a href="#__codelineno-0-16" id="__codelineno-0-16" name="__codelineno-0-16"></a>ai_on_the_edge_device_uptime_seconds<span class="w"> </span><span class="m">214267</span>
|
||||
</span><span id="__span-0-17"><a href="#__codelineno-0-17" id="__codelineno-0-17" name="__codelineno-0-17"></a><span class="c1"># HELP ai_on_the_edge_device_rounds_total data aquisition rounds since device startup</span>
|
||||
</span><span id="__span-0-18"><a href="#__codelineno-0-18" id="__codelineno-0-18" name="__codelineno-0-18"></a><span class="c1"># TYPE ai_on_the_edge_device_rounds_total counter</span>
|
||||
</span><span id="__span-0-19"><a href="#__codelineno-0-19" id="__codelineno-0-19" name="__codelineno-0-19"></a>ai_on_the_edge_device_rounds_total<span class="w"> </span><span class="m">239</span>
|
||||
</span></code></pre></div>
|
||||
<h2 id="prometheus-scrape-config"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.1</span> Prometheus Scrape Config</h2>
|
||||
<p>The following scrape config (add to <code>prometheus.yml</code>) can be used as an example to ingest available metrics with prometheus:</p>
|
||||
<pre><code>scrape_configs:
|
||||
- job_name: watermeter
|
||||
scrape_interval: 300s
|
||||
metrics_path: /metrics
|
||||
static_configs:
|
||||
- targets: ['<IP>']
|
||||
</code></pre>
|
||||
<div class="language-text highlight"><pre><span></span><code><span id="__span-1-1"><a href="#__codelineno-1-1" id="__codelineno-1-1" name="__codelineno-1-1"></a>scrape_configs:
|
||||
</span><span id="__span-1-2"><a href="#__codelineno-1-2" id="__codelineno-1-2" name="__codelineno-1-2"></a> - job_name: watermeter
|
||||
</span><span id="__span-1-3"><a href="#__codelineno-1-3" id="__codelineno-1-3" name="__codelineno-1-3"></a> scrape_interval: 300s
|
||||
</span><span id="__span-1-4"><a href="#__codelineno-1-4" id="__codelineno-1-4" name="__codelineno-1-4"></a> metrics_path: /metrics
|
||||
</span><span id="__span-1-5"><a href="#__codelineno-1-5" id="__codelineno-1-5" name="__codelineno-1-5"></a> static_configs:
|
||||
</span><span id="__span-1-6"><a href="#__codelineno-1-6" id="__codelineno-1-6" name="__codelineno-1-6"></a> - targets: ['<IP>']
|
||||
</span></code></pre></div>
|
||||
<h2 id="references"><span class="enumerate-headings-plugin enumerate-heading-plugin">1.2</span> References</h2>
|
||||
<ul>
|
||||
<li><a href="https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md">OpenMetrics</a></li>
|
||||
@@ -687,6 +694,6 @@ ai_on_the_edge_device_rounds_total 239
|
||||
<div class="md-dialog__inner md-typeset"></div>
|
||||
</div>
|
||||
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
|
||||
<script src="../assets/javascripts/bundle.471ce7a9.min.js"></script>
|
||||
<script src="../assets/javascripts/bundle.af256bd8.min.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user