/
analytics.rb
428 lines (360 loc) 路 14.9 KB
/
analytics.rb
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
# typed: true
# frozen_string_literal: true
require "context"
require "erb"
require "settings"
require "api"
module Utils
# Helper module for fetching and reporting analytics data.
#
# @api private
module Analytics
INFLUX_BUCKET = "analytics"
INFLUX_TOKEN = "iVdsgJ_OjvTYGAA79gOfWlA_fX0QCuj4eYUNdb-qVUTrC3tp3JTWCADVNE9HxV0kp2ZjIK9tuthy_teX4szr9A=="
INFLUX_HOST = "https://eu-central-1-1.aws.cloud2.influxdata.com"
INFLUX_ORG = "d81a3e6d582d485f"
class << self
include Context
sig {
params(measurement: Symbol,
tags: T::Hash[Symbol, T.any(T::Boolean, String)],
fields: T::Hash[Symbol, T.any(T::Boolean, String)]).void
}
def report_influx(measurement, tags, fields)
return if not_this_run? || disabled?
# Tags are always implicitly strings and must have low cardinality.
tags_string = tags.map { |k, v| "#{k}=#{v}" }
.join(",")
# Fields need explicitly wrapped with quotes and can have high cardinality.
fields_string = fields.compact
.map { |k, v| %Q(#{k}="#{v}") }
.join(",")
args = [
"--max-time", "3",
"--header", "Authorization: Token #{INFLUX_TOKEN}",
"--header", "Content-Type: text/plain; charset=utf-8",
"--header", "Accept: application/json",
"--data-binary", "#{measurement},#{tags_string} #{fields_string} #{Time.now.to_i}"
]
# Second precision is highest we can do and has the lowest performance cost.
url = "#{INFLUX_HOST}/api/v2/write?bucket=#{INFLUX_BUCKET}&precision=s"
deferred_curl(url, args)
end
sig { params(url: String, args: T::Array[String]).void }
def deferred_curl(url, args)
curl = Utils::Curl.curl_executable
if ENV["HOMEBREW_ANALYTICS_DEBUG"]
puts "#{curl} #{args.join(" ")} \"#{url}\""
puts Utils.popen_read(curl, *args, url)
else
pid = fork do
exec curl, *args, "--silent", "--output", "/dev/null", url
end
Process.detach T.must(pid)
end
end
sig {
params(measurement: Symbol, package_name: String, tap_name: String,
on_request: T::Boolean, options: String).void
}
def report_package_event(measurement, package_name:, tap_name:, on_request: false, options: "")
return if not_this_run? || disabled?
# ensure on_request is a boolean
on_request = on_request ? true : false
# ensure options are removed (by `.compact` below) if empty
options = nil if options.blank?
# Tags must have low cardinality.
tags = default_package_tags.merge(on_request: on_request)
# Fields can have high cardinality.
fields = default_package_fields.merge(package: package_name, tap_name: tap_name, options: options)
.compact
report_influx(measurement, tags, fields)
end
sig { params(exception: BuildError).void }
def report_build_error(exception)
return if not_this_run? || disabled?
formula = exception.formula
return unless formula
tap = formula.tap
return unless tap
return unless tap.should_report_analytics?
options = exception.options.to_a.map(&:to_s).join(" ")
report_package_event(:build_error, package_name: formula.name, tap_name: tap.name, options: options)
end
def influx_message_displayed?
config_true?(:influxanalyticsmessage)
end
def messages_displayed?
config_true?(:analyticsmessage) &&
config_true?(:caskanalyticsmessage) &&
influx_message_displayed?
end
def disabled?
return true if Homebrew::EnvConfig.no_analytics?
config_true?(:analyticsdisabled)
end
def not_this_run?
ENV["HOMEBREW_NO_ANALYTICS_THIS_RUN"].present?
end
def no_message_output?
# Used by Homebrew/install
ENV["HOMEBREW_NO_ANALYTICS_MESSAGE_OUTPUT"].present?
end
def messages_displayed!
Homebrew::Settings.write :analyticsmessage, true
Homebrew::Settings.write :caskanalyticsmessage, true
Homebrew::Settings.write :influxanalyticsmessage, true
end
def enable!
Homebrew::Settings.write :analyticsdisabled, false
delete_uuid!
messages_displayed!
end
def disable!
Homebrew::Settings.write :analyticsdisabled, true
delete_uuid!
end
def delete_uuid!
Homebrew::Settings.delete :analyticsuuid
end
def output(args:, filter: nil)
days = args.days || "30"
category = args.category || "install"
begin
json = Homebrew::API::Analytics.fetch category, days
rescue ArgumentError
# Ignore failed API requests
return
end
return if json.blank? || json["items"].blank?
os_version = category == "os-version"
cask_install = category == "cask-install"
results = {}
json["items"].each do |item|
key = if os_version
item["os_version"]
elsif cask_install
item["cask"]
else
item["formula"]
end
next if filter.present? && key != filter && !key.start_with?("#{filter} ")
results[key] = item["count"].tr(",", "").to_i
end
if filter.present? && results.blank?
onoe "No results matching `#{filter}` found!"
return
end
table_output(category, days, results, os_version: os_version, cask_install: cask_install)
end
def output_analytics(json, args:)
full_analytics = args.analytics? || verbose?
ohai "Analytics"
json["analytics"].each do |category, value|
category = category.tr("_", "-")
analytics = []
value.each do |days, results|
days = days.to_i
if full_analytics
next if args.days.present? && args.days&.to_i != days
next if args.category.present? && args.category != category
table_output(category, days, results)
else
total_count = results.values.inject("+")
analytics << "#{number_readable(total_count)} (#{days} days)"
end
end
puts "#{category}: #{analytics.join(", ")}" unless full_analytics
end
end
# This method is undocumented because it is not intended for general use.
# It relies on screen scraping some GitHub HTML that's not available as an API.
# This seems very likely to break in the future.
# That said, it's the only way to get the data we want right now.
def output_github_packages_downloads(formula, args:)
return unless args.github_packages_downloads?
return unless formula.core_formula?
escaped_formula_name = GitHubPackages.image_formula_name(formula.name)
.gsub("/", "%2F")
formula_url_suffix = "container/core%2F#{escaped_formula_name}/"
formula_url = "https://github.com/Homebrew/homebrew-core/pkgs/#{formula_url_suffix}"
output = Utils::Curl.curl_output("--fail", formula_url)
return unless output.success?
formula_version_urls = output.stdout
.scan(%r{/orgs/Homebrew/packages/#{formula_url_suffix}\d+\?tag=[^"]+})
.map do |url|
url.sub("/orgs/Homebrew/packages/", "/Homebrew/homebrew-core/pkgs/")
end
return if formula_version_urls.empty?
thirty_day_download_count = 0
formula_version_urls.each do |formula_version_url_suffix|
formula_version_url = "https://github.com#{formula_version_url_suffix}"
output = Utils::Curl.curl_output("--fail", formula_version_url)
next unless output.success?
last_thirty_days_match = output.stdout.match(
%r{<span class="[\s\-a-z]*">Last 30 days</span>\s*<span class="[\s\-a-z]*">([\d.M,]+)</span>}m,
)
next if last_thirty_days_match.blank?
last_thirty_days_downloads = last_thirty_days_match.captures.first.tr(",", "")
thirty_day_download_count += if (millions_match = last_thirty_days_downloads.match(/(\d+\.\d+)M/).presence)
millions_match.captures.first.to_i * 1_000_000
else
last_thirty_days_downloads.to_i
end
end
ohai "GitHub Packages Downloads"
puts "#{number_readable(thirty_day_download_count)} (30 days)"
end
def formula_output(formula, args:)
return if Homebrew::EnvConfig.no_analytics? || Homebrew::EnvConfig.no_github_api?
json = Homebrew::API::Formula.fetch formula.name
return if json.blank? || json["analytics"].blank?
output_analytics(json, args: args)
output_github_packages_downloads(formula, args: args)
rescue ArgumentError
# Ignore failed API requests
nil
end
def cask_output(cask, args:)
return if Homebrew::EnvConfig.no_analytics? || Homebrew::EnvConfig.no_github_api?
json = Homebrew::API::Cask.fetch cask.token
return if json.blank? || json["analytics"].blank?
output_analytics(json, args: args)
rescue ArgumentError
# Ignore failed API requests
nil
end
def clear_cache
remove_instance_variable(:@default_package_tags) if instance_variable_defined?(:@default_package_tags)
remove_instance_variable(:@default_package_fields) if instance_variable_defined?(:@default_package_fields)
end
sig { returns(T::Hash[Symbol, String]) }
def default_package_tags
@default_package_tags ||= begin
# Only display default prefixes to reduce cardinality and improve privacy
prefix = Homebrew.default_prefix? ? HOMEBREW_PREFIX.to_s : "custom-prefix"
# Tags are always strings and must have low cardinality.
{
ci: ENV["CI"].present?,
prefix: prefix,
default_prefix: Homebrew.default_prefix?,
developer: Homebrew::EnvConfig.developer?,
devcmdrun: config_true?(:devcmdrun),
arch: HOMEBREW_PHYSICAL_PROCESSOR,
os: HOMEBREW_SYSTEM,
}
end
end
# remove os_version starting with " or number
# remove macOS patch release
sig { returns(T::Hash[Symbol, String]) }
def default_package_fields
@default_package_fields ||= begin
version = if (match_data = HOMEBREW_VERSION.match(/^[\d.]+/))
suffix = "-dev" if HOMEBREW_VERSION.include?("-")
match_data[0] + suffix.to_s
else
">=4.1.22"
end
# Only include OS versions with an actual name.
os_name_and_version = if (os_version = OS_VERSION.presence) && os_version.downcase.match?(/^[a-z]/)
os_version
end
{
version: version,
os_name_and_version: os_name_and_version,
}
end
end
def table_output(category, days, results, os_version: false, cask_install: false)
oh1 "#{category} (#{days} days)"
total_count = results.values.inject("+")
formatted_total_count = format_count(total_count)
formatted_total_percent = format_percent(100)
index_header = "Index"
count_header = "Count"
percent_header = "Percent"
name_with_options_header = if os_version
"macOS Version"
elsif cask_install
"Token"
else
"Name (with options)"
end
total_index_footer = "Total"
max_index_width = results.length.to_s.length
index_width = [
index_header.length,
total_index_footer.length,
max_index_width,
].max
count_width = [
count_header.length,
formatted_total_count.length,
].max
percent_width = [
percent_header.length,
formatted_total_percent.length,
].max
name_with_options_width = Tty.width -
index_width -
count_width -
percent_width -
10 # spacing and lines
formatted_index_header =
format "%#{index_width}s", index_header
formatted_name_with_options_header =
format "%-#{name_with_options_width}s",
name_with_options_header[0..name_with_options_width-1]
formatted_count_header =
format "%#{count_width}s", count_header
formatted_percent_header =
format "%#{percent_width}s", percent_header
puts "#{formatted_index_header} | #{formatted_name_with_options_header} | " \
"#{formatted_count_header} | #{formatted_percent_header}"
columns_line = "#{"-"*index_width}:|-#{"-"*name_with_options_width}-|-" \
"#{"-"*count_width}:|-#{"-"*percent_width}:"
puts columns_line
index = 0
results.each do |name_with_options, count|
index += 1
formatted_index = format "%0#{max_index_width}d", index
formatted_index = format "%-#{index_width}s", formatted_index
formatted_name_with_options =
format "%-#{name_with_options_width}s",
name_with_options[0..name_with_options_width-1]
formatted_count = format "%#{count_width}s", format_count(count)
formatted_percent = if total_count.zero?
format "%#{percent_width}s", format_percent(0)
else
format "%#{percent_width}s",
format_percent((count.to_i * 100) / total_count.to_f)
end
puts "#{formatted_index} | #{formatted_name_with_options} | " \
"#{formatted_count} | #{formatted_percent}%"
next if index > 10
end
return if results.length <= 1
formatted_total_footer =
format "%-#{index_width}s", total_index_footer
formatted_blank_footer =
format "%-#{name_with_options_width}s", ""
formatted_total_count_footer =
format "%#{count_width}s", formatted_total_count
formatted_total_percent_footer =
format "%#{percent_width}s", formatted_total_percent
puts "#{formatted_total_footer} | #{formatted_blank_footer} | " \
"#{formatted_total_count_footer} | #{formatted_total_percent_footer}%"
end
def config_true?(key)
Homebrew::Settings.read(key) == "true"
end
def format_count(count)
count.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
end
def format_percent(percent)
format("%<percent>.2f", percent: percent)
end
end
end
end