Class: Apcera::MetricsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/apcera/api/metrics_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = nil) ⇒ MetricsApi

Returns a new instance of MetricsApi.



7
8
9
 
# File 'lib/apcera/api/metrics_api.rb', line 7

def initialize(api_client = nil)
  @api_client = api_client || Configuration.api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/apcera/api/metrics_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#metrics_cluster_get(opts = {}) ⇒ Metrics

Returns metrics data for the cluster. Returns metrics data for the cluster.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :metric (Array<String>) —

    Comma-delimited string that includes, in order, the following fields: n * Job FQN (wildcards accepted) n * Instance manager hostname (can be a wildcard)n * Instance ID n * Metric to evaluate n * &#39;From&#39; time (optional)n * &#39;To&#39; time (optional).

  • :authorization (String)

Returns:



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
 
# File 'lib/apcera/api/metrics_api.rb', line 17

def metrics_cluster_get(opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: MetricsApi#metrics_cluster_get ..."
  end
  
  
  # resource path
  path = "/metrics/cluster".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'metric'] = opts[:'metric'] if opts[:'metric']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Metrics')
  if Configuration.debugging
    Configuration.logger.debug "API called: MetricsApi#metrics_cluster_get. Result: #{result.inspect}"
  end
  return result
end

#metrics_instance_managers_get(opts = {}) ⇒ Metrics

Returns metrics for instance managers. Returns metrics for instance managers.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
 
# File 'lib/apcera/api/metrics_api.rb', line 70

def metrics_instance_managers_get(opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: MetricsApi#metrics_instance_managers_get ..."
  end
  
  
  # resource path
  path = "/metrics/instance_managers".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'metric'] = opts[:'metric'] if opts[:'metric']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Metrics')
  if Configuration.debugging
    Configuration.logger.debug "API called: MetricsApi#metrics_instance_managers_get. Result: #{result.inspect}"
  end
  return result
end

#metrics_jobs_get(opts = {}) ⇒ Metrics

Returns job metrics. Returns job metrics.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :metric (Array<String>) —

    Comma-delimited string that includes, in order, the following fields: n * Job FQN (wildcards accepted) n * Instance manager hostname (can be a wildcard)n * Instance ID n * Metric to evaluate n * &#39;From&#39; time (optional)n * &#39;To&#39; time (optional).

  • :authorization (String)

Returns:



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
 
# File 'lib/apcera/api/metrics_api.rb', line 123

def metrics_jobs_get(opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: MetricsApi#metrics_jobs_get ..."
  end
  
  
  # resource path
  path = "/metrics/jobs".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'metric'] = opts[:'metric'] if opts[:'metric']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Metrics')
  if Configuration.debugging
    Configuration.logger.debug "API called: MetricsApi#metrics_jobs_get. Result: #{result.inspect}"
  end
  return result
end

#metrics_route_counters_get(opts = {}) ⇒ Metrics

Returns metrics for counters on the route.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
 
# File 'lib/apcera/api/metrics_api.rb', line 176

def metrics_route_counters_get(opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: MetricsApi#metrics_route_counters_get ..."
  end
  
  
  # resource path
  path = "/metrics/route/counters".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'metric'] = opts[:'metric'] if opts[:'metric']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Metrics')
  if Configuration.debugging
    Configuration.logger.debug "API called: MetricsApi#metrics_route_counters_get. Result: #{result.inspect}"
  end
  return result
end

#metrics_route_timers_get(opts = {}) ⇒ Metrics

Returns metrics for timers on the route.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
 
# File 'lib/apcera/api/metrics_api.rb', line 229

def metrics_route_timers_get(opts = {})

  if Configuration.debugging
    Configuration.logger.debug "Calling API: MetricsApi#metrics_route_timers_get ..."
  end
  
  
  # resource path
  path = "/metrics/route/timers".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'metric'] = opts[:'metric'] if opts[:'metric']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = []
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
  header_params[:'authorization'] = opts[:'authorization'] if opts[:'authorization']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['authorization']
  result = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Metrics')
  if Configuration.debugging
    Configuration.logger.debug "API called: MetricsApi#metrics_route_timers_get. Result: #{result.inspect}"
  end
  return result
end