mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-05-13 18:33:40 +00:00
209 lines
11 KiB
HTML
209 lines
11 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html lang="en" data-content_root="../../">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<title>telem-record-gen — Documentation for Clear Linux* project</title>
|
|
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
|
|
<link rel="stylesheet" type="text/css" href="../../_static/bizstyle.css?v=5283bb3d" />
|
|
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
|
|
|
|
<script src="../../_static/documentation_options.js?v=5929fcd5"></script>
|
|
<script src="../../_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
|
|
<script src="../../_static/copybutton.js?v=a56c686a"></script>
|
|
<script src="../../_static/bizstyle.js"></script>
|
|
<link rel="canonical" href="https://clearlinux.github.io/clear-linux-documentation/reference/manpages/telem-record-gen.1.html" />
|
|
<link rel="icon" href="../../_static/favicon.ico"/>
|
|
<link rel="author" title="About these documents" href="../../about.html" />
|
|
<link rel="index" title="Index" href="../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../search.html" />
|
|
<link rel="next" title="telempostd" href="telempostd.1.html" />
|
|
<link rel="prev" title="telemetrics.conf" href="telemetrics.conf.5.html" />
|
|
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
|
|
<!--[if lt IE 9]>
|
|
<script src="_static/css3-mediaqueries.js"></script>
|
|
<![endif]-->
|
|
</head><body>
|
|
<div class="related" role="navigation" aria-label="Related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="telempostd.1.html" title="telempostd"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="telemetrics.conf.5.html" title="telemetrics.conf"
|
|
accesskey="P">previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../index.html" >Reference</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../man-pages.html" accesskey="U">Man pages</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">telem-record-gen</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<section id="telem-record-gen">
|
|
<h1>telem-record-gen<a class="headerlink" href="#telem-record-gen" title="Link to this heading">¶</a></h1>
|
|
<section id="create-custom-telemetry-record">
|
|
<h2>Create custom telemetry record<a class="headerlink" href="#create-custom-telemetry-record" title="Link to this heading">¶</a></h2>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Copyright<span class="colon">:</span></dt>
|
|
<dd class="field-odd"><p>(C) 2017 Intel Corporation, CC-BY-SA-3.0</p>
|
|
</dd>
|
|
<dt class="field-even">Manual section<span class="colon">:</span></dt>
|
|
<dd class="field-even"><p>1</p>
|
|
</dd>
|
|
</dl>
|
|
<section id="synopsis">
|
|
<h3>SYNOPSIS<a class="headerlink" href="#synopsis" title="Link to this heading">¶</a></h3>
|
|
<p><code class="docutils literal notranslate"><span class="pre">telem-record-gen</span></code> <options></p>
|
|
</section>
|
|
<section id="description">
|
|
<h3>DESCRIPTION<a class="headerlink" href="#description" title="Link to this heading">¶</a></h3>
|
|
<p>Generate and attempt to send a telemetry record to <a class="reference external" href="telemprobd.1.html">telemprobd(1)</a>. This
|
|
program can be used to create a telemetry record from a shell script
|
|
or from another program using e.g. <code class="docutils literal notranslate"><span class="pre">system()</span></code>. The program connects
|
|
to a local <a class="reference external" href="telemprobd.1.html">telemprobd(1)</a> daemon to spool the record for delivery to
|
|
the actual collection service.</p>
|
|
<p>The payload can be provided as standard input, as a file with the
|
|
<code class="docutils literal notranslate"><span class="pre">--payload-file</span></code> option, or as a string argument with the <code class="docutils literal notranslate"><span class="pre">--payload</span></code>
|
|
option. If neither the <code class="docutils literal notranslate"><span class="pre">--payload</span></code> or <code class="docutils literal notranslate"><span class="pre">--payload-file</span></code> is provided,
|
|
the payload is assumed to be on <stdin>.</p>
|
|
<p>Each record is expected to have a class identifier, a record version
|
|
number, and a severity level. A class identifier is required to be
|
|
provided.</p>
|
|
</section>
|
|
<section id="options">
|
|
<h3>OPTIONS<a class="headerlink" href="#options" title="Link to this heading">¶</a></h3>
|
|
<blockquote>
|
|
<div><ul class="simple">
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">-h</span></code>, <code class="docutils literal notranslate"><span class="pre">--help</span></code>:
|
|
Show help options.</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">-V</span></code>, <code class="docutils literal notranslate"><span class="pre">--version</span></code>:
|
|
Print the program version.</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">-f</span></code>, <code class="docutils literal notranslate"><span class="pre">--config-file</span></code> <file>:
|
|
Path to configuration file (not implemented yet).</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">-s</span></code>, <code class="docutils literal notranslate"><span class="pre">--severity</span></code>:
|
|
Severity level (1-4) - (default 1).</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">-c</span></code>, <code class="docutils literal notranslate"><span class="pre">--class</span></code>:
|
|
Classification <code class="docutils literal notranslate"><span class="pre">level_1</span></code>/<code class="docutils literal notranslate"><span class="pre">level_2</span></code>/<code class="docutils literal notranslate"><span class="pre">level_3</span></code>.</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">-p</span></code>, <code class="docutils literal notranslate"><span class="pre">--payload</span></code> <payload>:
|
|
Record body (max size = 8k).</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">-P</span></code>, <code class="docutils literal notranslate"><span class="pre">--payload-file</span></code> <file>:
|
|
File to read payload from.</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">-R</span></code>, <code class="docutils literal notranslate"><span class="pre">--record-version</span></code> <version>:
|
|
Version number for format of payload (default 1).</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">-e</span></code>, <code class="docutils literal notranslate"><span class="pre">--event-id</span></code> <version>:
|
|
Event id to use in the record. If not provided a randomly generated id will be assigned to record.</p></li>
|
|
</ul>
|
|
</div></blockquote>
|
|
</section>
|
|
<section id="return-values">
|
|
<h3>RETURN VALUES<a class="headerlink" href="#return-values" title="Link to this heading">¶</a></h3>
|
|
<p>0 on success. A non-zero exit code indicates a failure occurred.</p>
|
|
</section>
|
|
<section id="see-also">
|
|
<h3>SEE ALSO<a class="headerlink" href="#see-also" title="Link to this heading">¶</a></h3>
|
|
<ul class="simple">
|
|
<li><p><a class="reference external" href="telemprobd.1.html">telemprobd(1)</a></p></li>
|
|
<li><p><a class="reference external" href="https://github.com/clearlinux/telemetrics-client">https://github.com/clearlinux/telemetrics-client</a></p></li>
|
|
<li><p><a class="reference external" href="https://clearlinux.org/documentation/">https://clearlinux.org/documentation/</a></p></li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
<div class="clearer"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
|
<div class="sphinxsidebarwrapper">
|
|
<p class="logo"><a href="../../index.html">
|
|
<img class="logo" src="../../_static/clearlinux.png" alt="Logo of Clear Linux* Project Docs"/>
|
|
</a></p>
|
|
<div>
|
|
<h3><a href="../../index.html">Table of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#">telem-record-gen</a><ul>
|
|
<li><a class="reference internal" href="#create-custom-telemetry-record">Create custom telemetry record</a><ul>
|
|
<li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
|
|
<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
|
|
<li><a class="reference internal" href="#options">OPTIONS</a></li>
|
|
<li><a class="reference internal" href="#return-values">RETURN VALUES</a></li>
|
|
<li><a class="reference internal" href="#see-also">SEE ALSO</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
<div>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="telemetrics.conf.5.html"
|
|
title="previous chapter">telemetrics.conf</a></p>
|
|
</div>
|
|
<div>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="telempostd.1.html"
|
|
title="next chapter">telempostd</a></p>
|
|
</div>
|
|
<div role="note" aria-label="source link">
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../../_sources/reference/manpages/telem-record-gen.1.rst.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
</div>
|
|
<search id="searchbox" style="display: none" role="search">
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="../../search.html" method="get">
|
|
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</search>
|
|
<script>document.getElementById('searchbox').style.display = "block"</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="Related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="telempostd.1.html" title="telempostd"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="telemetrics.conf.5.html" title="telemetrics.conf"
|
|
>previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../../index.html">Documentation for Clear Linux* project</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../index.html" >Reference</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../man-pages.html" >Man pages</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">telem-record-gen</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2022 Intel Corporation. All Rights Reserved..
|
|
Last updated on Nov 04, 2024.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
|
|
</div>
|
|
</body>
|
|
</html> |