Class: Google::Cloud::Logging::V2::MetricsServiceV2Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/logging/v2/metrics_service_v2_client.rb

Overview

Service for configuring logs-based metrics.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"logging.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
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/cloud-platform.read-only",
  "https://www.googleapis.com/auth/logging.admin",
  "https://www.googleapis.com/auth/logging.read",
  "https://www.googleapis.com/auth/logging.write"
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "") ⇒ MetricsServiceV2Client

Returns a new instance of MetricsServiceV2Client

Parameters:

  • service_path (String) —

    The domain name of the API remote host.

  • port (Integer) —

    The port on which to connect to the remote host.

  • channel (Channel) —

    A Channel object through which to make calls.

  • chan_creds (Grpc::ChannelCredentials) —

    A ChannelCredentials for the setting up the RPC client.

  • client_config (Hash) —

    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) —

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



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
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 138

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    app_name: nil,
    app_version: 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/logging/v2/logging_metrics_services_pb"


  if app_name || app_version
    warn "`app_name` and `app_version` are no longer being used in the request headers."
  end

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

  headers = { :"x-goog-api-client" => google_api_client }
  client_config_file = Pathname.new(__dir__).join(
    "metrics_service_v2_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.logging.v2.MetricsServiceV2",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      kwargs: headers
    )
  end
  @metrics_service_v2_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    scopes: scopes,
    &Google::Logging::V2::MetricsServiceV2::Stub.method(:new)
  )

  @list_log_metrics = Google::Gax.create_api_call(
    @metrics_service_v2_stub.method(:list_log_metrics),
    defaults["list_log_metrics"]
  )
  @get_log_metric = Google::Gax.create_api_call(
    @metrics_service_v2_stub.method(:get_log_metric),
    defaults["get_log_metric"]
  )
  @create_log_metric = Google::Gax.create_api_call(
    @metrics_service_v2_stub.method(:create_log_metric),
    defaults["create_log_metric"]
  )
  @update_log_metric = Google::Gax.create_api_call(
    @metrics_service_v2_stub.method(:update_log_metric),
    defaults["update_log_metric"]
  )
  @delete_log_metric = Google::Gax.create_api_call(
    @metrics_service_v2_stub.method(:delete_log_metric),
    defaults["delete_log_metric"]
  )
end

Instance Attribute Details

#metrics_service_v2_stub ⇒ Google::Logging::V2::MetricsServiceV2::Stub (readonly)

Returns:

  • (Google::Logging::V2::MetricsServiceV2::Stub) 


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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 40

class MetricsServiceV2Client
  attr_reader :metrics_service_v2_stub

  # The default address of the service.
  SERVICE_ADDRESS = "logging.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_log_metrics" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "metrics")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/cloud-platform.read-only",
    "https://www.googleapis.com/auth/logging.admin",
    "https://www.googleapis.com/auth/logging.read",
    "https://www.googleapis.com/auth/logging.write"
  ].freeze

  PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}"
  )

  private_constant :PROJECT_PATH_TEMPLATE

  METRIC_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/metrics/{metric}"
  )

  private_constant :METRIC_PATH_TEMPLATE

  # Returns a fully-qualified project resource name string.
  # @param project [String]
  # @return [String]
  def self.project_path project
    PROJECT_PATH_TEMPLATE.render(
      :"project" => project
    )
  end

  # Returns a fully-qualified metric resource name string.
  # @param project [String]
  # @param metric [String]
  # @return [String]
  def self.metric_path project, metric
    METRIC_PATH_TEMPLATE.render(
      :"project" => project,
      :"metric" => metric
    )
  end

  # Parses the project from a project resource.
  # @param project_name [String]
  # @return [String]
  def self.match_project_from_project_name project_name
    PROJECT_PATH_TEMPLATE.match(project_name)["project"]
  end

  # Parses the project from a metric resource.
  # @param metric_name [String]
  # @return [String]
  def self.match_project_from_metric_name metric_name
    METRIC_PATH_TEMPLATE.match(metric_name)["project"]
  end

  # Parses the metric from a metric resource.
  # @param metric_name [String]
  # @return [String]
  def self.match_metric_from_metric_name metric_name
    METRIC_PATH_TEMPLATE.match(metric_name)["metric"]
  end

  # @param service_path [String]
  #   The domain name of the API remote host.
  # @param port [Integer]
  #   The port on which to connect to the remote host.
  # @param channel [Channel]
  #   A Channel object through which to make calls.
  # @param chan_creds [Grpc::ChannelCredentials]
  #   A ChannelCredentials for the setting up the RPC client.
  # @param client_config[Hash]
  #   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.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      app_name: nil,
      app_version: 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/logging/v2/logging_metrics_services_pb"


    if app_name || app_version
      warn "`app_name` and `app_version` are no longer being used in the request headers."
    end

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

    headers = { :"x-goog-api-client" => google_api_client }
    client_config_file = Pathname.new(__dir__).join(
      "metrics_service_v2_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.logging.v2.MetricsServiceV2",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @metrics_service_v2_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      scopes: scopes,
      &Google::Logging::V2::MetricsServiceV2::Stub.method(:new)
    )

    @list_log_metrics = Google::Gax.create_api_call(
      @metrics_service_v2_stub.method(:list_log_metrics),
      defaults["list_log_metrics"]
    )
    @get_log_metric = Google::Gax.create_api_call(
      @metrics_service_v2_stub.method(:get_log_metric),
      defaults["get_log_metric"]
    )
    @create_log_metric = Google::Gax.create_api_call(
      @metrics_service_v2_stub.method(:create_log_metric),
      defaults["create_log_metric"]
    )
    @update_log_metric = Google::Gax.create_api_call(
      @metrics_service_v2_stub.method(:update_log_metric),
      defaults["update_log_metric"]
    )
    @delete_log_metric = Google::Gax.create_api_call(
      @metrics_service_v2_stub.method(:delete_log_metric),
      defaults["delete_log_metric"]
    )
  end

  # Service calls

  # Lists logs-based metrics.
  #
  # @param parent [String]
  #   Required. The name of the project containing the metrics:
  #
  #       "projects/[PROJECT_ID]"
  # @param page_size [Integer]
  #   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.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Logging::V2::LogMetric>]
  #   An enumerable of Google::Logging::V2::LogMetric instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2/metrics_service_v2_client"
  #
  #   MetricsServiceV2Client = Google::Cloud::Logging::V2::MetricsServiceV2Client
  #
  #   metrics_service_v2_client = MetricsServiceV2Client.new
  #   formatted_parent = MetricsServiceV2Client.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   metrics_service_v2_client.list_log_metrics(formatted_parent).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   metrics_service_v2_client.list_log_metrics(formatted_parent).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_log_metrics \
      parent,
      page_size: nil,
      options: nil
    req = Google::Logging::V2::ListLogMetricsRequest.new({
      parent: parent,
      page_size: page_size
    }.delete_if { |_, v| v.nil? })
    @list_log_metrics.call(req, options)
  end

  # Gets a logs-based metric.
  #
  # @param metric_name [String]
  #   The resource name of the desired metric:
  #
  #       "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogMetric]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2/metrics_service_v2_client"
  #
  #   MetricsServiceV2Client = Google::Cloud::Logging::V2::MetricsServiceV2Client
  #
  #   metrics_service_v2_client = MetricsServiceV2Client.new
  #   formatted_metric_name = MetricsServiceV2Client.metric_path("[PROJECT]", "[METRIC]")
  #   response = metrics_service_v2_client.get_log_metric(formatted_metric_name)

  def get_log_metric \
      metric_name,
      options: nil
    req = Google::Logging::V2::GetLogMetricRequest.new({
      metric_name: metric_name
    }.delete_if { |_, v| v.nil? })
    @get_log_metric.call(req, options)
  end

  # Creates a logs-based metric.
  #
  # @param parent [String]
  #   The resource name of the project in which to create the metric:
  #
  #       "projects/[PROJECT_ID]"
  #
  #   The new metric must be provided in the request.
  # @param metric [Google::Logging::V2::LogMetric]
  #   The new logs-based metric, which must not have an identifier that
  #   already exists.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogMetric]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2/metrics_service_v2_client"
  #
  #   LogMetric = Google::Logging::V2::LogMetric
  #   MetricsServiceV2Client = Google::Cloud::Logging::V2::MetricsServiceV2Client
  #
  #   metrics_service_v2_client = MetricsServiceV2Client.new
  #   formatted_parent = MetricsServiceV2Client.project_path("[PROJECT]")
  #   metric = LogMetric.new
  #   response = metrics_service_v2_client.create_log_metric(formatted_parent, metric)

  def create_log_metric \
      parent,
      metric,
      options: nil
    req = Google::Logging::V2::CreateLogMetricRequest.new({
      parent: parent,
      metric: metric
    }.delete_if { |_, v| v.nil? })
    @create_log_metric.call(req, options)
  end

  # Creates or updates a logs-based metric.
  #
  # @param metric_name [String]
  #   The resource name of the metric to update:
  #
  #       "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
  #
  #   The updated metric must be provided in the request and it's
  #   +name+ field must be the same as +[METRIC_ID]+ If the metric
  #   does not exist in +[PROJECT_ID]+, then a new metric is created.
  # @param metric [Google::Logging::V2::LogMetric]
  #   The updated metric.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Logging::V2::LogMetric]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2/metrics_service_v2_client"
  #
  #   LogMetric = Google::Logging::V2::LogMetric
  #   MetricsServiceV2Client = Google::Cloud::Logging::V2::MetricsServiceV2Client
  #
  #   metrics_service_v2_client = MetricsServiceV2Client.new
  #   formatted_metric_name = MetricsServiceV2Client.metric_path("[PROJECT]", "[METRIC]")
  #   metric = LogMetric.new
  #   response = metrics_service_v2_client.update_log_metric(formatted_metric_name, metric)

  def update_log_metric \
      metric_name,
      metric,
      options: nil
    req = Google::Logging::V2::UpdateLogMetricRequest.new({
      metric_name: metric_name,
      metric: metric
    }.delete_if { |_, v| v.nil? })
    @update_log_metric.call(req, options)
  end

  # Deletes a logs-based metric.
  #
  # @param metric_name [String]
  #   The resource name of the metric to delete:
  #
  #       "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/logging/v2/metrics_service_v2_client"
  #
  #   MetricsServiceV2Client = Google::Cloud::Logging::V2::MetricsServiceV2Client
  #
  #   metrics_service_v2_client = MetricsServiceV2Client.new
  #   formatted_metric_name = MetricsServiceV2Client.metric_path("[PROJECT]", "[METRIC]")
  #   metrics_service_v2_client.delete_log_metric(formatted_metric_name)

  def delete_log_metric \
      metric_name,
      options: nil
    req = Google::Logging::V2::DeleteLogMetricRequest.new({
      metric_name: metric_name
    }.delete_if { |_, v| v.nil? })
    @delete_log_metric.call(req, options)
    nil
  end
end

Class Method Details

.match_metric_from_metric_name(metric_name) ⇒ String

Parses the metric from a metric resource.

Parameters:

  • metric_name (String)

Returns:

  • (String) 


119
120
121
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 119

def self.match_metric_from_metric_name metric_name
  METRIC_PATH_TEMPLATE.match(metric_name)["metric"]
end

.match_project_from_metric_name(metric_name) ⇒ String

Parses the project from a metric resource.

Parameters:

  • metric_name (String)

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 112

def self.match_project_from_metric_name metric_name
  METRIC_PATH_TEMPLATE.match(metric_name)["project"]
end

.match_project_from_project_name(project_name) ⇒ String

Parses the project from a project resource.

Parameters:

  • project_name (String)

Returns:

  • (String) 


105
106
107
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 105

def self.match_project_from_project_name project_name
  PROJECT_PATH_TEMPLATE.match(project_name)["project"]
end

.metric_path(project, metric) ⇒ String

Returns a fully-qualified metric resource name string.

Parameters:

  • project (String)
  • metric (String)

Returns:

  • (String) 


95
96
97
98
99
100
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 95

def self.metric_path project, metric
  METRIC_PATH_TEMPLATE.render(
    :"project" => project,
    :"metric" => metric
  )
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


85
86
87
88
89
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 85

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

Instance Method Details

#create_log_metric(parent, metric, options: nil) ⇒ Google::Logging::V2::LogMetric

Creates a logs-based metric.

Examples:

require "google/cloud/logging/v2/metrics_service_v2_client"

LogMetric = Google::Logging::V2::LogMetric
MetricsServiceV2Client = Google::Cloud::Logging::V2::MetricsServiceV2Client

metrics_service_v2_client = MetricsServiceV2Client.new
formatted_parent = MetricsServiceV2Client.project_path("[PROJECT]")
metric = LogMetric.new
response = metrics_service_v2_client.create_log_metric(formatted_parent, metric)

Parameters:

  • parent (String) —

    The resource name of the project in which to create the metric:

    "projects/[PROJECT_ID]"

    The new metric must be provided in the request.

  • metric (Google::Logging::V2::LogMetric) —

    The new logs-based metric, which must not have an identifier that already exists.

  • options (Google::Gax::CallOptions) —

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



325
326
327
328
329
330
331
332
333
334
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 325

def create_log_metric \
    parent,
    metric,
    options: nil
  req = Google::Logging::V2::CreateLogMetricRequest.new({
    parent: parent,
    metric: metric
  }.delete_if { |_, v| v.nil? })
  @create_log_metric.call(req, options)
end

#delete_log_metric(metric_name, options: nil) ⇒ Object

Deletes a logs-based metric.

Examples:

require "google/cloud/logging/v2/metrics_service_v2_client"

MetricsServiceV2Client = Google::Cloud::Logging::V2::MetricsServiceV2Client

metrics_service_v2_client = MetricsServiceV2Client.new
formatted_metric_name = MetricsServiceV2Client.metric_path("[PROJECT]", "[METRIC]")
metrics_service_v2_client.delete_log_metric(formatted_metric_name)

Parameters:

  • metric_name (String) —

    The resource name of the metric to delete:

    "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
  • options (Google::Gax::CallOptions) —

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

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



394
395
396
397
398
399
400
401
402
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 394

def delete_log_metric \
    metric_name,
    options: nil
  req = Google::Logging::V2::DeleteLogMetricRequest.new({
    metric_name: metric_name
  }.delete_if { |_, v| v.nil? })
  @delete_log_metric.call(req, options)
  nil
end

#get_log_metric(metric_name, options: nil) ⇒ Google::Logging::V2::LogMetric

Gets a logs-based metric.

Examples:

require "google/cloud/logging/v2/metrics_service_v2_client"

MetricsServiceV2Client = Google::Cloud::Logging::V2::MetricsServiceV2Client

metrics_service_v2_client = MetricsServiceV2Client.new
formatted_metric_name = MetricsServiceV2Client.metric_path("[PROJECT]", "[METRIC]")
response = metrics_service_v2_client.get_log_metric(formatted_metric_name)

Parameters:

  • metric_name (String) —

    The resource name of the desired metric:

    "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
  • options (Google::Gax::CallOptions) —

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



289
290
291
292
293
294
295
296
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 289

def get_log_metric \
    metric_name,
    options: nil
  req = Google::Logging::V2::GetLogMetricRequest.new({
    metric_name: metric_name
  }.delete_if { |_, v| v.nil? })
  @get_log_metric.call(req, options)
end

#list_log_metrics(parent, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Logging::V2::LogMetric>

Lists logs-based metrics.

Examples:

require "google/cloud/logging/v2/metrics_service_v2_client"

MetricsServiceV2Client = Google::Cloud::Logging::V2::MetricsServiceV2Client

metrics_service_v2_client = MetricsServiceV2Client.new
formatted_parent = MetricsServiceV2Client.project_path("[PROJECT]")

# Iterate over all results.
metrics_service_v2_client.list_log_metrics(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
metrics_service_v2_client.list_log_metrics(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Required. The name of the project containing the metrics:

    "projects/[PROJECT_ID]"
  • page_size (Integer) —

    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) —

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

Returns:

  • (Google::Gax::PagedEnumerable<Google::Logging::V2::LogMetric>) —

    An enumerable of Google::Logging::V2::LogMetric 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.



258
259
260
261
262
263
264
265
266
267
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 258

def list_log_metrics \
    parent,
    page_size: nil,
    options: nil
  req = Google::Logging::V2::ListLogMetricsRequest.new({
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? })
  @list_log_metrics.call(req, options)
end

#update_log_metric(metric_name, metric, options: nil) ⇒ Google::Logging::V2::LogMetric

Creates or updates a logs-based metric.

Examples:

require "google/cloud/logging/v2/metrics_service_v2_client"

LogMetric = Google::Logging::V2::LogMetric
MetricsServiceV2Client = Google::Cloud::Logging::V2::MetricsServiceV2Client

metrics_service_v2_client = MetricsServiceV2Client.new
formatted_metric_name = MetricsServiceV2Client.metric_path("[PROJECT]", "[METRIC]")
metric = LogMetric.new
response = metrics_service_v2_client.update_log_metric(formatted_metric_name, metric)

Parameters:

  • metric_name (String) —

    The resource name of the metric to update:

    "projects/[PROJECT_ID]/metrics/[METRIC_ID]"

    The updated metric must be provided in the request and it's +name+ field must be the same as +[METRIC_ID]+ If the metric does not exist in +[PROJECT_ID]+, then a new metric is created.

  • metric (Google::Logging::V2::LogMetric) —

    The updated metric.

  • options (Google::Gax::CallOptions) —

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



364
365
366
367
368
369
370
371
372
373
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 364

def update_log_metric \
    metric_name,
    metric,
    options: nil
  req = Google::Logging::V2::UpdateLogMetricRequest.new({
    metric_name: metric_name,
    metric: metric
  }.delete_if { |_, v| v.nil? })
  @update_log_metric.call(req, options)
end