Class: Google::Cloud::Monitoring::V3::AlertPolicyServiceClient

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

Overview

The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Stackdriver Monitoring. An alerting policy is a description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. In addition to using this API, alert policies can also be managed through Stackdriver Monitoring, which can be reached by clicking the "Monitoring" tab in Cloud Console.

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: "") ⇒ AlertPolicyServiceClient

Returns a new instance of AlertPolicyServiceClient

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.

  • service_address (String)

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

  • service_port (Integer)

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

  • exception_transformer (Proc)

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



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

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/alert_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 }
  headers.merge!() unless .nil?
  client_config_file = Pathname.new(__dir__).join(
    "alert_policy_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.monitoring.v3.AlertPolicyService",
      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
  @alert_policy_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::AlertPolicyService::Stub.method(:new)
  )

  @list_alert_policies = Google::Gax.create_api_call(
    @alert_policy_service_stub.method(:list_alert_policies),
    defaults["list_alert_policies"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_alert_policy = Google::Gax.create_api_call(
    @alert_policy_service_stub.method(:get_alert_policy),
    defaults["get_alert_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_alert_policy = Google::Gax.create_api_call(
    @alert_policy_service_stub.method(:create_alert_policy),
    defaults["create_alert_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @delete_alert_policy = Google::Gax.create_api_call(
    @alert_policy_service_stub.method(:delete_alert_policy),
    defaults["delete_alert_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @update_alert_policy = Google::Gax.create_api_call(
    @alert_policy_service_stub.method(:update_alert_policy),
    defaults["update_alert_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'alert_policy.name' => request.alert_policy.name}
    end
  )
end

Class Method Details

.alert_policy_condition_path(project, alert_policy, condition) ⇒ String

Returns a fully-qualified alert_policy_condition resource name string.

Parameters:

  • project (String)
  • alert_policy (String)
  • condition (String)

Returns:

  • (String)


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

def self.alert_policy_condition_path project, alert_policy, condition
  ALERT_POLICY_CONDITION_PATH_TEMPLATE.render(
    :"project" => project,
    :"alert_policy" => alert_policy,
    :"condition" => condition
  )
end

.alert_policy_path(project, alert_policy) ⇒ String

Returns a fully-qualified alert_policy resource name string.

Parameters:

  • project (String)
  • alert_policy (String)

Returns:

  • (String)


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

def self.alert_policy_path project, alert_policy
  ALERT_POLICY_PATH_TEMPLATE.render(
    :"project" => project,
    :"alert_policy" => alert_policy
  )
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String)


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

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

Instance Method Details

#create_alert_policy(name, alert_policy, options: nil) {|result, operation| ... } ⇒ Google::Monitoring::V3::AlertPolicy

Creates a new alerting policy.

Examples:

require "google/cloud/monitoring"

alert_policy_client = Google::Cloud::Monitoring::AlertPolicy.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::AlertPolicyServiceClient.project_path("[PROJECT]")

# TODO: Initialize `alert_policy`:
alert_policy = {}
response = alert_policy_client.create_alert_policy(formatted_name, alert_policy)

Parameters:

  • name (String)

    The project in which to create the alerting policy. The format is projects/[PROJECT_ID].

    Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in the container.

  • alert_policy (Google::Monitoring::V3::AlertPolicy | Hash)

    The requested alerting policy. You should omit the name field in this policy. The name will be returned in the new policy, including a new [ALERT_POLICY_ID] value. A hash of the same form as Google::Monitoring::V3::AlertPolicy 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.



432
433
434
435
436
437
438
439
440
441
442
443
# File 'lib/google/cloud/monitoring/v3/alert_policy_service_client.rb', line 432

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

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

Deletes an alerting policy.

Examples:

require "google/cloud/monitoring"

alert_policy_client = Google::Cloud::Monitoring::AlertPolicy.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::AlertPolicyServiceClient.alert_policy_path("[PROJECT]", "[ALERT_POLICY]")
alert_policy_client.delete_alert_policy(formatted_name)

Parameters:

  • name (String)

    The alerting policy to delete. The format is:

    projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
    

    For more information, see AlertPolicy.

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



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

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

#get_alert_policy(name, options: nil) {|result, operation| ... } ⇒ Google::Monitoring::V3::AlertPolicy

Gets a single alerting policy.

Examples:

require "google/cloud/monitoring"

alert_policy_client = Google::Cloud::Monitoring::AlertPolicy.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::AlertPolicyServiceClient.alert_policy_path("[PROJECT]", "[ALERT_POLICY]")
response = alert_policy_client.get_alert_policy(formatted_name)

Parameters:

  • name (String)

    The alerting policy to retrieve. The format is

    projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_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.



386
387
388
389
390
391
392
393
394
395
# File 'lib/google/cloud/monitoring/v3/alert_policy_service_client.rb', line 386

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

#list_alert_policies(name, filter: nil, order_by: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Monitoring::V3::AlertPolicy>

Lists the existing alerting policies for the project.

Examples:

require "google/cloud/monitoring"

alert_policy_client = Google::Cloud::Monitoring::AlertPolicy.new(version: :v3)
formatted_name = Google::Cloud::Monitoring::V3::AlertPolicyServiceClient.project_path("[PROJECT]")

# Iterate over all results.
alert_policy_client.list_alert_policies(formatted_name).each do |element|
  # Process element.
end

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

Parameters:

  • name (String)

    The project whose alert policies are to be listed. The format is

    projects/[PROJECT_ID]
    

    Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

  • filter (String)

    If provided, this field specifies the criteria that must be met by alert policies to be included in the response.

    For more details, see sorting and filtering.

  • order_by (String)

    A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.

    For more details, see sorting and filtering.

  • 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::Monitoring::V3::AlertPolicy>)

    An enumerable of Google::Monitoring::V3::AlertPolicy 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.



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
# File 'lib/google/cloud/monitoring/v3/alert_policy_service_client.rb', line 348

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

#update_alert_policy(alert_policy, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Monitoring::V3::AlertPolicy

Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.

Examples:

require "google/cloud/monitoring"

alert_policy_client = Google::Cloud::Monitoring::AlertPolicy.new(version: :v3)

# TODO: Initialize `alert_policy`:
alert_policy = {}
response = alert_policy_client.update_alert_policy(alert_policy)

Parameters:

  • alert_policy (Google::Monitoring::V3::AlertPolicy | Hash)

    Required. The updated alerting policy or the updated values for the fields listed in update_mask. If update_mask is not empty, any fields in this policy that are not in update_mask are ignored. A hash of the same form as Google::Monitoring::V3::AlertPolicy can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash)

    Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.

    Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.

    If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following:

    • The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents.
    • Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created. A hash of the same form as Google::Protobuf::FieldMask 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.



532
533
534
535
536
537
538
539
540
541
542
543
# File 'lib/google/cloud/monitoring/v3/alert_policy_service_client.rb', line 532

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