Skip to content

Commit

Permalink
tcollector documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@vasiliyk
vasiliyk committed May 28, 2024
1 parent 8392e74 commit f165ecd
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 23 deletions.
22 changes: 12 additions & 10 deletions docs/build/html/user_guide/utilities/tcollector.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,25 +198,20 @@ <h2>Deduplication</h2>
<section id="runtime-requirements-for-tcollector">
<h2>Runtime Requirements for tcollector</h2>
<div class="line-block">
<div class="line">Tcollector requires one of following python versions: 3.7, 3.8, 3.9, 3.10, 3.11.</div>
<div class="line">Each collector in <code class="docutils literal notranslate"><span class="pre">collectors/available/software</span></code> may have additional requirements.</div>
<div class="line">Tcollector requires one of following python versions to run: 3.7 - 3.11.</div>
</div>
<p>OS specific collectors located in <code class="docutils literal notranslate"><span class="pre">collectors/available/Linux|FreeBSD|MacOS</span></code>
should run using base tools installed with respected OS. Other software collectors located
in <code class="docutils literal notranslate"><span class="pre">collectors/available/software</span></code> may have additional requirements.</p>
</section>
<section id="installation-of-tcollector">
<h2>Installation of tcollector</h2>
<ol class="arabic simple">
<li><p>Clone or download tcollector archive from GitHub on
<a class="reference external" href="https://github.com/OpenTSDB/tcollector">https://github.com/OpenTSDB/tcollector</a> .</p></li>
<li><p>Review collectors in <code class="docutils literal notranslate"><span class="pre">collectors</span></code> directory and remove ones you do not need so they
do not start needlessly after each tcollector restart.</p></li>
<li><p>Consider using of shell script <code class="docutils literal notranslate"><span class="pre">tcollector/tcollector</span></code> to run tcollector if you want
to auto start after OS restart.</p></li>
to auto start after OS restart. Source codes to build RPM or DEB packages are also available in tcollector folder.</p></li>
</ol>
<p>NOTE:
To avoid having to run <code class="docutils literal notranslate"><span class="pre">mkmetric</span></code> for every metric that
tcollector tracks you can to start TSD with the <code class="docutils literal notranslate"><span class="pre">--auto-metric</span></code>
flag. This is useful to get started quickly, but it’s not recommended to
keep this flag in the long term, to avoid accidental metric creation.</p>
</section>
<section id="collecting-metrics-with-tcollector">
<h2>Collecting metrics with tcollector</h2>
Expand Down Expand Up @@ -263,6 +258,13 @@ <h2>Collecting metrics with tcollector</h2>
┗ test/
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>To avoid having to run <code class="docutils literal notranslate"><span class="pre">mkmetric</span></code> for every metric that
tcollector tracks you can to start TSD with the <code class="docutils literal notranslate"><span class="pre">--auto-metric</span></code>
flag. This is useful to get started quickly, but it’s not recommended to
keep this flag in the long term, to avoid accidental metric creation.</p>
</div>
</section>
</section>
<section id="collectors-bundled-with-tcollector">
Expand Down
27 changes: 14 additions & 13 deletions docs/source/user_guide/utilities/tcollector.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,10 @@ free to store repeated values.
Runtime Requirements for tcollector
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

| Tcollector requires one of following python versions: 3.7, 3.8, 3.9, 3.10, 3.11.
| Each collector in ``collectors/available/software`` may have additional requirements.
| Tcollector requires one of following python versions to run: 3.7 - 3.11.
OS specific collectors located in ``collectors/available/Linux|FreeBSD|MacOS``
should run using base tools installed with respected OS. Other software collectors located
in ``collectors/available/software`` may have additional requirements.


Installation of tcollector
Expand All @@ -57,17 +59,8 @@ Installation of tcollector
1. Clone or download tcollector archive from GitHub on
https://github.com/OpenTSDB/tcollector .

2. Review collectors in ``collectors`` directory and remove ones you do not need so they
do not start needlessly after each tcollector restart.

3. Consider using of shell script ``tcollector/tcollector`` to run tcollector if you want
to auto start after OS restart.

NOTE:
To avoid having to run ``mkmetric`` for every metric that
tcollector tracks you can to start TSD with the ``--auto-metric``
flag. This is useful to get started quickly, but it's not recommended to
keep this flag in the long term, to avoid accidental metric creation.
2. Consider using of shell script ``tcollector/tcollector`` to run tcollector if you want
to auto start after OS restart. Source codes to build RPM or DEB packages are also available in tcollector folder.


Collecting metrics with tcollector
Expand Down Expand Up @@ -121,6 +114,14 @@ The structure of directories: ::
┣ lib/
┗ test/

.. NOTE ::
To avoid having to run ``mkmetric`` for every metric that
tcollector tracks you can to start TSD with the ``--auto-metric``
flag. This is useful to get started quickly, but it's not recommended to
keep this flag in the long term, to avoid accidental metric creation.
Collectors bundled with ``tcollector``
======================================

Expand Down

0 comments on commit f165ecd

Please sign in to comment.