2021-09-30 23:02:18 +05:30
---
2022-08-13 15:12:31 +05:30
stage: Analytics
2023-06-20 00:43:36 +05:30
group: Analytics Instrumentation
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2021-09-30 23:02:18 +05:30
---
# Snowplow review guidelines
2023-07-09 08:55:56 +05:30
This page includes introductory material for an
[Analytics Instrumentation ](https://about.gitlab.com/handbook/engineering/development/analytics/analytics-instrumentation/ )
2021-09-30 23:02:18 +05:30
review, and is specific to Snowplow related reviews. For broader advice and
general best practices for code reviews, refer to our [code review guide ](../code_review.md ).
## Resources for reviewers
- [Snowplow Guide ](index.md )
2022-04-04 11:22:00 +05:30
- [Event Dictionary ](https://metrics.gitlab.com/snowplow/ )
2021-09-30 23:02:18 +05:30
## Review process
2023-07-09 08:55:56 +05:30
We recommend an Analytics Instrumentation review when a merge request (MR) involves changes in
2021-09-30 23:02:18 +05:30
events or touches Snowplow related files.
### Roles and process
#### The merge request **author** should
- For frontend events, when relevant, add a screenshot of the event in
2021-11-18 22:05:49 +05:30
the [testing tool ](implementation.md#develop-and-test-snowplow ) used.
2021-09-30 23:02:18 +05:30
- For backend events, when relevant, add the output of the
2023-05-27 22:25:52 +05:30
[Snowplow Micro ](implementation.md#test-backend-events-with-snowplow-micro ) good events
2021-09-30 23:02:18 +05:30
`GET http://localhost:9090/micro/good` (it might be a good idea
to reset with `GET http://localhost:9090/micro/reset` first).
2023-07-09 08:55:56 +05:30
- Add or update the event definition file according to the [Event Dictionary Guide ](event_dictionary_guide.md ).
2021-09-30 23:02:18 +05:30
2023-07-09 08:55:56 +05:30
#### The Analytics Instrumentation **reviewer** should
2021-09-30 23:02:18 +05:30
2023-01-13 00:05:48 +05:30
- Check that the [event schema ](index.md#event-schema ) is correct.
2021-11-18 22:05:49 +05:30
- Check the [usage recommendations ](implementation.md#usage-recommendations ).
2023-07-09 08:55:56 +05:30
- Check that an event definition file was created or updated in accordance with the [Event Dictionary Guide ](event_dictionary_guide.md ).
2021-09-30 23:02:18 +05:30
- If needed, check that the events are firing locally using one of the
2021-11-18 22:05:49 +05:30
[testing tools ](implementation.md#develop-and-test-snowplow ) available.
2021-09-30 23:02:18 +05:30
- Approve the MR, and relabel the MR with `~"product intelligence::approved"` .
2023-05-27 22:25:52 +05:30
- If the snowplow event mirrors a RedisHLL event, then tag @mdrussell to review if the payload is usable for this purpose.
