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

Better example/tutorial detection for analytics #2967

Closed
emilk opened this issue Aug 11, 2023 · 2 comments · Fixed by #3112
Closed

Better example/tutorial detection for analytics #2967

emilk opened this issue Aug 11, 2023 · 2 comments · Fixed by #3112
Assignees
Labels
📊 analytics telemetry analytics

Comments

@emilk
Copy link
Member

emilk commented Aug 11, 2023

Our tutorials suggest copy-pasting some code to get started with Rerun. Our analytics will then be fooled into thinking this is real user data.

I suggest we add a example- prefix to all our example app_ids, e.g. rr.init("example-dna", …). We then detect examples based on this prefix.

There is a risk users will just copy-paste the rr.init lint into their own production code, but we will soon show the app id in the viewer (#2938), so my guess is they will notice it pretty quickly and change it.

@emilk emilk added the 📊 analytics telemetry analytics label Aug 11, 2023
@emilk emilk added this to the 0.9 milestone Aug 11, 2023
@nikolausWest
Copy link
Member

I suggest we go with something even more obvious and human readable to make it more readable like rr.init("Rerun Usage Example: DNA", ...). It's a bit embarrassing to have your internal demo titled "Rerun Usage Example". It really makes it look like you just copy pasted code =)

@emilk
Copy link
Member Author

emilk commented Aug 12, 2023

rr.init("I am a lazy ape copy-pasting an official Rerun example: DNA", …)

@emilk emilk added the 🏎️ Quick Issue Can be fixed in a few hours or less label Aug 25, 2023
@emilk emilk self-assigned this Aug 25, 2023
@emilk emilk removed their assignment Aug 25, 2023
@emilk emilk removed the 🏎️ Quick Issue Can be fixed in a few hours or less label Aug 25, 2023
@emilk emilk self-assigned this Aug 28, 2023
emilk added a commit that referenced this issue Aug 29, 2023
### What
* Closes #2967

The exact prefix is not super important. Once there, we can
search-replace easily.

I also added the `app_id_starts_with_rerun_example` analytics signal for
this (needed since we hash the app id).
The old `is_official_example` is still there (its not implemented for
C++ though).

Review commit-by-commit

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/3112) (if
applicable)

- [PR Build Summary](https://build.rerun.io/pr/3112)
- [Docs
preview](https://rerun.io/preview/fd985a5a2b561385c581bdf66e8bb1d4fe684ccb/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/fd985a5a2b561385c581bdf66e8bb1d4fe684ccb/examples)
<!--EXAMPLES-PREVIEW--><!--EXAMPLES-PREVIEW--><!--EXAMPLES-PREVIEW--><!--EXAMPLES-PREVIEW--><!--EXAMPLES-PREVIEW--><!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📊 analytics telemetry analytics
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants