Skip to content

[Product Data] Client-side stats collection #5107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Nov 8, 2024
Merged

Conversation

simonwicky
Copy link
Contributor

@simonwicky simonwicky commented Nov 7, 2024

Why

The goal is to anonymously gather stats from nym-clients. These stats will be sent through the mixnet to a Nym run service provider that will gather them.

What this PR does

Sets the scene to send stats in a mixnet message to an address. The address can be set when the client is created. Current stats include some infos on sent packets along with platform information. If a receiving address is set, the client will send a mixnet packet every 5min to this address. Otherwise, nothing happens and the client runs as usual.

To set an address, BaseClientBuilder and the sdk expose a with_statistics_reporting function.
For now, there is no address.

Next steps

  • Use address provided in .env file if there is one
  • Design receiving client
  • Publish address through VPN API so vpn client can grab it

This change is Reviewable

@simonwicky simonwicky requested a review from octol as a code owner November 7, 2024 13:41
@simonwicky simonwicky requested review from jstuczyn and removed request for octol November 7, 2024 13:41
Copy link

vercel bot commented Nov 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-nextra ⬜️ Ignored (Inspect) Visit Preview Nov 8, 2024 11:09am
nym-explorer ⬜️ Ignored (Inspect) Visit Preview Nov 8, 2024 11:09am
nym-next-explorer ⬜️ Ignored (Inspect) Visit Preview Nov 8, 2024 11:09am

@simonwicky simonwicky requested review from octol and jmwample November 7, 2024 13:41
@simonwicky simonwicky added this to the Crunch milestone Nov 7, 2024
Copy link
Contributor

@octol octol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for incorporating the stats reporting we need for the UI :)

@simonwicky simonwicky merged commit b09ac57 into develop Nov 8, 2024
21 checks passed
@simonwicky simonwicky deleted the simon/client_stats branch November 8, 2024 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants