Skip to content

Commit

Permalink
[chores] Updated metric collection page
Browse files Browse the repository at this point in the history
  • Loading branch information
nemesifier committed Apr 25, 2024
1 parent 3d6eb1e commit 4acc9f4
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions user/usage-metric-collection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ Collection of Usage Metrics
===========================

The ``openwisp-utils`` module includes an optional
sub-app ``openwisp_utils.measurements``.

This sub-app allows the collection of the following information:
sub-app ``openwisp_utils.metric_collection``,
which allows us to collect of the following information
from OpenWISP instances:

- OpenWISP Version
- List of enabled OpenWISP modules and their version
Expand All @@ -14,7 +14,7 @@ This sub-app allows the collection of the following information:
<https://github.com/openwisp/ansible-openwisp2>`_
or `docker-openwisp <https://github.com/openwisp/docker-openwisp>`_

The data above is collected in the following events:
The data above is collected during the following events:

- **Install**: when OpenWISP is installed the first time
- **Upgrade**: when any OpenWISP module is upgraded
Expand All @@ -28,8 +28,26 @@ To enhance our understanding and management of this data, we have
integrated `Clean Insights <https://cleaninsights.org/>`_, a privacy-preserving
analytics tool. Clean Insights allows us to responsibly gather and analyze
usage metrics without compromising user privacy. It provides us with the
means to make data-driven decisions while respecting our users'
rights and trust.
means to make data-driven decisions while respecting our users' rights and trust.

We have taken great care to ensure no
sensitive or personal data is being tracked.

Opting out from metric collection
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can opt-out from sharing this data any time from the "System Info" page.
Alternatively, you can also remove the ``openwisp_utils.metric_collection``
app from ``INSTALLED_APPS`` in one of the following ways:

- If you are using the `ansible-openwisp2
<https://github.com/openwisp/ansible-openwisp2>`_ role, you can set the
variable ``openwisp2_usage_metric_collection`` to ``false`` in your playbook.

- If you are using `docker-openwisp
<https://github.com/openwisp/docker-openwisp>`_, you can set set the
environment variable ``METRIC_COLLECTION`` to ``False`` in the ``.env`` file.

However, it would be very helpful to the project if you keep the
colection of these metrics enabled, because the feedback we get from
this data is useful to guide the project in the right direction.

0 comments on commit 4acc9f4

Please sign in to comment.