[QA] Overview of the new Telemetry feature introduced in 10.15.0

[jnweiger]

WHAT Needs to be Documented?

Document details about telemetry

WHERE Does This Need To Be Documented (Link)?

admin manual, new page near https://doc.owncloud.com/server/next/admin_manual/troubleshooting/providing_logs_and_config_files.html#introduction
Please finalize the link to the new page asap. We'd like to include the link in the release-notes, while content is being refined.

WHY Should This Change Be Made?

We want to be as transparent as possible to customers and admins, especially, as there is no
cc-email feature, for telemetry reports.

(Optional) What Type Of Content Change Is This?

• New Content Addition
• Old Content Deprecation
• Existing Content Simplification
• Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

• Admin Manual
• Developer Manual
• User Manual
• Android
• iOS
• Branded Clients
• Desktop Client
• Other

[jnweiger]

                                                                                              jw, Mo 8. Jul 17:36:15 CEST 2024

ownCloud Server 10.15.0 Introduces Telemetry Reports for Enterprise Customers

Telemetry data is collected from enterprise installations, in order to improve efficiency and quality of
customer facing teams like ownCloud support, consulting and sales.
In the context of telemetry a server is considered an enterprise server when a license key is installed.
Any server without a license key is considered a community server and no telemetry data is collected.

A telemetry report consists of a subset of the config report plus the following items:

• license_key - used to identify the account.
• id - a telemetry uuid, used to identify the system.

The following config report sections are not part of a telemetry report:

• integretychecker,
• core,
• apps,
• tables,
• migrations.

The following config report sections are part of a telementry report:

• basic (including license key, ownCloud version and linux distro),
• mounts (but without personal mounts or any configuration parameters of system mounts),
• stats (total numbe of LDAP, db, guest users and groups; total 30 days active count),
• config (including IP addresses, domain names, dbhost & dbconnectionstring, redis),
• phpinfo (including PHP version and modules and kernel version).

Telemetry reports are sent between 6:00 h and 12:00h UTC once per day.
The receiving endpoint is https://telemetry.owncloud.com/oc10-telemetry/ - please adjust firewall rules to allow outgoing https transmissions from your ownCloud server hosts there.

You can opt out from sending telemetry reports with the following occ command:

    occ config:system:set telemetry.enabled --type bool --value false

In cases the ownCloud server system cron is not running, you can try send a report manually. Note that this command has exactly the same requirements as the cron job (enabled, time window, license key):

    occ configreport:send-telemetry

Each report successfully sent is logged in the owncloud server log at 'info' level.
Example:

    {"reqId":"b1gpCJvYbkxu6LQ8pkOU","level":1,"time":"2024-07-08T09:50:06+00:00","remoteAddr":"","user":"--","app":"no app in context","method":"--","url":"--","message":"Telemetry data submitted to https:\/\/telemetry.owncloud.com\/oc10-telemetry with request id: 55aa61ed-f3d8-42a6-bf0e-89fe252b769f"}

Telemetry is a feature of the config report app version 0.3.0, bundled with server core 10.15.0 .
The config report app must be installed and enabled for telemetry reports to be sent.

Here is an example telemetry report:

telemetry-5b208860-64dd-4687-aea6-08ba277cf399-jq.json

[DeepDiver1975]

The following config report sections are not part of a telemetry report:

* integretychecker,

* core,

* apps,

* personal mounts and configuration options of system mounts,

* tables,

* migrations.

we should explicit list what is in the telemetry data ...

[DeepDiver1975]

In cases the ownCloud server system cron is not running, you can send a report manually any time:

not really at any time ..... 0600-1200 UTC ....

[jnweiger]

Incorporated feedback from @DeepDiver1975 in the text above.
We should mention GDPR / DSGVO: we do, we don't ... --- but IANAL
Imho we must also refer to our privacy policy: https://owncloud.com/privacy-statement/

[dj4oC]

Please replace:
"logged-in user": "", >> "logged-in user": "***REMOVED SENSITIVE VALUE***",

Please consider to replace:
"license key": "jw_qa-...>> "license key": "***REMOVED SENSITIVE VALUE***-.....

[DeepDiver1975]

License key is essential to know the customer. Has to be transmitted.
@dj4oC

[dj4oC]

Got it. Fine for me

[DeepDiver1975]

"logged-in user": "", >> "logged-in user": "***REMOVED SENSITIVE VALUE***",

FYI: the user will never be filled .... missed that part - sorry