feat: basic telemetry collection/submission feature

This commit is contained in:
Lance Edgar 2025-08-09 12:05:18 -05:00
commit 53f599fa79
29 changed files with 1710 additions and 0 deletions

19
docs/narr/cli/builtin.rst Normal file
View file

@ -0,0 +1,19 @@
===================
Built-in Commands
===================
Below are the :term:`subcommands <subcommand>` which come with
WuttaTell.
.. _wutta-tell:
``wutta tell``
--------------
Collect and submit telemetry data.
Defined in: :mod:`wuttatell.cli.tell`
.. program-output:: wutta tell --help

18
docs/narr/cli/index.rst Normal file
View file

@ -0,0 +1,18 @@
========================
Command Line Interface
========================
The primary way of using the telemetry framework day to day is via the
command line.
WuttJamaican defines the ``wutta`` :term:`command` and WuttaTell comes
with an extra :term:`subcommand` for submitting telemetry data.
For more general info about CLI see
:doc:`wuttjamaican:narr/cli/index`.
.. toctree::
:maxdepth: 2
builtin

28
docs/narr/install.rst Normal file
View file

@ -0,0 +1,28 @@
Installation
============
This assumes you already have a :doc:`WuttJamaican app
<wuttjamaican:narr/install/index>` setup and working.
Install the WuttaTell package to your virtual environment:
.. code-block:: sh
pip install WuttaTell
Edit your :term:`config file` to add telemetry submission info, and
related settings. Please note, the following example is just that -
and will not work as-is:
.. code-block:: ini
[wutta.telemetry]
default.collect_keys = os, python
default.submit_url = /nodes/telemetry
default.submit_uuid = 06897767-eb70-7790-8000-13f368a40ea3
.. note::
The built-in logic can collect some "minimal" telemetry info, but
there is no built-in logic for the submission.