1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
# frozen_string_literal: true
require 'rails/generators'
module Gitlab
module Analytics
class InternalEventsGenerator < Rails::Generators::Base
TIME_FRAME_DIRS = {
'all' => 'counts_all',
'7d' => 'counts_7d',
'28d' => 'counts_28d'
}.freeze
TIME_FRAMES_DEFAULT = TIME_FRAME_DIRS.keys.tap do |time_frame_defaults|
time_frame_defaults.class_eval do
def to_s
join(", ")
end
end
end.freeze
ALLOWED_TIERS = %w[free premium ultimate].dup.tap do |tiers_default|
tiers_default.class_eval do
def to_s
join(", ")
end
end
end.freeze
NEGATIVE_ANSWERS = %w[no n No NO N].freeze
POSITIVE_ANSWERS = %w[yes y Yes YES Y].freeze
TOP_LEVEL_DIR = 'config'
TOP_LEVEL_DIR_EE = 'ee'
DESCRIPTION_MIN_LENGTH = 50
DESCRIPTION_INQUIRY = %(
Please describe in at least #{DESCRIPTION_MIN_LENGTH} characters
what %{entity} %{entity_type} represents,
consider mentioning: %{considerations}.
Your answer will be processed by a full-text search tool and help others find and reuse this %{entity_type}.
).freeze
source_root File.expand_path('../../../../generator_templates/gitlab_internal_events', __dir__)
desc 'Generates metric definitions and event definition yml files'
class_option :skip_namespace,
hide: true
class_option :skip_collision_check,
hide: true
class_option :time_frames,
optional: true,
default: TIME_FRAMES_DEFAULT,
type: :array,
banner: TIME_FRAMES_DEFAULT,
desc: "Indicates the metrics time frames. Please select one or more from: #{TIME_FRAMES_DEFAULT}"
class_option :tiers,
optional: true,
default: ALLOWED_TIERS,
type: :array,
banner: ALLOWED_TIERS,
desc: "Indicates the metric's GitLab subscription tiers. Please select one or more from: #{ALLOWED_TIERS}"
class_option :group,
type: :string,
optional: false,
desc: 'Name of group that added this metric'
class_option :stage,
type: :string,
optional: false,
desc: 'Name of stage that added this metric'
class_option :section,
type: :string,
optional: false,
desc: 'Name of section that added this metric'
class_option :mr,
type: :string,
optional: false,
desc: 'Merge Request that adds this metric'
class_option :event,
type: :string,
optional: false,
desc: 'Name of the event that this metric counts'
class_option :unique,
type: :string,
optional: true,
desc: 'Name of the event property that this metric counts'
def create_metric_file
validate!
unless event_exists?
template "event_definition.yml",
event_file_path(event),
ask_description(event, "event", "what the event is supposed to track, where, and when")
end
time_frames.each do |time_frame|
template "metric_definition.yml",
metric_file_path(time_frame),
key_path(time_frame),
time_frame,
ask_description(
key_path(time_frame),
"metric",
"events, and event attributes in the description"
)
end
end
private
def event_identifiers
return unless include_default_event_properties?
"\n- project\n- user\n- namespace"
end
def include_default_event_properties?
question = <<~DESC
By convention all events automatically include the following properties:
* environment: string,
* source: string (eg: ruby, javascript)
* user_id: number
* project_id: number
* namespace_id: number
* plan: string (eg: free, premium, ultimate)
Would you like to add default properties to the event? Y(es)/N(o)
DESC
answer = Gitlab::TaskHelpers.prompt(question, POSITIVE_ANSWERS + NEGATIVE_ANSWERS)
POSITIVE_ANSWERS.include?(answer)
end
def event_file_path(event)
path = File.join(TOP_LEVEL_DIR, 'events', "#{event}.yml")
path = File.join(TOP_LEVEL_DIR_EE, path) unless free?
path
end
def event
options[:event]
end
def unique(time_frame)
return if time_frame == 'all'
"\n unique: #{options.fetch(:unique)}"
end
def ask_description(entity, type, considerations)
say("")
desc = ask(format(DESCRIPTION_INQUIRY, entity: entity, entity_type: type, considerations: considerations))
while desc.length < DESCRIPTION_MIN_LENGTH
error_msg = <<~ERROR
Provided description is too short: #{desc.length} of required #{DESCRIPTION_MIN_LENGTH} characters
ERROR
say(set_color(error_msg, :red))
desc = ask("Please provide description that is #{DESCRIPTION_MIN_LENGTH} characters long.\n")
end
desc
end
def distributions
dist = "\n"
dist += "- ce\n" if free?
"#{dist}- ee"
end
def tiers
"\n- #{options[:tiers].join("\n- ")}"
end
def milestone
Gitlab::VERSION.match('(\d+\.\d+)').captures.first
end
def class_name(time_frame)
time_frame == 'all' ? 'TotalCountMetric' : 'RedisHLLMetric'
end
def key_path(time_frame)
if time_frame == 'all'
"count_total_#{event}"
else
"count_distinct_#{options[:unique].sub('.', '_')}_from_#{event}_#{time_frame}"
end
end
def metric_file_path(time_frame)
path = File.join(TOP_LEVEL_DIR, 'metrics', TIME_FRAME_DIRS[time_frame], "#{key_path(time_frame)}.yml")
path = File.join(TOP_LEVEL_DIR_EE, path) unless free?
path
end
def validate!
validate_tiers!
%i[event mr section stage group].each do |option|
raise "The option: --#{option} is missing" unless options.key? option
end
time_frames.each do |time_frame|
validate_time_frame!(time_frame)
raise "The option: --unique is missing" if time_frame != 'all' && !options.key?('unique')
validate_key_path!(time_frame)
end
end
def validate_time_frame!(time_frame)
return if TIME_FRAME_DIRS.key?(time_frame)
raise "Invalid time frame: #{time_frame}, allowed options are: #{TIME_FRAMES_DEFAULT}"
end
def validate_tiers!
wrong_tiers = options[:tiers] - ALLOWED_TIERS
unless wrong_tiers.empty?
raise "Tiers option included not allowed values: #{wrong_tiers}. Only allowed values are: #{ALLOWED_TIERS}"
end
return unless options[:tiers].empty?
raise "At least one tier must be present. Please set --tiers option"
end
def validate_key_path!(time_frame)
return unless metric_definition_exists?(time_frame)
raise "Metric definition with key path '#{key_path(time_frame)}' already exists"
end
def event_exists?
return true if ::Gitlab::UsageDataCounters::HLLRedisCounter.known_event?(event)
existing_events_from_definitions.include?(event)
end
def existing_events_from_definitions
events_glob_path = File.join(TOP_LEVEL_DIR, 'events', "*.yml")
ee_events_glob_path = File.join(TOP_LEVEL_DIR_EE, events_glob_path)
[ee_events_glob_path, events_glob_path].flat_map do |glob_path|
Dir.glob(glob_path).map do |path|
YAML.safe_load(File.read(path))["action"]
end
end
end
def free?
options[:tiers].include? "free"
end
def time_frames
options[:time_frames]
end
def directory
@directory ||= TIME_FRAME_DIRS.find { |d| d.match?(input_dir) }
end
def metric_definitions
@definitions ||= Gitlab::Usage::MetricDefinition.definitions
end
def metric_definition_exists?(time_frame)
metric_definitions[key_path(time_frame)].present?
end
end
end
end
|