s3gw-tech / s3gw

Container able to run on a Kubernetes cluster, providing S3-compatible endpoints to applications.
https://s3gw.tech
Apache License 2.0
148 stars 21 forks source link

telemetry: Report telemetry to s3gw.tech server #859

Open jecluis opened 8 months ago

jecluis commented 8 months ago

What needs to be done

We should report basic telemetry to an s3gw.tech server.

The information gathered and reported should be anonymous. No identifying information should be logged.

All information gathered should be properly documented.

Gathering information needs to be on an opt-in basis, possibly by supplying an environment variable to the container, or an option to the binary.

Why it needs to be done

We need to measure adoption of s3gw so we can make an informed decision on whether to maintain the project or to eventually drop it.

Additional Information

Information to be reported should be limited to the bare minimum of what we want for our purposes.

Given we intend to gauge traction and usage, we will likely want to report solely an installation UUID and its current version. This should be reported on reasonable intervals, so we can differentiate between ephemeral installations and long-running installations.

On reporting, the server should reply with the latest available version. This will also allow us to let the operator know whether they should upgrade their installation.

Related Tasks