Commit 98c644ad authored by Evan Read's avatar Evan Read

Merge branch '327669-update-redis-hll-event-names-in-docs' into 'master'

Update Usage Ping docs Redis HLL event names

See merge request gitlab-org/gitlab!60474
parents 199760c8 8ab8f2f7
...@@ -665,7 +665,7 @@ Use one of the following methods to track events: ...@@ -665,7 +665,7 @@ Use one of the following methods to track events:
include RedisTracking include RedisTracking
skip_before_action :authenticate_user!, only: :show skip_before_action :authenticate_user!, only: :show
track_redis_hll_event :index, :show, name: 'g_compliance_example_feature_visitors' track_redis_hll_event :index, :show, name: 'users_visiting_projects'
def index def index
render html: 'index' render html: 'index'
...@@ -826,29 +826,24 @@ Example of `redis_hll_counters` data: ...@@ -826,29 +826,24 @@ Example of `redis_hll_counters` data:
```ruby ```ruby
{:redis_hll_counters=> {:redis_hll_counters=>
{"compliance"=> {"compliance"=>
{"g_compliance_dashboard_weekly"=>0, {"users_viewing_compliance_dashboard_weekly"=>0,
"g_compliance_dashboard_monthly"=>0, "users_viewing_compliance_dashboard_monthly"=>0,
"g_compliance_audit_events_weekly"=>0, "users_viewing_compliance_audit_events_weekly"=>0,
"g_compliance_audit_events_monthly"=>0, "users_viewing_audit_events_monthly"=>0,
"compliance_total_unique_counts_weekly"=>0, "compliance_total_unique_counts_weekly"=>0,
"compliance_total_unique_counts_monthly"=>0}, "compliance_total_unique_counts_monthly"=>0},
"analytics"=> "analytics"=>
{"g_analytics_contribution_weekly"=>0, {"users_viewing_analytics_group_devops_adoption_weekly"=>0,
"g_analytics_contribution_monthly"=>0, "users_viewing_analytics_group_devops_adoption_monthly"=>0,
"g_analytics_insights_weekly"=>0,
"g_analytics_insights_monthly"=>0,
"analytics_total_unique_counts_weekly"=>0, "analytics_total_unique_counts_weekly"=>0,
"analytics_total_unique_counts_monthly"=>0}, "analytics_total_unique_counts_monthly"=>0},
"ide_edit"=> "ide_edit"=>
{"g_edit_by_web_ide_weekly"=>0, {"users_editing_by_web_ide_weekly"=>0,
"g_edit_by_web_ide_monthly"=>0, "users_editing_by_web_ide_monthly"=>0,
"g_edit_by_sfe_weekly"=>0, "users_editing_by_sfe_weekly"=>0,
"g_edit_by_sfe_monthly"=>0, "users_editing_by_sfe_monthly"=>0,
"ide_edit_total_unique_counts_weekly"=>0, "ide_edit_total_unique_counts_weekly"=>0,
"ide_edit_total_unique_counts_monthly"=>0}, "ide_edit_total_unique_counts_monthly"=>0}
"search"=>
{"i_search_total_weekly"=>0, "i_search_total_monthly"=>0, "i_search_advanced_weekly"=>0, "i_search_advanced_monthly"=>0, "i_search_paid_weekly"=>0, "i_search_paid_monthly"=>0, "search_total_unique_counts_weekly"=>0, "search_total_unique_counts_monthly"=>0},
"source_code"=>{"wiki_action_weekly"=>0, "wiki_action_monthly"=>0}
} }
``` ```
...@@ -862,10 +857,10 @@ redis_usage_data { ::Gitlab::UsageCounters::PodLogs.usage_totals[:total] } ...@@ -862,10 +857,10 @@ redis_usage_data { ::Gitlab::UsageCounters::PodLogs.usage_totals[:total] }
# Define events in common.yml https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/usage_data_counters/known_events/common.yml # Define events in common.yml https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/usage_data_counters/known_events/common.yml
# Tracking events # Tracking events
Gitlab::UsageDataCounters::HLLRedisCounter.track_event('expand_vulnerabilities', values: visitor_id) Gitlab::UsageDataCounters::HLLRedisCounter.track_event('users_expanding_vulnerabilities', values: visitor_id)
# Get unique events for metric # Get unique events for metric
redis_usage_data { Gitlab::UsageDataCounters::HLLRedisCounter.unique_events(event_names: 'expand_vulnerabilities', start_date: 28.days.ago, end_date: Date.current) } redis_usage_data { Gitlab::UsageDataCounters::HLLRedisCounter.unique_events(event_names: 'users_expanding_vulnerabilities', start_date: 28.days.ago, end_date: Date.current) }
``` ```
### Alternative Counters ### Alternative Counters
...@@ -1144,9 +1139,9 @@ Example aggregated metric entries: ...@@ -1144,9 +1139,9 @@ Example aggregated metric entries:
- name: example_metrics_union - name: example_metrics_union
operator: OR operator: OR
events: events:
- 'i_search_total' - 'users_expanding_secure_security_report'
- 'i_search_advanced' - 'users_expanding_testing_code_quality_report'
- 'i_search_paid' - 'users_expanding_testing_accessibility_report'
source: redis source: redis
time_frame: time_frame:
- 7d - 7d
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment