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

[DevToolbar] Analytics for which orgs have the toolbar enabled #33

Open
ryan953 opened this issue Sep 23, 2024 · 2 comments · Fixed by getsentry/sentry#78778
Open

[DevToolbar] Analytics for which orgs have the toolbar enabled #33

ryan953 opened this issue Sep 23, 2024 · 2 comments · Fixed by getsentry/sentry#78778
Assignees

Comments

@ryan953
Copy link
Member

ryan953 commented Sep 23, 2024

I would like to have metrics/analytics on the server side to show what endpoints the toolbar is hitting. This should be possible by looking at incoming requests to the api where the ?queryReferrer=devtoolbar url query param is set.

The purpose of these metrics/analytics would be to:

  • Detect when an organization and/or project has setup the toolbar
    • "has setup the toolbar" also depends on having the project setting configured, which is another metric we should have visibility into
  • Log the volume of api requests generated by people using the toolbar. it shouldn't ever generate so much load as to be an issue, but we should have visibility into it
  • See which endpoints are hit most often from the toolbar, so we can infer usage of different panels
  • See which endpoints ar ehit most often from the toolabr, so we can think about optimizations to better suit use-cases

With this kind of backend logging we'd be able to make a trade-off: no user-specific logging, but it's also not something users can opt-out of. We want to observe the infra and load.

So we should aim to create some charts like:

  • Total number of orgs using (sending requests with the query param) the toolbar
  • Total number of projects using (sending requests to a specific endpoint with the query param) the toolbar
  • Total unique viewers/users of the toolbar
  • unique users per org
  • Volume of requests per endpoint, where the query param is set.

It would also be cool to have stats about the orgs that are using the toolbar. So like a table with columns: "org_slug, # of users total, # toolbar users, # issues, # issues resvoled" So that we can start to learn about how the toolbar can be more helpful. This might not need to be on a dashboard, more like a one-off (or something we query every month) kind of query.

@aliu39
Copy link
Member

aliu39 commented Oct 8, 2024

@ryan953 could you link the sample dashboards/charts we were looking at?

Update: nvm, I remembered they're Hydration Errors, Rage Clicks, and Replays Search in redash. If there's other good examples lmk.

@aliu39 aliu39 self-assigned this Oct 8, 2024
aliu39 added a commit to getsentry/sentry that referenced this issue Oct 15, 2024
Closes getsentry/sentry-toolbar#33

We're ready to release a developer toolbar for installation on 3rd party
sites. Once installed, toolbars will query sentry backend for data - see
the [repo](https://github.com/getsentry/sentry-toolbar) or /devtoolbar
folder of sentry for examples. This helps us get analytics on every
endpoint, whenever the `querryReferrer=devtoolbar` header is included.
@ryan953 ryan953 reopened this Oct 17, 2024
@ryan953
Copy link
Member Author

ryan953 commented Oct 17, 2024

Lets throw up a dashboard with some of these numbers, then close this puppy afterwards.

@ryan953 ryan953 closed this as completed Oct 17, 2024
@ryan953 ryan953 reopened this Oct 17, 2024
cmanallen pushed a commit to getsentry/sentry that referenced this issue Oct 23, 2024
Closes getsentry/sentry-toolbar#33

We're ready to release a developer toolbar for installation on 3rd party
sites. Once installed, toolbars will query sentry backend for data - see
the [repo](https://github.com/getsentry/sentry-toolbar) or /devtoolbar
folder of sentry for examples. This helps us get analytics on every
endpoint, whenever the `querryReferrer=devtoolbar` header is included.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants