Merge branch '58304-extend-the-snowplow-event-tracking-documentation-with-a-testing-section' into 'master'
Resolve "Extend the "Snowplow event tracking" documentation with a "testing" section" See merge request gitlab-org/gitlab-ce!25612
This commit is contained in:
commit
31cf53df4d
|
@ -1,6 +1,6 @@
|
||||||
# Event Tracking
|
# Event Tracking
|
||||||
|
|
||||||
We use [Snowplow](https://github.com/snowplow/snowplow) for tracking custom events.
|
We use [Snowplow](https://github.com/snowplow/snowplow) for tracking custom events (available in GitLab [Enterprise Edition](https://about.gitlab.com/pricing/) only).
|
||||||
|
|
||||||
## Generic tracking function
|
## Generic tracking function
|
||||||
|
|
||||||
|
@ -72,3 +72,20 @@ Below is a list of supported `data-track-*` attributes:
|
||||||
| `data-track-value` | The `value` in `trackEvent`. If omitted, this will be `target.value` or empty string. For checkboxes, the default value being tracked will be the element's checked attribute if `data-track-value` is omitted. | false |
|
| `data-track-value` | The `value` in `trackEvent`. If omitted, this will be `target.value` or empty string. For checkboxes, the default value being tracked will be the element's checked attribute if `data-track-value` is omitted. | false |
|
||||||
|
|
||||||
Since Snowplow is an Enterprise Edition feature, it's necessary to create a CE backport when adding `data-track-*` attributes to HAML templates in most cases.
|
Since Snowplow is an Enterprise Edition feature, it's necessary to create a CE backport when adding `data-track-*` attributes to HAML templates in most cases.
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
Snowplow can be enabled by navigating to:
|
||||||
|
|
||||||
|
- **Admin area > Settings > Integrations** in the UI.
|
||||||
|
- `admin/application_settings/integrations` in your browser.
|
||||||
|
|
||||||
|
The following configuration is required:
|
||||||
|
|
||||||
|
| Name | Value |
|
||||||
|
| ------------- | ------------------------- |
|
||||||
|
| Collector | `snowplow.trx.gitlab.net` |
|
||||||
|
| Site ID | `gitlab` |
|
||||||
|
| Cookie domain | `.gitlab.com` |
|
||||||
|
|
||||||
|
Now the implemented tracking events can be inspected locally by looking at the network panel of the browser's development tools.
|
||||||
|
|
Loading…
Reference in New Issue