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.

Sign up for GitHub

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

Jump to bottom

feat: adding Scarf pixels to gather telemetry on readme and website #25065

Merged
merged 4 commits into from
Aug 24, 2023
Merged

feat: adding Scarf pixels to gather telemetry on readme and website #25065

merged 4 commits into from
Aug 24, 2023

Conversation

rusackas
Copy link
Member

SUMMARY

This PR adds two distinct tracking pixels for telemetry, using the Scarf platform. One is added to the readme to capture analytics around visits to the repo, and one captures visits to the website/docs.

All of this data will be available to interested PMC members, and reported periodically in things like Superset Board Reports and Superset Town Hall events.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N/A

TESTING INSTRUCTIONS

Log into Scarf and see the charts ticking!

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@codecov
Copy link

codecov bot commented Aug 23, 2023 •
edited
Loading

Codecov Report

Merging #25065 (d2b422c) into master (adaab35) will not change coverage.
Report is 2 commits behind head on master.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #25065   +/-   ##
=======================================
  Coverage   68.89%   68.89%           
=======================================
  Files        1906     1906           
  Lines       74625    74625           
  Branches     8208     8208           
=======================================
  Hits        51410    51410           
  Misses      21085    21085           
  Partials     2130     2130
Flag Coverage Δ
hive 53.77% <ø> (ø)
javascript 55.90% <ø> (ø)
mysql 78.38% <ø> (ø)
postgres 78.47% <ø> (ø)
presto 53.67% <ø> (ø)
python 82.88% <ø> (ø)
sqlite 77.11% <ø> (ø)
unit 55.08% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

villebro
villebro reviewed Aug 23, 2023
View reviewed changes
Copy link
Member

@villebro villebro left a comment

Choose a reason for hiding this comment

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

Minor comment

