Merge branch '267994-add-feature-attribute-to-known-_events-yml' into 'master'

Add feature attribute to known_events.yml

See merge request gitlab-org/gitlab!46853

doc/development/product_analytics/usage_ping.md

@@ -312,6 +312,7 @@ Implemented using Redis methods [PFADD](https://redis.io/commands/pfadd) and [PF
    - `aggregation`: aggregation `:daily` or `:weekly`. The argument defines how we build the Redis
      keys for data storage. For `daily` we keep a key for metric per day of the year, for `weekly` we
      keep a key for metric per week of the year.
+   - `feature_flag`: optional. For details, see our [GitLab internal Feature flags](../feature_flags/) documentation.
 
 1. Track event in controller using `RedisTracking` module with `track_redis_hll_event(*controller_actions, name:, feature:, feature_default_enabled: false)`.
 
@@ -402,7 +403,7 @@ Implemented using Redis methods [PFADD](https://redis.io/commands/pfadd) and [PF
    | `event` | string | yes | The event name it should be tracked |
 
    Response
-w
+
    Return 200 if tracking failed for any reason.
 
    - `200` if event was tracked or any errors
@@ -454,6 +455,20 @@ Recommendations:
 - Use a [feature flag](../../operations/feature_flags.md) to have a control over the impact when
   adding new metrics.
 
+##### Enable/Disable Redis HLL tracking
+
+Events are tracked behind [feature flags](../feature_flags/index.md) due to concerns for Redis performance and scalability.
+
+For a full list of events and coresponding feature flags see, [known_events](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/usage_data_counters/known_events/) files.
+
+To enable or disable tracking for specific event within <https://gitlab.com> or <https://staging.gitlab.com>, run commands such as the following to
+[enable or disable the corresponding feature](../feature_flags/index.md).
+
+```shell
+/chatops run feature set <feature_name> true
+/chatops run feature set <feature_name> false
+```
+
 ##### Known events in usage data payload
 
 All events added in [`known_events/common.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/usage_data_counters/known_events/common.yml) are automatically added to usage data generation under the `redis_hll_counters` key. This column is stored in [version-app as a JSON](https://gitlab.com/gitlab-services/version-gitlab-com/-/blob/master/db/schema.rb#L209).

lib/gitlab/usage_data_counters/hll_redis_counter.rb

@@ -35,6 +35,7 @@ module Gitlab
       #   category: compliance         # Group events in categories
       #   expiry: 29                   # Optional expiration time in days, default value 29 days for daily and 6.weeks for weekly
       #   aggregation: daily           # Aggregation level, keys are stored daily or weekly
+      #   feature_flag:                # The event feature flag
       #
       # Usage:
       #

lib/gitlab/usage_data_counters/known_events/common.yml

@@ -4,114 +4,141 @@
   redis_slot: compliance
   category: compliance
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: g_compliance_audit_events
   category: compliance
   redis_slot: compliance
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: i_compliance_audit_events
   category: compliance
   redis_slot: compliance
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: i_compliance_credential_inventory
   category: compliance
   redis_slot: compliance
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: a_compliance_audit_events_api
   category: compliance
   redis_slot: compliance
   aggregation: weekly
+  feature_flag: usage_data_a_compliance_audit_events_api
 # Analytics category
 - name: g_analytics_contribution
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: g_analytics_insights
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: g_analytics_issues
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: g_analytics_productivity
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: g_analytics_valuestream
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: p_analytics_pipelines
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: p_analytics_code_reviews
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: p_analytics_valuestream
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: p_analytics_insights
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: p_analytics_issues
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: p_analytics_repo
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: i_analytics_cohorts
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: i_analytics_dev_ops_score
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: g_analytics_merge_request
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: p_analytics_merge_request
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: i_analytics_instance_statistics
   category: analytics
   redis_slot: analytics
   aggregation: weekly
+  feature_flag: track_unique_visits
 - name: g_edit_by_web_ide
   category: ide_edit
   redis_slot: edit
   expiry: 29
   aggregation: daily
+  feature_flag: track_editor_edit_actions
 - name: g_edit_by_sfe
   category: ide_edit
   redis_slot: edit
   expiry: 29
   aggregation: daily
+  feature_flag: track_editor_edit_actions
 - name: g_edit_by_snippet_ide
   category: ide_edit
   redis_slot: edit
   expiry: 29
   aggregation: daily
+  feature_flag: track_editor_edit_actions
 - name: i_search_total
   category: search
   redis_slot: search
   aggregation: weekly
+  feature_flag: search_track_unique_users
 - name: i_search_advanced
   category: search
   redis_slot: search
   aggregation: weekly
+  feature_flag: search_track_unique_users
 - name: i_search_paid
   category: search
   redis_slot: search
   aggregation: weekly
+  feature_flag: search_track_unique_users
 - name: wiki_action
   category: source_code
   aggregation: daily
@@ -136,194 +163,242 @@
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_alert_status_changed
 - name: incident_management_alert_assigned
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_alert_assigned
 - name: incident_management_alert_todo
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_alert_todo
 - name: incident_management_incident_created
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_incident_created
 - name: incident_management_incident_reopened
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_incident_reopened
 - name: incident_management_incident_closed
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_incident_closed
 - name: incident_management_incident_assigned
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_incident_assigned
 - name: incident_management_incident_todo
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_incident_todo
 - name: incident_management_incident_comment
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_incident_comment
 - name: incident_management_incident_zoom_meeting
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_incident_zoom_meeting
 - name: incident_management_incident_published
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_incident_published
 - name: incident_management_incident_relate
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_incident_relate
 - name: incident_management_incident_unrelate
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_incident_unrelate
 - name: incident_management_incident_change_confidential
   redis_slot: incident_management
   category: incident_management
   aggregation: weekly
+  feature_flag: usage_data_incident_management_incident_change_confidential
 # Testing category
 - name: i_testing_test_case_parsed
   category: testing
   redis_slot: testing
   aggregation: weekly
+  feature_flag: usage_data_i_testing_test_case_parsed
 # Project Management group
 - name: g_project_management_issue_title_changed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_description_changed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_assignee_changed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_made_confidential
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_made_visible
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_created
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_closed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_reopened
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_label_changed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_milestone_changed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_iteration_changed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_weight_changed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_cross_referenced
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_moved
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_related
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_unrelated
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_marked_as_duplicate
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_locked
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_unlocked
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_added_to_epic
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_removed_from_epic
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_changed_epic
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_designs_added
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_designs_modified
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_designs_removed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_due_date_changed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_time_estimate_changed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_time_spent_changed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_comment_added
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_comment_edited
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_comment_removed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 - name: g_project_management_issue_health_status_changed
   category: issues_edit
   redis_slot: project_management
   aggregation: daily
+  feature_flag: track_issue_activity_actions
 # Secrets Management
 - name: i_ci_secrets_management_vault_build_created
   category: ci_secrets_management
   redis_slot: ci_secrets_management
   aggregation: weekly
+  feature_flag: usage_data_i_ci_secrets_management_vault_build_created