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

Add code to regularly send basic statistics to Opencast for adopter registration #878

Merged
merged 3 commits into from
Jul 12, 2023

Conversation

LukasKalbertodt
Copy link
Member

Related Opencast PR: opencast/opencast#5040

Still draft as there are open questions and this does not yet work with above PR.

I think the statistics sent here are very basic and don't contain any too sensitive data. And in any case, the data is only sent outside of ones installation if they agreed to sharing basic data as part of the adopter registration. Otherwise it's completely discarded/unused. And sending it from Tobira to Opencast is also no problem as that connection needs to be private anyway, as all Opencast data will go through it. So I don't see how anyone could have a privacy concern regarding this. See the structs at the bottom of stats.rs to see what exactly is sent.

@LukasKalbertodt LukasKalbertodt added the changelog:admin Changes primarily for admins label Jun 15, 2023
@github-actions github-actions bot temporarily deployed to test-deployment-pr878 June 15, 2023 11:44 Destroyed
@github-actions github-actions bot temporarily deployed to test-deployment-pr878 June 19, 2023 07:40 Destroyed
@github-actions github-actions bot temporarily deployed to test-deployment-pr878 June 19, 2023 07:47 Destroyed
@gregorydlogan
Copy link
Contributor

gregorydlogan commented Jul 10, 2023

Question about the version data: Do you anticipate a lot of self-builds? Can we just track the tag or hash?

Edit: Also, log(in|out)_link_overwritten should maybe be overridden? Unless you mean the visible text rather than what the link does.

@LukasKalbertodt
Copy link
Member Author

Question about the version data: Do you anticipate a lot of self-builds? Can we just track the tag or hash?

Are you asking this to simplify version handling? So I know that at least one organization uses custom patches. The commit gives us more information than the version (same commit means same version, but same version can be used in different commits). I expect that all Tobiras in production will have git_was_dirty = false. Does this answer help in any way? :D

Edit: Also, log(in|out)_link_overwritten should maybe be overridden? Unless you mean the visible text rather than what the link does.

Oh yeah, you're correct. I'm can never remember the nuanced meaning of those two words. Will change.

@gregorydlogan
Copy link
Contributor

gregorydlogan commented Jul 11, 2023

Ok, let's keep the version data then :)

The linked server-side PR currently expects the following format sent to Opencast:

{
    "num_realms": 3631,
    "num_blocks": 5558,
    "version": {
        "identifier": "v2.0",
        "build_time_utc": "Thu, 15 Jun 2023 11:26:19 +0000",
        "git_commit_hash": "18521b24e34cd11990f6b33913fb0d7a854ab0ec",
        "git_was_dirty": true
    },
    "config": {
        "download_button_shown": true,
        "auth_mode": "login-proxy",
        "login_link_overridden": false,
        "logout_link_overridden": false,
        "uses_pre_auth": true,
        "has_narrow_logo": true
    }
}

There's a tester.sh in the root of the server which has the relevant curl line to push canned data into a test instance as well.

@LukasKalbertodt
Copy link
Member Author

I added a commit regarding ovewritten -> overridden. I guess this is ready now.

@LukasKalbertodt LukasKalbertodt marked this pull request as ready for review July 12, 2023 07:06
@github-actions github-actions bot temporarily deployed to test-deployment-pr878 July 12, 2023 07:17 Destroyed
@owi92 owi92 merged commit 7ccd9b7 into elan-ev:master Jul 12, 2023
@LukasKalbertodt LukasKalbertodt deleted the adopter-stats branch July 12, 2023 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog:admin Changes primarily for admins
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants