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
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/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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of MetricsServiceV2Client

Parameters:

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

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

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

  • 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.

  • metadata (Hash) —

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

  • exception_transformer (Proc) —

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



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

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: 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/logging/v2/logging_metrics_services_pb"

  credentials ||= Google::Cloud::Logging::V2::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Logging::V2::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 = Gem.loaded_specs['google-cloud-logging'].version.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 }
  headers.merge!(metadata) unless metadata.nil?
  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,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @metrics_service_v2_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &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"],
    exception_transformer: exception_transformer
  )
  @get_log_metric = Google::Gax.create_api_call(
    @metrics_service_v2_stub.method(:get_log_metric),
    defaults["get_log_metric"],
    exception_transformer: exception_transformer
  )
  @create_log_metric = Google::Gax.create_api_call(
    @metrics_service_v2_stub.method(:create_log_metric),
    defaults["create_log_metric"],
    exception_transformer: exception_transformer
  )
  @update_log_metric = Google::Gax.create_api_call(
    @metrics_service_v2_stub.method(:update_log_metric),
    defaults["update_log_metric"],
    exception_transformer: exception_transformer
  )
  @delete_log_metric = Google::Gax.create_api_call(
    @metrics_service_v2_stub.method(:delete_log_metric),
    defaults["delete_log_metric"],
    exception_transformer: exception_transformer
  )
end

Class Method Details

.metric_path(project, metric) ⇒ String

Returns a fully-qualified metric resource name string.

Parameters:

  • project (String)
  • metric (String)

Returns:

  • (String) 


98
99
100
101
102
103
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 98

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) 


88
89
90
91
92
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 88

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

Instance Method Details

#create_log_metric(parent, metric, options: nil) {|result, operation| ... } ⇒ Google::Logging::V2::LogMetric

Creates a logs-based metric.

Examples:

require "google/cloud/logging/v2"

metrics_service_v2_client = Google::Cloud::Logging::V2::MetricsServiceV2Client.new
formatted_parent = Google::Cloud::Logging::V2::MetricsServiceV2Client.project_path("[PROJECT]")

# TODO: Initialize +metric+:
metric = {}
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 | Hash) —

    The new logs-based metric, which must not have an identifier that already exists. A hash of the same form as Google::Logging::V2::LogMetric can also be provided.

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

    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.



356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 356

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

#delete_log_metric(metric_name, options: nil) {|result, operation| ... } ⇒ Object

Deletes a logs-based metric.

Examples:

require "google/cloud/logging/v2"

metrics_service_v2_client = Google::Cloud::Logging::V2::MetricsServiceV2Client.new
formatted_metric_name = Google::Cloud::Logging::V2::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.

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.



434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 434

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

#get_log_metric(metric_name, options: nil) {|result, operation| ... } ⇒ Google::Logging::V2::LogMetric

Gets a logs-based metric.

Examples:

require "google/cloud/logging/v2"

metrics_service_v2_client = Google::Cloud::Logging::V2::MetricsServiceV2Client.new
formatted_metric_name = Google::Cloud::Logging::V2::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.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



314
315
316
317
318
319
320
321
322
323
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 314

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

#list_log_metrics(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Logging::V2::LogMetric>

Lists logs-based metrics.

Examples:

require "google/cloud/logging/v2"

metrics_service_v2_client = Google::Cloud::Logging::V2::MetricsServiceV2Client.new
formatted_parent = Google::Cloud::Logging::V2::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.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

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.



280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/google/cloud/logging/v2/metrics_service_v2_client.rb', line 280

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

#update_log_metric(metric_name, metric, options: nil) {|result, operation| ... } ⇒ Google::Logging::V2::LogMetric

Creates or updates a logs-based metric.

Examples:

require "google/cloud/logging/v2"

metrics_service_v2_client = Google::Cloud::Logging::V2::MetricsServiceV2Client.new
formatted_metric_name = Google::Cloud::Logging::V2::MetricsServiceV2Client.metric_path("[PROJECT]", "[METRIC]")

# TODO: Initialize +metric+:
metric = {}
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 | Hash) —

    The updated metric. A hash of the same form as Google::Logging::V2::LogMetric can also be provided.

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

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

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