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 analytics wiring RPC functions #4111

Merged
merged 7 commits into from
Jan 9, 2025
Merged

Add analytics wiring RPC functions #4111

merged 7 commits into from
Jan 9, 2025

Conversation

mathemancer
Copy link
Contributor

Fixes #4110

Adds:

  • analytics.view_report, An RPC function to show an example usage report.
  • analytics.initialize, An RPC function to turn on analytics reporting
  • analytics.disable, An RPC function to disable analytics reporting
  • mathesar.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 and MATHESAR_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

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@mathemancer mathemancer added the pr-status: review A PR awaiting review label Jan 7, 2025
mathesar/rpc/analytics.py Outdated Show resolved Hide resolved
mathesar/analytics.py Show resolved Hide resolved
Copy link
Member

@pavish pavish left a 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.

@pavish pavish removed their assignment Jan 8, 2025
@mathemancer mathemancer requested a review from Anish9901 January 9, 2025 04:08
Copy link
Member

@Anish9901 Anish9901 left a comment

Choose a reason for hiding this comment

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

LGTM!

@Anish9901 Anish9901 enabled auto-merge January 9, 2025 15:27
@Anish9901 Anish9901 added this pull request to the merge queue Jan 9, 2025
Merged via the queue into develop with commit 60e95bf Jan 9, 2025
74 checks passed
@Anish9901 Anish9901 deleted the analytics_pt_2 branch January 9, 2025 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: review A PR awaiting review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement analytics RPC functions for new design
3 participants