-
-
Notifications
You must be signed in to change notification settings - Fork 338
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 analytics wiring RPC functions #4111
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Anish9901
requested changes
Jan 8, 2025
pavish
approved these changes
Jan 8, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code & documentation is good for me to get started on the frontend.
Anish9901
approved these changes
Jan 9, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #4110
Adds:
analytics.view_report
, An RPC function to show an example usage report.analytics.initialize
, An RPC function to turn on analytics reportinganalytics.disable
, An RPC function to disable analytics reportingmathesar.analytics.upload_initial_report
, A Mathesar-layer function to handle one-time installation report (used by template)There was already a function
mathesar.analytics.initialize_analytics
, A Mathesar-layer function to turn on usage statistics (used by template), so this didn't need implementing.Technical details
For now, the analytics URLS are hardcoded in Prod mode, but aren't in dev mode at all. To add analytics wiring for dev mode, copy the production settings for
MATHESAR_ANALYTICS_URL
andMATHESAR_INIT_REPORT_URL
to your.env
file. This should only be used for testing analytics wiring. Avoid leaving those variables set in dev mode, since that will cause your dev setup to emit analytics reports to our actual collector infrastructure.Checklist
Update index.md
).develop
branch of the repositoryvisible errors.
Developer Certificate of Origin
Developer Certificate of Origin