docs/docusaurus.config.js
@@ -252,7 +252,9 @@ const config = {
<a href="https://apache.org/events/current-event" target="_blank" rel="noreferrer">Events</a>&nbsp;|&nbsp;
<a href="https://apache.org/licenses/" target="_blank" rel="noreferrer">License</a>
</small>
</p>`,
</p>
<img referrerPolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68" />
Copy link
Member

Choose a reason for hiding this comment

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

Should we add <!-- telemetry/analytics pixel: --> here, too?

villebro
villebro approved these changes Aug 23, 2023
View reviewed changes
Copy link
Member

@villebro villebro left a comment

Choose a reason for hiding this comment

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

LGTM, looking forward to seeing the stats, this will really help improve our docs

@villebro
Copy link
Member

@rusackas btw, there's also CONTRIBUTING.md that we may want to track, and maybe the resources/INTHEWILD.md and other friends, too

@rusackas
Copy link
Member Author

I'll add something to the docs and/or readme about telemetry about the aggregated data collected from processing (and the deleting) your IP, though ironically you would have been pixellated(?) by the time you've read it.

@rusackas
Copy link
Member Author

@rusackas btw, there's also CONTRIBUTING.md that we may want to track, and maybe the resources/INTHEWILD.md and other friends, too

Yes indeed... and the wiki, potentially... lots more to expand into.

@rusackas rusackas merged commit 60c2ac3 into master Aug 24, 2023
@davidnoyes davidnoyes mentioned this pull request Jan 30, 2024
Merged
cccs-rc pushed a commit to CybercentreCanada/superset that referenced this pull request Mar 6, 2024
@rusackas
feat: adding Scarf pixels to gather telemetry on readme and website (a…
3c9adb3 
…pache#25065)
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 3.1.0 labels Mar 8, 2024
@mistercrunch mistercrunch deleted the scarf-pixel-telemetry branch March 26, 2024 18:04
kaxil added a commit to astronomer/airflow that referenced this pull request May 9, 2024
@kaxil
Add Scarf Pixel to Readme
58bd4f0 
Similar to apache/superset#25065 and apache#39510 but this one doesn't need to wait for the VOTE since this embed it to Readme. More detail in https://docs.scarf.sh/web-traffic/

All of this data will be available to interested PMC members, and reported periodically in things like Town Hall & newsletters.
@kaxil kaxil mentioned this pull request May 9, 2024
Merged
kaxil added a commit to apache/airflow that referenced this pull request May 9, 2024
@kaxil
Add Scarf Pixel to Readme (#39533)
08a8028 
Similar to apache/superset#25065 and #39510 but this one doesn't need to wait for the VOTE since this embed it to Readme. More detail in https://docs.scarf.sh/web-traffic/

All of this data will be available to interested PMC members, and reported periodically in things like Town Hall & newsletters.
kaxil added a commit to kaxil/airflowsummit-website that referenced this pull request May 9, 2024
@kaxil
Add Scarf Pixel to Airflow Summit
073d83d 
Similar to apache/superset#25065 and apache/airflow#39533 to get Telemtry Data. More detail in https://docs.scarf.sh/web-traffic/

All of this data will be available to interested PMC members, and reported periodically in things like Town Hall & newsletters to know where we should organize meetups.

Discussion thread: https://lists.apache.org/thread/7f6qyr8w2n8w34g63s7ybhzphgt8h43m
Vote thread: https://lists.apache.org/thread/h1x2glvnd42rbj2q2rgpfo3pjhmpt307
@kaxil kaxil mentioned this pull request May 9, 2024
Merged
kaxil added a commit to apache/airflow-site that referenced this pull request May 10, 2024
@kaxil
Add Scarf Pixel to Airflow RTD Theme
6dd0aba 
Similar to apache/superset#25065 and apache/airflow#39510 but this one doesn't need to wait for the VOTE since this adds a simple transparent tracking pixel. More detail in https://docs.scarf.sh/web-traffic/

All of this data will be available in Scarf, creds for which are shared to 1password for PMC members, and can be reported periodically in things like Town Hall or newsletters.
@kaxil kaxil mentioned this pull request May 10, 2024
Merged
kaxil added a commit to apache/airflow-site that referenced this pull request May 10, 2024
@kaxil
Add Scarf Pixel to Airflow RTD Theme (#1012)
43517d2 
Similar to apache/superset#25065 and apache/airflow#39510 but this one doesn't need to wait for the VOTE since this adds a simple transparent tracking pixel. More detail in https://docs.scarf.sh/web-traffic/

All of this data will be available in Scarf, creds for which are shared to 1password for PMC members, and can be reported periodically in things like Town Hall or newsletters.
pateash pushed a commit to pateash/airflow that referenced this pull request May 13, 2024
@kaxil @pateash
Add Scarf Pixel to Readme (apache#39533)
b40d4e9 
Similar to apache/superset#25065 and apache#39510 but this one doesn't need to wait for the VOTE since this embed it to Readme. More detail in https://docs.scarf.sh/web-traffic/

All of this data will be available to interested PMC members, and reported periodically in things like Town Hall & newsletters.
romsharon98 pushed a commit to romsharon98/airflow that referenced this pull request Jul 26, 2024
@kaxil @romsharon98
Add Scarf Pixel to Readme (apache#39533)
3a3164e 
Similar to apache/superset#25065 and apache#39510 but this one doesn't need to wait for the VOTE since this embed it to Readme. More detail in https://docs.scarf.sh/web-traffic/

All of this data will be available to interested PMC members, and reported periodically in things like Town Hall & newsletters.
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this pull request Nov 9, 2024
@kaxil
Add Scarf Pixel to Readme (#39533)
7e2d783 
Similar to apache/superset#25065 and apache/airflow#39510 but this one doesn't need to wait for the VOTE since this embed it to Readme. More detail in https://docs.scarf.sh/web-traffic/

All of this data will be available to interested PMC members, and reported periodically in things like Town Hall & newsletters.

GitOrigin-RevId: 08a8028faefff2ed1002291b4bf6e522e8e6ed0f
vinothkumar66 pushed a commit to vinothkumar66/superset that referenced this pull request Nov 11, 2024
@rusackas
feat: adding Scarf pixels to gather telemetry on readme and website (a…
f71649f 
…pache#25065)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eschutho eschutho eschutho approved these changes

@villebro villebro villebro approved these changes

@michael-s-molina michael-s-molina Awaiting requested review from michael-s-molina

@john-bodley john-bodley Awaiting requested review from john-bodley

Assignees
No one assigned
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/XS 🚢 3.1.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rusackas @villebro @eschutho @mistercrunch