circleci-tools 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/README.md +61 -0
- data/bin/circleci-metrics +281 -0
- data/lib/circleci-tools/api_service.rb +177 -0
- data/lib/circleci-tools/cloudwatch_metrics_service.rb +217 -0
- data/lib/circleci-tools/data_aggregator.rb +57 -0
- data/lib/circleci-tools/job_analyzer.rb +58 -0
- data/lib/circleci-tools/log_uploader.rb +274 -0
- data/lib/circleci-tools/retryable.rb +29 -0
- data/lib/circleci-tools/runner_calculator.rb +14 -0
- data/lib/circleci-tools/s3_upload_service.rb +20 -0
- data/lib/circleci-tools/usage_report_service.rb +119 -0
- metadata +307 -0
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
require 'time'
|
|
2
|
+
require 'net/http'
|
|
3
|
+
require 'logger'
|
|
4
|
+
require 'fileutils'
|
|
5
|
+
require 'zlib'
|
|
6
|
+
require 'csv'
|
|
7
|
+
|
|
8
|
+
require 'api_service'
|
|
9
|
+
require 'retryable'
|
|
10
|
+
|
|
11
|
+
module CircleciTools
|
|
12
|
+
class UsageReportService
|
|
13
|
+
include Retryable
|
|
14
|
+
|
|
15
|
+
def initialize(api_service, org_id, shared_org_ids = [], interval_seconds = 600, logger: Logger.new(STDOUT), log_level: Logger::INFO)
|
|
16
|
+
@api_service = api_service
|
|
17
|
+
@org_id = org_id
|
|
18
|
+
@shared_org_ids = shared_org_ids
|
|
19
|
+
@interval_seconds = interval_seconds
|
|
20
|
+
@running = false
|
|
21
|
+
@logger = logger
|
|
22
|
+
@logger.level = log_level
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
def call(start_time: Time.now.utc - 3600, end_time: Time.now.utc, usage_export_job_id: nil)
|
|
26
|
+
@logger.info("Starting usage report for org #{@org_id}...")
|
|
27
|
+
@running = true
|
|
28
|
+
|
|
29
|
+
end_time = Time.now.utc if end_time > Time.now.utc
|
|
30
|
+
|
|
31
|
+
if usage_export_job_id
|
|
32
|
+
@logger.info("Using existing usage export job ID: #{usage_export_job_id}")
|
|
33
|
+
usage_data = poll_usage_export_job(usage_export_job_id)
|
|
34
|
+
success = usage_data && usage_data['download_urls']
|
|
35
|
+
@logger.debug("Usage data: #{usage_data}")
|
|
36
|
+
files = success ? download_and_save_files(usage_data['download_urls'], start_time, end_time) : []
|
|
37
|
+
else
|
|
38
|
+
success, files = fetch_and_store_usage_report(start_time:, end_time:)
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
stop if success
|
|
42
|
+
files
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
def stop
|
|
46
|
+
@running = false
|
|
47
|
+
end
|
|
48
|
+
|
|
49
|
+
private
|
|
50
|
+
|
|
51
|
+
def fetch_and_store_usage_report(start_time:, end_time:)
|
|
52
|
+
@logger.debug("Creating usage export job for CircleCI usage from #{start_time.iso8601} to #{end_time.iso8601}...")
|
|
53
|
+
export_job = @api_service.create_usage_export_job(
|
|
54
|
+
org_id: @org_id,
|
|
55
|
+
start_time: start_time.iso8601,
|
|
56
|
+
end_time: end_time.iso8601,
|
|
57
|
+
shared_org_ids: @shared_org_ids
|
|
58
|
+
)
|
|
59
|
+
return [false, []] unless export_job
|
|
60
|
+
@logger.debug("Export job created with ID: #{export_job['usage_export_job_id']}")
|
|
61
|
+
|
|
62
|
+
usage_export_job_id = export_job['usage_export_job_id']
|
|
63
|
+
usage_data = poll_usage_export_job(usage_export_job_id)
|
|
64
|
+
@logger.debug("Usage data: #{usage_data}")
|
|
65
|
+
return [false, []] unless usage_data
|
|
66
|
+
|
|
67
|
+
@logger.debug("Usage export job completed, downloading files...")
|
|
68
|
+
return [false, []] unless usage_data['download_urls']
|
|
69
|
+
|
|
70
|
+
downloaded_files = download_and_save_files(usage_data['download_urls'], start_time, end_time)
|
|
71
|
+
@logger.info("Downloaded #{downloaded_files.size} file(s).")
|
|
72
|
+
return [true, downloaded_files]
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
def poll_usage_export_job(usage_export_job_id)
|
|
76
|
+
timeout = Time.now + 4 * 3600
|
|
77
|
+
loop do
|
|
78
|
+
break if Time.now > timeout
|
|
79
|
+
|
|
80
|
+
job_status = @api_service.get_usage_export_job(
|
|
81
|
+
org_id: @org_id,
|
|
82
|
+
usage_export_job_id: usage_export_job_id
|
|
83
|
+
)
|
|
84
|
+
return job_status if job_status && job_status['state'] == 'completed'
|
|
85
|
+
|
|
86
|
+
sleep 30
|
|
87
|
+
end
|
|
88
|
+
nil
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
def download_and_save_files(download_urls, start_time, end_time)
|
|
92
|
+
paths = []
|
|
93
|
+
start_time_str = start_time.utc.strftime('%Y%m%d%H%M')
|
|
94
|
+
end_time_str = end_time.utc.strftime('%Y%m%d%H%M')
|
|
95
|
+
FileUtils.mkdir_p('tmp')
|
|
96
|
+
combined_csv_path = "tmp/usage_report_#{start_time_str}_to_#{end_time_str}.csv"
|
|
97
|
+
CSV.open(combined_csv_path, 'w') do |csv|
|
|
98
|
+
download_urls.each_with_index do |url, index|
|
|
99
|
+
uri = URI(url)
|
|
100
|
+
response = with_retries { Net::HTTP.get(uri) }
|
|
101
|
+
gz_path = "tmp/usage_report_#{start_time_str}_to_#{end_time_str}_part_#{index + 1}.gz"
|
|
102
|
+
File.open(gz_path, 'wb') { |file| file.write(response) }
|
|
103
|
+
unzip_and_combine_csv(gz_path, csv)
|
|
104
|
+
File.delete(gz_path) # Delete the .gz file after extraction
|
|
105
|
+
end
|
|
106
|
+
end
|
|
107
|
+
paths << combined_csv_path
|
|
108
|
+
paths
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
def unzip_and_combine_csv(gz_path, combined_csv)
|
|
112
|
+
Zlib::GzipReader.open(gz_path) do |gz|
|
|
113
|
+
CSV.new(gz).each do |row|
|
|
114
|
+
combined_csv << row
|
|
115
|
+
end
|
|
116
|
+
end
|
|
117
|
+
end
|
|
118
|
+
end
|
|
119
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,307 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: circleci-tools
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Manuel Fittko
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2025-01-21 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: rspec
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '3.10'
|
|
20
|
+
type: :development
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '3.10'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: activesupport
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - "~>"
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: 8.0.1
|
|
34
|
+
type: :runtime
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - "~>"
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: 8.0.1
|
|
41
|
+
- !ruby/object:Gem::Dependency
|
|
42
|
+
name: aws-sdk-cloudwatch
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - "~>"
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: 1.109.0
|
|
48
|
+
type: :runtime
|
|
49
|
+
prerelease: false
|
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
51
|
+
requirements:
|
|
52
|
+
- - "~>"
|
|
53
|
+
- !ruby/object:Gem::Version
|
|
54
|
+
version: 1.109.0
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: aws-sdk-cloudwatchlogs
|
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
|
58
|
+
requirements:
|
|
59
|
+
- - "~>"
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: 1.106.0
|
|
62
|
+
type: :runtime
|
|
63
|
+
prerelease: false
|
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - "~>"
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: 1.106.0
|
|
69
|
+
- !ruby/object:Gem::Dependency
|
|
70
|
+
name: aws-sdk-s3
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - "~>"
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: 1.178.0
|
|
76
|
+
type: :runtime
|
|
77
|
+
prerelease: false
|
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - "~>"
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: 1.178.0
|
|
83
|
+
- !ruby/object:Gem::Dependency
|
|
84
|
+
name: base64
|
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
|
86
|
+
requirements:
|
|
87
|
+
- - "~>"
|
|
88
|
+
- !ruby/object:Gem::Version
|
|
89
|
+
version: 0.2.0
|
|
90
|
+
type: :runtime
|
|
91
|
+
prerelease: false
|
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
93
|
+
requirements:
|
|
94
|
+
- - "~>"
|
|
95
|
+
- !ruby/object:Gem::Version
|
|
96
|
+
version: 0.2.0
|
|
97
|
+
- !ruby/object:Gem::Dependency
|
|
98
|
+
name: csv
|
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
|
100
|
+
requirements:
|
|
101
|
+
- - "~>"
|
|
102
|
+
- !ruby/object:Gem::Version
|
|
103
|
+
version: 3.3.2
|
|
104
|
+
type: :runtime
|
|
105
|
+
prerelease: false
|
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
107
|
+
requirements:
|
|
108
|
+
- - "~>"
|
|
109
|
+
- !ruby/object:Gem::Version
|
|
110
|
+
version: 3.3.2
|
|
111
|
+
- !ruby/object:Gem::Dependency
|
|
112
|
+
name: date
|
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
|
114
|
+
requirements:
|
|
115
|
+
- - "~>"
|
|
116
|
+
- !ruby/object:Gem::Version
|
|
117
|
+
version: 3.4.1
|
|
118
|
+
type: :runtime
|
|
119
|
+
prerelease: false
|
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
121
|
+
requirements:
|
|
122
|
+
- - "~>"
|
|
123
|
+
- !ruby/object:Gem::Version
|
|
124
|
+
version: 3.4.1
|
|
125
|
+
- !ruby/object:Gem::Dependency
|
|
126
|
+
name: faraday
|
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
|
128
|
+
requirements:
|
|
129
|
+
- - "~>"
|
|
130
|
+
- !ruby/object:Gem::Version
|
|
131
|
+
version: 2.12.2
|
|
132
|
+
type: :runtime
|
|
133
|
+
prerelease: false
|
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
135
|
+
requirements:
|
|
136
|
+
- - "~>"
|
|
137
|
+
- !ruby/object:Gem::Version
|
|
138
|
+
version: 2.12.2
|
|
139
|
+
- !ruby/object:Gem::Dependency
|
|
140
|
+
name: fileutils
|
|
141
|
+
requirement: !ruby/object:Gem::Requirement
|
|
142
|
+
requirements:
|
|
143
|
+
- - "~>"
|
|
144
|
+
- !ruby/object:Gem::Version
|
|
145
|
+
version: 1.7.3
|
|
146
|
+
type: :runtime
|
|
147
|
+
prerelease: false
|
|
148
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
149
|
+
requirements:
|
|
150
|
+
- - "~>"
|
|
151
|
+
- !ruby/object:Gem::Version
|
|
152
|
+
version: 1.7.3
|
|
153
|
+
- !ruby/object:Gem::Dependency
|
|
154
|
+
name: json
|
|
155
|
+
requirement: !ruby/object:Gem::Requirement
|
|
156
|
+
requirements:
|
|
157
|
+
- - "~>"
|
|
158
|
+
- !ruby/object:Gem::Version
|
|
159
|
+
version: 2.9.1
|
|
160
|
+
type: :runtime
|
|
161
|
+
prerelease: false
|
|
162
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
163
|
+
requirements:
|
|
164
|
+
- - "~>"
|
|
165
|
+
- !ruby/object:Gem::Version
|
|
166
|
+
version: 2.9.1
|
|
167
|
+
- !ruby/object:Gem::Dependency
|
|
168
|
+
name: logger
|
|
169
|
+
requirement: !ruby/object:Gem::Requirement
|
|
170
|
+
requirements:
|
|
171
|
+
- - "~>"
|
|
172
|
+
- !ruby/object:Gem::Version
|
|
173
|
+
version: 1.6.5
|
|
174
|
+
type: :runtime
|
|
175
|
+
prerelease: false
|
|
176
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
177
|
+
requirements:
|
|
178
|
+
- - "~>"
|
|
179
|
+
- !ruby/object:Gem::Version
|
|
180
|
+
version: 1.6.5
|
|
181
|
+
- !ruby/object:Gem::Dependency
|
|
182
|
+
name: rexml
|
|
183
|
+
requirement: !ruby/object:Gem::Requirement
|
|
184
|
+
requirements:
|
|
185
|
+
- - "~>"
|
|
186
|
+
- !ruby/object:Gem::Version
|
|
187
|
+
version: 3.4.0
|
|
188
|
+
type: :runtime
|
|
189
|
+
prerelease: false
|
|
190
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
191
|
+
requirements:
|
|
192
|
+
- - "~>"
|
|
193
|
+
- !ruby/object:Gem::Version
|
|
194
|
+
version: 3.4.0
|
|
195
|
+
- !ruby/object:Gem::Dependency
|
|
196
|
+
name: thor
|
|
197
|
+
requirement: !ruby/object:Gem::Requirement
|
|
198
|
+
requirements:
|
|
199
|
+
- - "~>"
|
|
200
|
+
- !ruby/object:Gem::Version
|
|
201
|
+
version: 1.3.2
|
|
202
|
+
type: :runtime
|
|
203
|
+
prerelease: false
|
|
204
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
205
|
+
requirements:
|
|
206
|
+
- - "~>"
|
|
207
|
+
- !ruby/object:Gem::Version
|
|
208
|
+
version: 1.3.2
|
|
209
|
+
- !ruby/object:Gem::Dependency
|
|
210
|
+
name: time
|
|
211
|
+
requirement: !ruby/object:Gem::Requirement
|
|
212
|
+
requirements:
|
|
213
|
+
- - "~>"
|
|
214
|
+
- !ruby/object:Gem::Version
|
|
215
|
+
version: 0.4.1
|
|
216
|
+
type: :runtime
|
|
217
|
+
prerelease: false
|
|
218
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
219
|
+
requirements:
|
|
220
|
+
- - "~>"
|
|
221
|
+
- !ruby/object:Gem::Version
|
|
222
|
+
version: 0.4.1
|
|
223
|
+
- !ruby/object:Gem::Dependency
|
|
224
|
+
name: tty-progressbar
|
|
225
|
+
requirement: !ruby/object:Gem::Requirement
|
|
226
|
+
requirements:
|
|
227
|
+
- - "~>"
|
|
228
|
+
- !ruby/object:Gem::Version
|
|
229
|
+
version: 0.18.3
|
|
230
|
+
type: :runtime
|
|
231
|
+
prerelease: false
|
|
232
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
233
|
+
requirements:
|
|
234
|
+
- - "~>"
|
|
235
|
+
- !ruby/object:Gem::Version
|
|
236
|
+
version: 0.18.3
|
|
237
|
+
- !ruby/object:Gem::Dependency
|
|
238
|
+
name: tty-prompt
|
|
239
|
+
requirement: !ruby/object:Gem::Requirement
|
|
240
|
+
requirements:
|
|
241
|
+
- - "~>"
|
|
242
|
+
- !ruby/object:Gem::Version
|
|
243
|
+
version: 0.23.1
|
|
244
|
+
type: :runtime
|
|
245
|
+
prerelease: false
|
|
246
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
247
|
+
requirements:
|
|
248
|
+
- - "~>"
|
|
249
|
+
- !ruby/object:Gem::Version
|
|
250
|
+
version: 0.23.1
|
|
251
|
+
- !ruby/object:Gem::Dependency
|
|
252
|
+
name: zlib
|
|
253
|
+
requirement: !ruby/object:Gem::Requirement
|
|
254
|
+
requirements:
|
|
255
|
+
- - "~>"
|
|
256
|
+
- !ruby/object:Gem::Version
|
|
257
|
+
version: 3.2.1
|
|
258
|
+
type: :runtime
|
|
259
|
+
prerelease: false
|
|
260
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
261
|
+
requirements:
|
|
262
|
+
- - "~>"
|
|
263
|
+
- !ruby/object:Gem::Version
|
|
264
|
+
version: 3.2.1
|
|
265
|
+
description: Collection of CircleCI-related utilities under one gem.
|
|
266
|
+
email:
|
|
267
|
+
- manuel.fittko@sofatutor.com
|
|
268
|
+
executables:
|
|
269
|
+
- circleci-metrics
|
|
270
|
+
extensions: []
|
|
271
|
+
extra_rdoc_files: []
|
|
272
|
+
files:
|
|
273
|
+
- README.md
|
|
274
|
+
- bin/circleci-metrics
|
|
275
|
+
- lib/circleci-tools/api_service.rb
|
|
276
|
+
- lib/circleci-tools/cloudwatch_metrics_service.rb
|
|
277
|
+
- lib/circleci-tools/data_aggregator.rb
|
|
278
|
+
- lib/circleci-tools/job_analyzer.rb
|
|
279
|
+
- lib/circleci-tools/log_uploader.rb
|
|
280
|
+
- lib/circleci-tools/retryable.rb
|
|
281
|
+
- lib/circleci-tools/runner_calculator.rb
|
|
282
|
+
- lib/circleci-tools/s3_upload_service.rb
|
|
283
|
+
- lib/circleci-tools/usage_report_service.rb
|
|
284
|
+
homepage: https://www.sofatutor.com
|
|
285
|
+
licenses:
|
|
286
|
+
- MIT
|
|
287
|
+
metadata: {}
|
|
288
|
+
post_install_message:
|
|
289
|
+
rdoc_options: []
|
|
290
|
+
require_paths:
|
|
291
|
+
- lib
|
|
292
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
293
|
+
requirements:
|
|
294
|
+
- - ">="
|
|
295
|
+
- !ruby/object:Gem::Version
|
|
296
|
+
version: '0'
|
|
297
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
298
|
+
requirements:
|
|
299
|
+
- - ">="
|
|
300
|
+
- !ruby/object:Gem::Version
|
|
301
|
+
version: '0'
|
|
302
|
+
requirements: []
|
|
303
|
+
rubygems_version: 3.4.19
|
|
304
|
+
signing_key:
|
|
305
|
+
specification_version: 4
|
|
306
|
+
summary: CircleCI Tools
|
|
307
|
+
test_files: []
|