summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFatih Acet <acetfatih@gmail.com>2019-03-07 21:15:46 +0000
committerFatih Acet <acetfatih@gmail.com>2019-03-07 21:15:46 +0000
commit31cf53df4d766ef58d6d5be60d5fa2e380406fc8 (patch)
treec5618107a18fa2f28960471083538fe4f8ff6999
parent5566809c977ad6d61b6f16aad6135e6980e26b1f (diff)
parent6c89be4c884e7545c67854cef0147bf02f5bbcfd (diff)
downloadgitlab-ce-31cf53df4d766ef58d6d5be60d5fa2e380406fc8.tar.gz
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
-rw-r--r--doc/development/new_fe_guide/event_tracking.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/doc/development/new_fe_guide/event_tracking.md b/doc/development/new_fe_guide/event_tracking.md
index 1958f1ce528..6ab3fa4acf3 100644
--- a/doc/development/new_fe_guide/event_tracking.md
+++ b/doc/development/new_fe_guide/event_tracking.md
@@ -1,6 +1,6 @@
# 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
@@ -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 |
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.