Class: Mudbase::MonitoringApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mudbase/api/monitoring_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MonitoringApi

Returns a new instance of MonitoringApi.



19
20
21
 
# File 'lib/mudbase/api/monitoring_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mudbase/api/monitoring_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_monitoring_alert(create_monitoring_alert_request, opts = {}) ⇒ nil

Create monitoring alert Create a monitoring alert (plan limit alertsPerProject enforced).

Parameters:

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/mudbase/api/monitoring_api.rb', line 27

def create_monitoring_alert(create_monitoring_alert_request, opts = {})
  create_monitoring_alert_with_http_info(create_monitoring_alert_request, opts)
  nil
end

#create_monitoring_alert_with_http_info(create_monitoring_alert_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create monitoring alert Create a monitoring alert (plan limit alertsPerProject enforced).

Parameters:

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/mudbase/api/monitoring_api.rb', line 37

def create_monitoring_alert_with_http_info(create_monitoring_alert_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.create_monitoring_alert ...'
  end
  # verify the required parameter 'create_monitoring_alert_request' is set
  if @api_client.config.client_side_validation && create_monitoring_alert_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_monitoring_alert_request' when calling MonitoringApi.create_monitoring_alert"
  end
  # resource path
  local_var_path = '/api/monitoring/alerts'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_monitoring_alert_request)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth']

  new_options = opts.merge(
    :operation => :"MonitoringApi.create_monitoring_alert",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#create_monitoring_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitoring_analytics(opts = {}) ⇒ MonitoringAnalyticsResponse

Get usage analytics (time series) Aggregates UsageStat by day/week/month. Optional projectId scopes to one project. Query days (1–90) for a rolling window (e.g. days=14); when set, overrides period.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :project_id (String)
  • :period (String) — default: default to 'month'
  • :granularity (String) — default: default to 'day'
  • :days (Integer) —

    Rolling window in days (1–90); when set, period becomes last_N_days

Returns:



98
99
100
101
 
# File 'lib/mudbase/api/monitoring_api.rb', line 98

def get_monitoring_analytics(opts = {})
  data, _status_code, _headers = get_monitoring_analytics_with_http_info(opts)
  data
end

#get_monitoring_analytics_with_http_info(opts = {}) ⇒ Array<(MonitoringAnalyticsResponse, Integer, Hash)>

Get usage analytics (time series) Aggregates UsageStat by day/week/month. Optional projectId scopes to one project. Query days (1–90) for a rolling window (e.g. days=14); when set, overrides period.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :project_id (String)
  • :period (String) — default: default to 'month'
  • :granularity (String) — default: default to 'day'
  • :days (Integer) —

    Rolling window in days (1–90); when set, period becomes last_N_days

Returns:

  • (Array<(MonitoringAnalyticsResponse, Integer, Hash)>) —

    MonitoringAnalyticsResponse data, response status code and response headers



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
 
# File 'lib/mudbase/api/monitoring_api.rb', line 111

def get_monitoring_analytics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.get_monitoring_analytics ...'
  end
  allowable_values = ["day", "week", "month"]
  if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
    fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
  end
  allowable_values = ["day", "week", "month"]
  if @api_client.config.client_side_validation && opts[:'granularity'] && !allowable_values.include?(opts[:'granularity'])
    fail ArgumentError, "invalid value for \"granularity\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'days'].nil? && opts[:'days'] > 90
    fail ArgumentError, 'invalid value for "opts[:"days"]" when calling MonitoringApi.get_monitoring_analytics, must be smaller than or equal to 90.'
  end

  if @api_client.config.client_side_validation && !opts[:'days'].nil? && opts[:'days'] < 1
    fail ArgumentError, 'invalid value for "opts[:"days"]" when calling MonitoringApi.get_monitoring_analytics, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/monitoring/analytics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'projectId'] = opts[:'project_id'] if !opts[:'project_id'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'granularity'] = opts[:'granularity'] if !opts[:'granularity'].nil?
  query_params[:'days'] = opts[:'days'] if !opts[:'days'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MonitoringAnalyticsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth']

  new_options = opts.merge(
    :operation => :"MonitoringApi.get_monitoring_analytics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#get_monitoring_analytics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitoring_errors(opts = {}) ⇒ nil

Get error logs

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


178
179
180
181
 
# File 'lib/mudbase/api/monitoring_api.rb', line 178

def get_monitoring_errors(opts = {})
  get_monitoring_errors_with_http_info(opts)
  nil
end

#get_monitoring_errors_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get error logs

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/mudbase/api/monitoring_api.rb', line 186

def get_monitoring_errors_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.get_monitoring_errors ...'
  end
  # resource path
  local_var_path = '/api/monitoring/errors'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth']

  new_options = opts.merge(
    :operation => :"MonitoringApi.get_monitoring_errors",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#get_monitoring_errors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitoring_latency_insights(opts = {}) ⇒ nil

Latency insights (route templates, percentiles, impact scores) Per-process snapshot: normalized routeKey (METHOD + path template), p50/p95/p99, 4xx/5xx counts, impactScore, alertsSuggested, rps, inFlight, eventLoopLagP99Ms. One buffer per server instance.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


234
235
236
237
 
# File 'lib/mudbase/api/monitoring_api.rb', line 234

def get_monitoring_latency_insights(opts = {})
  get_monitoring_latency_insights_with_http_info(opts)
  nil
end

#get_monitoring_latency_insights_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Latency insights (route templates, percentiles, impact scores) Per-process snapshot: normalized routeKey (METHOD + path template), p50/p95/p99, 4xx/5xx counts, impactScore, alertsSuggested, rps, inFlight, eventLoopLagP99Ms. One buffer per server instance.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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
 
# File 'lib/mudbase/api/monitoring_api.rb', line 243

def get_monitoring_latency_insights_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.get_monitoring_latency_insights ...'
  end
  # resource path
  local_var_path = '/api/monitoring/latency-insights'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth']

  new_options = opts.merge(
    :operation => :"MonitoringApi.get_monitoring_latency_insights",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#get_monitoring_latency_insights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitoring_logs(opts = {}) ⇒ MonitoringLogsResponse

Get audit logs Paginated audit trail for the org. Use projectId to scope to one project; level=all or audit for full activity feed. Each entry includes activityTitle and activityDetail for dashboard copy. Requires monitoring read permission.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) — default: default to 1
  • :limit (Integer) — default: default to 20
  • :project_id (String) —

    Filter to this project (must belong to org)

  • :user_id (String) —

    Filter to this user's audit entries

  • :level (String) —

    error|security|all|audit|low|medium|high|critical (default to 'error')

  • :start_date (Time)
  • :end_date (Time)
  • :action (String)
  • :resource (String)

Returns:



300
301
302
303
 
# File 'lib/mudbase/api/monitoring_api.rb', line 300

def get_monitoring_logs(opts = {})
  data, _status_code, _headers = get_monitoring_logs_with_http_info(opts)
  data
end

#get_monitoring_logs_with_http_info(opts = {}) ⇒ Array<(MonitoringLogsResponse, Integer, Hash)>

Get audit logs Paginated audit trail for the org. Use projectId to scope to one project; level=all or audit for full activity feed. Each entry includes activityTitle and activityDetail for dashboard copy. Requires monitoring read permission.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) — default: default to 1
  • :limit (Integer) — default: default to 20
  • :project_id (String) —

    Filter to this project (must belong to org)

  • :user_id (String) —

    Filter to this user's audit entries

  • :level (String) —

    error|security|all|audit|low|medium|high|critical (default to 'error')

  • :start_date (Time)
  • :end_date (Time)
  • :action (String)
  • :resource (String)

Returns:

  • (Array<(MonitoringLogsResponse, Integer, Hash)>) —

    MonitoringLogsResponse data, response status code and response headers



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
 
# File 'lib/mudbase/api/monitoring_api.rb', line 318

def get_monitoring_logs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.get_monitoring_logs ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling MonitoringApi.get_monitoring_logs, must be smaller than or equal to 500.'
  end

  # resource path
  local_var_path = '/api/monitoring/logs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'projectId'] = opts[:'project_id'] if !opts[:'project_id'].nil?
  query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'level'] = opts[:'level'] if !opts[:'level'].nil?
  query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
  query_params[:'resource'] = opts[:'resource'] if !opts[:'resource'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MonitoringLogsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth']

  new_options = opts.merge(
    :operation => :"MonitoringApi.get_monitoring_logs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#get_monitoring_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitoring_performance(opts = {}) ⇒ MonitoringPerformanceResponse

Get performance metrics Response time stats from AuditLog where available. With projectId, falls back to UsageStat latency averages when audit data is sparse (latencySource may be usage_stat).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :project_id (String)
  • :period (String) — default: default to 'hour'

Returns:



381
382
383
384
 
# File 'lib/mudbase/api/monitoring_api.rb', line 381

def get_monitoring_performance(opts = {})
  data, _status_code, _headers = get_monitoring_performance_with_http_info(opts)
  data
end

#get_monitoring_performance_with_http_info(opts = {}) ⇒ Array<(MonitoringPerformanceResponse, Integer, Hash)>

Get performance metrics Response time stats from AuditLog where available. With projectId, falls back to UsageStat latency averages when audit data is sparse (latencySource may be usage_stat).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :project_id (String)
  • :period (String) — default: default to 'hour'

Returns:



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
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/mudbase/api/monitoring_api.rb', line 392

def get_monitoring_performance_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.get_monitoring_performance ...'
  end
  allowable_values = ["hour", "day", "week"]
  if @api_client.config.client_side_validation && opts[:'period'] && !allowable_values.include?(opts[:'period'])
    fail ArgumentError, "invalid value for \"period\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/monitoring/performance'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'projectId'] = opts[:'project_id'] if !opts[:'project_id'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MonitoringPerformanceResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth']

  new_options = opts.merge(
    :operation => :"MonitoringApi.get_monitoring_performance",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#get_monitoring_performance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitoring_queue_metrics(opts = {}) ⇒ nil

Usage metering queue job counts BullMQ usage-events queue counts when USE_METERING_QUEUE and REDIS_URL are set.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


446
447
448
449
 
# File 'lib/mudbase/api/monitoring_api.rb', line 446

def get_monitoring_queue_metrics(opts = {})
  get_monitoring_queue_metrics_with_http_info(opts)
  nil
end

#get_monitoring_queue_metrics_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Usage metering queue job counts BullMQ usage-events queue counts when `USE_METERING_QUEUE` and `REDIS_URL` are set.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/mudbase/api/monitoring_api.rb', line 455

def get_monitoring_queue_metrics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.get_monitoring_queue_metrics ...'
  end
  # resource path
  local_var_path = '/api/monitoring/queue-metrics'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth']

  new_options = opts.merge(
    :operation => :"MonitoringApi.get_monitoring_queue_metrics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#get_monitoring_queue_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scanner_metrics(opts = {}) ⇒ GetScannerMetrics200Response

Get block scanner metrics Returns per-chain block scanner lag and health. Used for observability of ETH/UTXO block-based wallet monitoring. Alerts when lag exceeds threshold.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



503
504
505
506
 
# File 'lib/mudbase/api/monitoring_api.rb', line 503

def get_scanner_metrics(opts = {})
  data, _status_code, _headers = get_scanner_metrics_with_http_info(opts)
  data
end

#get_scanner_metrics_with_http_info(opts = {}) ⇒ Array<(GetScannerMetrics200Response, Integer, Hash)>

Get block scanner metrics Returns per-chain block scanner lag and health. Used for observability of ETH/UTXO block-based wallet monitoring. Alerts when lag exceeds threshold.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/mudbase/api/monitoring_api.rb', line 512

def get_scanner_metrics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.get_scanner_metrics ...'
  end
  # resource path
  local_var_path = '/api/monitoring/scanner-metrics'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetScannerMetrics200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

  new_options = opts.merge(
    :operation => :"MonitoringApi.get_scanner_metrics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#get_scanner_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_monitoring_alerts(opts = {}) ⇒ nil

List monitoring alerts

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


559
560
561
562
 
# File 'lib/mudbase/api/monitoring_api.rb', line 559

def list_monitoring_alerts(opts = {})
  list_monitoring_alerts_with_http_info(opts)
  nil
end

#list_monitoring_alerts_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

List monitoring alerts

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/mudbase/api/monitoring_api.rb', line 567

def list_monitoring_alerts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.list_monitoring_alerts ...'
  end
  # resource path
  local_var_path = '/api/monitoring/alerts'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth']

  new_options = opts.merge(
    :operation => :"MonitoringApi.list_monitoring_alerts",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#list_monitoring_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end