Skip to content
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

Implement "Enable Metrics" setting #1816

Merged
merged 3 commits into from
Jan 20, 2024
Merged

Implement "Enable Metrics" setting #1816

merged 3 commits into from
Jan 20, 2024

Conversation

NicusorN5
Copy link
Contributor

@NicusorN5 NicusorN5 commented Sep 21, 2023

PR Details

Implement a setting that allows toggling usage of metrics.

Description

Just implemented the setting. Tested by debugging values at runtime.

Related Issue

#1815

Motivation and Context

As requested by some Discord users. And also refer to the issue #1815 .

Types of changes

  • [N/A] Docs change / refactoring / dependency upgrade
  • [N/A] Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • [N/A] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My change requires a change to the documentation. (May require a change in the privacy policy?)
  • [N/A] I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have built and run the editor

@tebjan
Copy link
Member

tebjan commented Sep 24, 2023

I think before we merge this, it also needs a consideration of how stride metrics is communicated. A merely functional change will probably lead to no one enabling it due to a general aversion to data collecting. It needs to be clear that the metrics are anonymous, nothing is stored anywhere, and that the data is public and open-source. Ideally also an easy-to-understand overview of what exactly is sent.

@Aggror
Copy link
Member

Aggror commented Oct 1, 2023

Once I have wiki access, I will add a page on this. @tebjan

@JeromyWalsh
Copy link
Collaborator

I think being able to articulate how the metrics are being used is important, not only for the engine end-users but us as developers. As a general rule, metrics should only be gathered on an as-needed basis, and only to answer specific questions with clearly defined action-items that will result from the gathered metrics.

Gathering metrics with no idea how it's going to be used, or with no actionable outcome regardless of the data gathered should be discouraged. When we enable new metrics it should come with an invitation to help us make a decision about "X" feature or issue, by granting us the metrics we need to make the decision.

@xen2
Copy link
Member

xen2 commented Oct 2, 2023

LGTM, it's still keeping it on by default as far as I understood.

@JeromyWalsh We don't have any specific behavior metric (yet).
It's only counting install, basic usage (per version, country, etc.), which platforms are being used (useful to know which one to phase out).

@tebjan
Copy link
Member

tebjan commented Oct 2, 2023

I noticed that this is only a setting in Game Studio, not in the installer dialog. Is there a clearer way to phrase: "Enable collecting data such as uptime, software usage"?
This explanation doesn't clarify the actual process and might raise concerns for people who prioritize privacy.

@tebjan
Copy link
Member

tebjan commented Oct 2, 2023

Maybe:

Name: "Usage Analytics"

Description: "Anonymous usage analytics to help the Stride community improve the software. Statistics on installation, version-specific usage, and platform popularity. The data is open-source at https://metrics.stride3d.net"

@Eideren
Copy link
Collaborator

Eideren commented Oct 29, 2023

Will move this to draft while @NicusorN5 gets back to us with those last few questions

@Eideren Eideren marked this pull request as draft October 29, 2023 03:44
@NicusorN5
Copy link
Contributor Author

Hi, I was missing for a while, because my third university year started, so I was left behind regarding what's happening with this PR.

I will consider rewording the description and name.

@NicusorN5
Copy link
Contributor Author

NicusorN5 commented Oct 30, 2023

I hope this is okay as it is. I'm also not sure how to resolve the merge conflict that appeared.

U1: I updated the initial post. I have obviously recompiled and opened the editor.

@NicusorN5 NicusorN5 marked this pull request as ready for review October 30, 2023 13:01
@Eideren
Copy link
Collaborator

Eideren commented Oct 30, 2023

Fixed the merge conflict, I'll let @tebjan merge this one

@NicusorN5
Copy link
Contributor Author

bump

@Eideren Eideren requested a review from tebjan December 28, 2023 19:34
@Eideren
Copy link
Collaborator

Eideren commented Dec 28, 2023

We'll likely merge this one after the official 4.2 but sent a request to tebjan to get his input anyway

@Eideren Eideren merged commit 6e8e532 into stride3d:master Jan 20, 2024
1 check passed
@Eideren
Copy link
Collaborator

Eideren commented Jan 20, 2024

Thanks !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants