Class: Google::Cloud::Monitoring::V3::MetricServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/monitoring/v3/metric_service_client.rb

Overview

Manages metric descriptors, monitored resource descriptors, and time series data.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"monitoring.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT =
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/monitoring",
  "https://www.googleapis.com/auth/monitoring.read",
  "https://www.googleapis.com/auth/monitoring.write"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ MetricServiceClient

Returns a new instance of MetricServiceClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil)

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: ALL_SCOPES)

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {})

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT)

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil)

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • service_address (String) (defaults to: nil)

    Override for the service hostname, or nil to leave as the default.

  • service_port (Integer) (defaults to: nil)

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil)

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



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
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 165

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    service_address: nil,
    service_port: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/monitoring/v3/metric_service_services_pb"

  credentials ||= Google::Cloud::Monitoring::V3::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Monitoring::V3::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Google::Cloud::Monitoring::VERSION

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
    headers[:"x-goog-user-project"] = credentials.quota_project_id
  end
  headers.merge!() unless .nil?
  client_config_file = Pathname.new(__dir__).join(
    "metric_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.monitoring.v3.MetricService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = service_address || self.class::SERVICE_ADDRESS
  port = service_port || self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @metric_service_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Monitoring::V3::MetricService::Stub.method(:new)
  )

  @list_monitored_resource_descriptors = Google::Gax.create_api_call(
    @metric_service_stub.method(:list_monitored_resource_descriptors),
    defaults["list_monitored_resource_descriptors"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_monitored_resource_descriptor = Google::Gax.create_api_call(
    @metric_service_stub.method(:get_monitored_resource_descriptor),
    defaults["get_monitored_resource_descriptor"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_metric_descriptors = Google::Gax.create_api_call(
    @metric_service_stub.method(:list_metric_descriptors),
    defaults["list_metric_descriptors"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_metric_descriptor = Google::Gax.create_api_call(
    @metric_service_stub.method(:get_metric_descriptor),
    defaults["get_metric_descriptor"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_metric_descriptor = Google::Gax.create_api_call(
    @metric_service_stub.method(:create_metric_descriptor),
    defaults["create_metric_descriptor"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @delete_metric_descriptor = Google::Gax.create_api_call(
    @metric_service_stub.method(:delete_metric_descriptor),
    defaults["delete_metric_descriptor"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_time_series = Google::Gax.create_api_call(
    @metric_service_stub.method(:list_time_series),
    defaults["list_time_series"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_time_series = Google::Gax.create_api_call(
    @metric_service_stub.method(:create_time_series),
    defaults["create_time_series"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
end

Class Method Details

.metric_descriptor_path(project, metric_descriptor) ⇒ String

Returns a fully-qualified metric_descriptor resource name string.

Parameters:

  • project (String)
  • metric_descriptor (String)

Returns:

  • (String)


105
106
107
108
109
110
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 105

def self.metric_descriptor_path project, metric_descriptor
  METRIC_DESCRIPTOR_PATH_TEMPLATE.render(
    :"project" => project,
    :"metric_descriptor" => metric_descriptor
  )
end

.monitored_resource_descriptor_path(project, monitored_resource_descriptor) ⇒ String

Returns a fully-qualified monitored_resource_descriptor resource name string.

Parameters:

  • project (String)
  • monitored_resource_descriptor (String)

Returns:

  • (String)


116
117
118
119
120
121
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 116

def self.monitored_resource_descriptor_path project, monitored_resource_descriptor
  MONITORED_RESOURCE_DESCRIPTOR_PATH_TEMPLATE.render(
    :"project" => project,
    :"monitored_resource_descriptor" => monitored_resource_descriptor
  )
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String)


126
127
128
129
130
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 126

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

Instance Method Details

#create_metric_descriptor(name, metric_descriptor, options: nil) {|result, operation| ... } ⇒ Google::Api::MetricDescriptor

Creates a new metric descriptor. User-created metric descriptors define custom metrics.

Examples:

require "google/cloud/monitoring"

metric_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path("[PROJECT]")

# TODO: Initialize `metric_descriptor`:
metric_descriptor = {}
response = metric_client.create_metric_descriptor(formatted_name, metric_descriptor)

Parameters:

  • name (String)

    Required. The project on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]
    
  • metric_descriptor (Google::Api::MetricDescriptor | Hash)

    Required. The new custom metric descriptor. A hash of the same form as Google::Api::MetricDescriptor can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



545
546
547
548
549
550
551
552
553
554
555
556
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 545

def create_metric_descriptor \
    name,
    metric_descriptor,
    options: nil,
    &block
  req = {
    name: name,
    metric_descriptor: metric_descriptor
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::CreateMetricDescriptorRequest)
  @create_metric_descriptor.call(req, options, &block)
end

#create_time_series(name, time_series, options: nil) {|result, operation| ... } ⇒ Object

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

Examples:

require "google/cloud/monitoring"

metric_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path("[PROJECT]")

# TODO: Initialize `time_series`:
time_series = []
metric_client.create_time_series(formatted_name, time_series)

Parameters:

  • name (String)

    Required. The project on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]
    
  • time_series (Array<Google::Monitoring::V3::TimeSeries | Hash>)

    Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.

    The maximum number of TimeSeries objects per Create request is 200. A hash of the same form as Google::Monitoring::V3::TimeSeries can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • result

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



733
734
735
736
737
738
739
740
741
742
743
744
745
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 733

def create_time_series \
    name,
    time_series,
    options: nil,
    &block
  req = {
    name: name,
    time_series: time_series
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::CreateTimeSeriesRequest)
  @create_time_series.call(req, options, &block)
  nil
end

#delete_metric_descriptor(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes a metric descriptor. Only user-created custom metrics can be deleted.

Examples:

require "google/cloud/monitoring"

metric_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.metric_descriptor_path("[PROJECT]", "[METRIC_DESCRIPTOR]")
metric_client.delete_metric_descriptor(formatted_name)

Parameters:

  • name (String)

    Required. The metric descriptor on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
    

    An example of [METRIC_ID] is: "custom.googleapis.com/my_test_metric".

  • options (Google::Gax::CallOptions) (defaults to: nil)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • result

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



583
584
585
586
587
588
589
590
591
592
593
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 583

def delete_metric_descriptor \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::DeleteMetricDescriptorRequest)
  @delete_metric_descriptor.call(req, options, &block)
  nil
end

#get_metric_descriptor(name, options: nil) {|result, operation| ... } ⇒ Google::Api::MetricDescriptor

Gets a single metric descriptor. This method does not require a Workspace.

Examples:

require "google/cloud/monitoring"

metric_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.metric_descriptor_path("[PROJECT]", "[METRIC_DESCRIPTOR]")
response = metric_client.get_metric_descriptor(formatted_name)

Parameters:

  • name (String)

    Required. The metric descriptor on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
    

    An example value of [METRIC_ID] is "compute.googleapis.com/instance/disk/read_bytes_count".

  • options (Google::Gax::CallOptions) (defaults to: nil)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



503
504
505
506
507
508
509
510
511
512
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 503

def get_metric_descriptor \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::GetMetricDescriptorRequest)
  @get_metric_descriptor.call(req, options, &block)
end

#get_monitored_resource_descriptor(name, options: nil) {|result, operation| ... } ⇒ Google::Api::MonitoredResourceDescriptor

Gets a single monitored resource descriptor. This method does not require a Workspace.

Examples:

require "google/cloud/monitoring"

metric_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.monitored_resource_descriptor_path("[PROJECT]", "[MONITORED_RESOURCE_DESCRIPTOR]")
response = metric_client.get_monitored_resource_descriptor(formatted_name)

Parameters:

  • name (String)

    Required. The monitored resource descriptor to get. The format is:

    projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE]
    

    The [RESOURCE_TYPE] is a predefined type, such as cloudsql_database.

  • options (Google::Gax::CallOptions) (defaults to: nil)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



401
402
403
404
405
406
407
408
409
410
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 401

def get_monitored_resource_descriptor \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::GetMonitoredResourceDescriptorRequest)
  @get_monitored_resource_descriptor.call(req, options, &block)
end

#list_metric_descriptors(name, filter: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Api::MetricDescriptor>

Lists metric descriptors that match a filter. This method does not require a Workspace.

Examples:

require "google/cloud/monitoring"

metric_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path("[PROJECT]")

# Iterate over all results.
metric_client.list_metric_descriptors(formatted_name).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
metric_client.list_metric_descriptors(formatted_name).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • name (String)

    Required. The project on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]
    
  • filter (String) (defaults to: nil)

    If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:

    metric.type = starts_with("custom.googleapis.com/")
    
  • page_size (Integer) (defaults to: nil)

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Api::MetricDescriptor>)

    An enumerable of Google::Api::MetricDescriptor instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



464
465
466
467
468
469
470
471
472
473
474
475
476
477
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 464

def list_metric_descriptors \
    name,
    filter: nil,
    page_size: nil,
    options: nil,
    &block
  req = {
    name: name,
    filter: filter,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::ListMetricDescriptorsRequest)
  @list_metric_descriptors.call(req, options, &block)
end

#list_monitored_resource_descriptors(name, filter: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Api::MonitoredResourceDescriptor>

Lists monitored resource descriptors that match a filter. This method does not require a Workspace.

Examples:

require "google/cloud/monitoring"

metric_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path("[PROJECT]")

# Iterate over all results.
metric_client.list_monitored_resource_descriptors(formatted_name).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
metric_client.list_monitored_resource_descriptors(formatted_name).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • name (String)

    Required. The project on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]
    
  • filter (String) (defaults to: nil)

    An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:

    resource.type = starts_with("gce_") AND resource.label:id
    
  • page_size (Integer) (defaults to: nil)

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Api::MonitoredResourceDescriptor>)

    An enumerable of Google::Api::MonitoredResourceDescriptor instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 362

def list_monitored_resource_descriptors \
    name,
    filter: nil,
    page_size: nil,
    options: nil,
    &block
  req = {
    name: name,
    filter: filter,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::ListMonitoredResourceDescriptorsRequest)
  @list_monitored_resource_descriptors.call(req, options, &block)
end

#list_time_series(name, filter, interval, view, aggregation: nil, order_by: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Monitoring::V3::TimeSeries>

Lists time series that match a filter. This method does not require a Workspace.

Examples:

require "google/cloud/monitoring"

metric_client = Google::Cloud::Monitoring::Metric.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path("[PROJECT]")

# TODO: Initialize `filter`:
filter = ''

# TODO: Initialize `interval`:
interval = {}

# TODO: Initialize `view`:
view = :FULL

# Iterate over all results.
metric_client.list_time_series(formatted_name, filter, interval, view).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
metric_client.list_time_series(formatted_name, filter, interval, view).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • name (String)

    Required. The project on which to execute the request. The format is:

    projects/[PROJECT_ID_OR_NUMBER]
    
  • filter (String)

    Required. A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:

    metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
        metric.labels.instance_name = "my-instance-name"
    
  • interval (Google::Monitoring::V3::TimeInterval | Hash)

    Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response. A hash of the same form as Google::Monitoring::V3::TimeInterval can also be provided.

  • view (Google::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView)

    Required. Specifies which information is returned about the time series.

  • aggregation (Google::Monitoring::V3::Aggregation | Hash) (defaults to: nil)

    Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.

    By default (if no aggregation is explicitly specified), the raw time series data is returned. A hash of the same form as Google::Monitoring::V3::Aggregation can also be provided.

  • order_by (String) (defaults to: nil)

    Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

  • page_size (Integer) (defaults to: nil)

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Monitoring::V3::TimeSeries>)

    An enumerable of Google::Monitoring::V3::TimeSeries instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
# File 'lib/google/cloud/monitoring/v3/metric_service_client.rb', line 674

def list_time_series \
    name,
    filter,
    interval,
    view,
    aggregation: nil,
    order_by: nil,
    page_size: nil,
    options: nil,
    &block
  req = {
    name: name,
    filter: filter,
    interval: interval,
    view: view,
    aggregation: aggregation,
    order_by: order_by,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Monitoring::V3::ListTimeSeriesRequest)
  @list_time_series.call(req, options, &block)
end