Add telemetry support
What does this merge request do and why?
We are aware of challenges with the GDK (through issue creation, user feedback and personal experience) but we do not have any concrete data.
We need to start capturing data so we can start working on improving things and have data to determine results.
This MR introduces a mechanism to track usage (using GitLab product analytics) and errors (using GitLab error tracking).
See: https://gitlab.com/gitlab-com/gitlab-OKRs/-/work_items/3825 and &9255
How to set up and validate locally
-
curl https://gitlab.com/gitlab-community/gitlab-development-kit/-/raw/add-instrumentation-v2/support/install | GDK_REPO_URL=https://gitlab.com/gitlab-community/gitlab-development-kit.git GDK_CLONE_BRANCH=add-instrumentation-v2 bash
- Opt in to analytics when asked (ideally with your gitlab username)
- The product analytics dashboard isn't available yet, so you will need to ask @leetickett-gitlab to check Clickhouse to see if data has been received by the backend.
- If anything went wrong- check https://gitlab.com/gitlab-org/developer-relations/contributor-success/lee-testing/error-tracking-test/-/error_tracking (or try and force something to go wrong
😄
Impacted categories
The following categories relate to this merge request:
-
gdk-reliability - e.g. When a GDK action fails to complete. -
gdk-usability - e.g. Improvements or suggestions around how the GDK functions. -
gdk-performance - e.g. When a GDK action is slow or times out.
Merge request checklist
-
This change is backward compatible. If not, please include steps to communicate to our users. -
Tests added for new functionality. If not, please raise an issue to follow-up. -
Documentation added/updated, if needed. -
Announcement added, if change is notable. -
gdk doctor
test added, if needed. -
Add the ~highlight
label if this MR should be included in theCHANGELOG.md
.
Edited by Ash McKenzie