Add tracking for "Find file" feature (repository)
Objective
Feature adoption and engagement
- How often do users search for files?
-
When a user searches for a file, do they use the find file button or the
t
shortcut? - Which pages are they mostly searching from?
Events and Metrics
Definition of events and metrics | Sample metrics | Sample events
Details of events to be tracked:
Event Description | Event Name | Additional Properties | Feature |
---|---|---|---|
Searched for files by triggering Find file button on Repository pages | click_find_file_button_on_repository_pages | File finder | |
Searched for files by triggering Go to file shortcut | click_go_to_file_shortcut | File finder |
Details of metrics to be tracked:
Metric Description | Event / DB column to base the Metric on | Total or Unique Count of a Property | Time Frame | Feature |
---|---|---|---|---|
Weekly count of unique users who searched for files via Find file button | click_find_file_button_on_repository_pages | user_id |
7d | File finder |
Monthly count of unique users who searched for files via Find file button | click_find_file_button_on_repository_pages | user_id |
28d | File finder |
Weekly count of unique users who searched for files via shortcut | click_go_to_file_shortcut | user_id |
7d | File finder |
Monthly count of unique users who searched for files via shortcut | click_go_to_file_shortcut | user_id |
28d | File finder |
Expand to view examples and guidelines for filling the table
Events:
- Description: Include what the event is supposed to track, where and when.
-
Name: Primary identifier of the event, format: <action>_<target_of_action>_<where/when>
- Example event name: click_save_button_in_issue_description_within_15s_of_page_load (action = click ; target = save button; where = in issue description ; when = within 15s
- **Additional properties: Besides user/project/namespace, what other details should be tracked, if any? ex) status, type, object id, etc.
- Feature: What feature is being instrumented? Please use the feature title that is used in features.yml if thats already available.
Metrics:
- Description: What quantitative measurements derived from either event data or database columns would you like to track? eg: Weekly count of unique users who update an issue
- Event/DB column: What event or database column should the metric count or be based on.
-
Total or unique count: Should the metric count all occurrences or only unique counts, e.g. of
user_id
to get a count of unique users triggering an event. - Time Frame: What time frames should be tracked. Default and recommended is 7d and 28d.
Next steps
-
Assign an engineering counterpart from your group to add instrumentation to the code -
Explore instrumented data with the help of our data discovery guide. You can also reach out to product data insights team for help with generating Tableau reports/dashboards. -
Your feedback is valuable to us. Please leave us feedback in the comment section of this issue and tag @tjayaramaraju or @Basti
Important links
Edited by Paulina Sedlak-Jakubowska