-
Notifications
You must be signed in to change notification settings - Fork 0
/
telemetry.k8s.krkn_telemetry_kubernetes.html
358 lines (323 loc) · 33.3 KB
/
telemetry.k8s.krkn_telemetry_kubernetes.html
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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>telemetry.k8s.krkn_telemetry_kubernetes module — Krkn Foundation Library</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/krkn-style.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=34c10c6c"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="telemetry.ocp package" href="telemetry.ocp.html" />
<link rel="prev" title="telemetry.k8s package" href="telemetry.k8s.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="modules.html">
<img src="_static/redhat-chaos.png" class="logo" alt="Logo"/>
</a>
<div class="version">
v4.0.4
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="elastic.html">elastic package</a></li>
<li class="toctree-l1"><a class="reference internal" href="k8s.html">k8s package</a></li>
<li class="toctree-l1"><a class="reference internal" href="models.html">models package</a></li>
<li class="toctree-l1"><a class="reference internal" href="ocp.html">ocp package</a></li>
<li class="toctree-l1"><a class="reference internal" href="prometheus.html">prometheus package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="telemetry.html">telemetry package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="telemetry.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="telemetry.k8s.html">telemetry.k8s package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="telemetry.k8s.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="telemetry.k8s.html#module-telemetry.k8s">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="telemetry.ocp.html">telemetry.ocp package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="telemetry.html#module-telemetry">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="utils.html">utils package</a></li>
<li class="toctree-l1"><a class="reference internal" href="version.html">version package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="modules.html">Krkn Foundation Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="modules.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="telemetry.html">telemetry package</a></li>
<li class="breadcrumb-item"><a href="telemetry.k8s.html">telemetry.k8s package</a></li>
<li class="breadcrumb-item active">telemetry.k8s.krkn_telemetry_kubernetes module</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-telemetry.k8s.krkn_telemetry_kubernetes">
<span id="telemetry-k8s-krkn-telemetry-kubernetes-module"></span><h1>telemetry.k8s.krkn_telemetry_kubernetes module<a class="headerlink" href="#module-telemetry.k8s.krkn_telemetry_kubernetes" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">telemetry.k8s.krkn_telemetry_kubernetes.</span></span><span class="sig-name descname"><span class="pre">KrknTelemetryKubernetes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">safe_logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">SafeLogger</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lib_kubernetes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KrknKubernetes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">krkn_telemetry_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">telemetry_request_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">safe_logger</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">SafeLogger</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lib_kubernetes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">KrknKubernetes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">krkn_telemetry_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">telemetry_request_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.collect_cluster_metadata">
<span class="sig-name descname"><span class="pre">collect_cluster_metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">chaos_telemetry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ChaosRunTelemetry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.collect_cluster_metadata" title="Link to this definition"></a></dt>
<dd><p>Collects useful cluster metadata:
- cloud infrastructure
- network plugins
- number of objects deployed
- node system infos
to enrich the ChaosRunTelemetry object that will be sent to the
telemetry service:</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>chaos_telemetry</strong> – the chaos telemetry to be enriched by
the cluster metadata</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.default_telemetry_group">
<span class="sig-name descname"><span class="pre">default_telemetry_group</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'default'</span></em><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.default_telemetry_group" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.generate_url_and_put_to_s3_worker">
<span class="sig-name descname"><span class="pre">generate_url_and_put_to_s3_worker</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">queue</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Queue</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">queue_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">telemetry_group</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">thread_number</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uploaded_file_list</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_retries</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remote_file_prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remote_file_extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.generate_url_and_put_to_s3_worker" title="Link to this definition"></a></dt>
<dd><p>Worker function that creates an s3 link to put files and upload
the file directly on the bucket.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>queue</strong> – queue that will be consumed. The queue
elements must be tuples on which the first item must
be the file sequence number, the second a local filename full-path
that will be uploaded in the S3 bucket and the
third will be a retry counter updated by the thread
on upload exception and compared with max_retries.</p></li>
<li><p><strong>queue_size</strong> – total number of files</p></li>
<li><p><strong>request_id</strong> – uuid of the session that will represent the
folder on which the prometheus files will be stored within the
respective group</p></li>
<li><p><strong>telemetry_group</strong> – the group of telemetry on which the file
will be stored. The group will be the folder starting from the
S3 bucket root</p></li>
<li><p><strong>api_url</strong> – API endpoint to generate the S3 temporary link</p></li>
<li><p><strong>username</strong> – API username</p></li>
<li><p><strong>password</strong> – API password</p></li>
<li><p><strong>thread_number</strong> – Thread number</p></li>
<li><p><strong>uploaded_file_list</strong> – uploaded file list shared between threads</p></li>
<li><p><strong>max_retries</strong> – maximum number of retries from config.yaml.
If 0 will retry indefinitely.</p></li>
<li><p><strong>remote_file_prefix</strong> – the prefix that will given to the file
in the S3 bucket along with the progressive number
(if is a multiple file archive)</p></li>
<li><p><strong>remote_file_extension</strong> – the extension of the remote
file on the S3 bucket</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.get_bucket_url_for_filename">
<span class="sig-name descname"><span class="pre">get_bucket_url_for_filename</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bucket_folder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remote_filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.get_bucket_url_for_filename" title="Link to this definition"></a></dt>
<dd><p>Gets from the telemetry API a one shot S3 link to upload
prometheus data</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>api_url</strong> – telemetry base URL</p></li>
<li><p><strong>bucket_folder</strong> – folder on which the prometheus archives
will be stored</p></li>
<li><p><strong>remote_filename</strong> – name of the file
that will be stored in the bucket</p></li>
<li><p><strong>username</strong> – API username</p></li>
<li><p><strong>password</strong> – API password</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>the url where the file will be uploaded</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.get_lib_kubernetes">
<span class="sig-name descname"><span class="pre">get_lib_kubernetes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">KrknKubernetes</span></span></span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.get_lib_kubernetes" title="Link to this definition"></a></dt>
<dd><p>Returns the instance of KrknKubernetes</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>a KrknKubernetes instance</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.get_prometheus_pod_data">
<span class="sig-name descname"><span class="pre">get_prometheus_pod_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">telemetry_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prometheus_pod_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prometheus_container_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prometheus_namespace</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remote_archive_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'/prometheus'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.get_prometheus_pod_data" title="Link to this definition"></a></dt>
<dd><p>Downloads the prometheus metrics folder from a prometheus pod</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>telemetry_config</strong> – krkn telemetry conf section
will be stored</p></li>
<li><p><strong>request_id</strong> – uuid of the session that will represent the
temporary archive files</p></li>
<li><p><strong>prometheus_pod_name</strong> – the name of the prometheus pod from
which the data will be archived</p></li>
<li><p><strong>prometheus_container_name</strong> – the name of the container in the
prometheus pod</p></li>
<li><p><strong>prometheus_namespace</strong> – the namespace in which the prometheus
pod lives</p></li>
<li><p><strong>remote_archive_path</strong> – (Optional) the path where prometheus logs
are stored, if not specified will default to <cite>/prometheus</cite></p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>the list of the archive number and filenames downloaded</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.get_telemetry_config">
<span class="sig-name descname"><span class="pre">get_telemetry_config</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.get_telemetry_config" title="Link to this definition"></a></dt>
<dd><p>Returns the telemetry config section from config.yaml</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>the telemetry config section</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.get_telemetry_request_id">
<span class="sig-name descname"><span class="pre">get_telemetry_request_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.get_telemetry_request_id" title="Link to this definition"></a></dt>
<dd><p>Gets the telemetry request id that represents the path
on S3 where the telemetry data is uploaded</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>the krkn telemetry id</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.put_critical_alerts">
<span class="sig-name descname"><span class="pre">put_critical_alerts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">telemetry_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alerts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ChaosRunAlertSummary</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.put_critical_alerts" title="Link to this definition"></a></dt>
<dd><p>Puts collected critical alerts on the S3 bucket</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>request_id</strong> – uuid of the session that will represent the
S3 folder on which the prometheus files will be stored</p></li>
<li><p><strong>telemetry_config</strong> – telemetry section of kraken config.yaml</p></li>
<li><p><strong>alerts</strong> – list of strings representing the alert log lines
printed to stdout</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.put_file_to_url">
<span class="sig-name descname"><span class="pre">put_file_to_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.put_file_to_url" title="Link to this definition"></a></dt>
<dd><p>Puts a local file on an url
:param url: url where the file will be put
:param local_filename: local file full-path</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.put_prometheus_data">
<span class="sig-name descname"><span class="pre">put_prometheus_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">telemetry_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">archive_volumes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.put_prometheus_data" title="Link to this definition"></a></dt>
<dd><p>Puts a list of files on telemetry S3 bucket, multithreading.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>telemetry_config</strong> – telemetry section of kraken config.yaml</p></li>
<li><p><strong>archive_volumes</strong> – a list of tuples containing the
archive number, and the archive full path to be uploaded</p></li>
<li><p><strong>request_id</strong> – uuid of the session that will represent the
S3 folder on which the prometheus files will be stored</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.safe_logger">
<span class="sig-name descname"><span class="pre">safe_logger</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">SafeLogger</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.safe_logger" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.send_telemetry">
<span class="sig-name descname"><span class="pre">send_telemetry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">telemetry_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">chaos_telemetry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ChaosRunTelemetry</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.send_telemetry" title="Link to this definition"></a></dt>
<dd><p>Sends Telemetry Data to the Telemetry Web Service</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>telemetry_config</strong> – krkn telemetry conf section</p></li>
<li><p><strong>uuid</strong> – uuid used as folder in S3 bucket</p></li>
<li><p><strong>chaos_telemetry</strong> – already populated ChaosRunTelemetry object</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>the telemetry object json string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.set_parameters_base64">
<span class="sig-name descname"><span class="pre">set_parameters_base64</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">scenario_telemetry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ScenarioTelemetry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#telemetry.k8s.krkn_telemetry_kubernetes.KrknTelemetryKubernetes.set_parameters_base64" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="telemetry.k8s.html" class="btn btn-neutral float-left" title="telemetry.k8s package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="telemetry.ocp.html" class="btn btn-neutral float-right" title="telemetry.ocp package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright Red Hat Chaos Team.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>