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 #4049

Merged
merged 23 commits into from
Dec 10, 2024
Merged

Add analytics wiring #4049

merged 23 commits into from
Dec 10, 2024

Conversation

mathemancer
Copy link
Contributor

@mathemancer mathemancer commented Dec 6, 2024

Related to #4063

This adds some machinery to collect and transmit analytics data reports to a URL specified in the settings.

Technical details

  • The AnalyticsReport model shows all information collected.
  • This PR does not include any way to turn the analytics on or off, except from the Django shell. They are disabled by default.
  • If one enables the analytics reporting (using the Django shell), then
    • Reports are saved to the AnalyticsReport model once per day.
    • We attempt to then transmit the analytics reports after saving one. Without adding a URL to receive the reports to the environment variables, this will fail.

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 changed the title Add analytics simple Add analytics wiring Dec 6, 2024
@mathemancer mathemancer marked this pull request as draft December 6, 2024 07:30
@mathemancer mathemancer requested a review from Anish9901 December 9, 2024 07:12
@mathemancer mathemancer added the pr-status: review A PR awaiting review label Dec 9, 2024
@mathemancer mathemancer added this to the v0.2.0 (beta release) milestone Dec 9, 2024
@mathemancer mathemancer marked this pull request as ready for review December 9, 2024 08:12
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! I'm curious about why the MATHESAR_ANALYTICS_URL isn't added in the docker-compose.yml

db/sql/00_msar.sql Outdated Show resolved Hide resolved
@mathemancer
Copy link
Contributor Author

LGTM! I'm curious about why the MATHESAR_ANALYTICS_URL isn't added in the docker-compose.yml

I plan to remove that environment variable anyway. We'll hardcode the URL in the settings file. But, I don't want to publish the URL until we have some DDOS, etc. protection on it. So, I set it up so a core team developer can just use an environment variable while testing without risking accidentally committing the URL in the settings file.

@mathemancer mathemancer added this pull request to the merge queue Dec 10, 2024
Merged via the queue into develop with commit f040c7f Dec 10, 2024
73 checks passed
@mathemancer mathemancer deleted the add_analytics_simple branch December 10, 2024 16:21
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.

2 participants