Class: Google::Api::Monitoring

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/monitoring.rb

Overview

Monitoring configuration of the service.

The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The library.googleapis.com/book/returned_count metric is sent to both producer and consumer projects, whereas the library.googleapis.com/book/num_overdue metric is only sent to the consumer project.

monitored_resources:
- type: library.googleapis.com/Branch
  display_name: "Library Branch"
  description: "A branch of a library."
  launch_stage: GA
  labels:
  - key: resource_container
    description: "The Cloud container (ie. project id) for the Branch."
  - key: location
    description: "The location of the library branch."
  - key: branch_id
    description: "The id of the branch."
metrics:
- name: library.googleapis.com/book/returned_count
  display_name: "Books Returned"
  description: "The count of books that have been returned."
  launch_stage: GA
  metric_kind: DELTA
  value_type: INT64
  unit: "1"
  labels:
  - key: customer_id
    description: "The id of the customer."
- name: library.googleapis.com/book/num_overdue
  display_name: "Books Overdue"
  description: "The current number of overdue books."
  launch_stage: GA
  metric_kind: GAUGE
  value_type: INT64
  unit: "1"
  labels:
  - key: customer_id
    description: "The id of the customer."
monitoring:
  producer_destinations:
  - monitored_resource: library.googleapis.com/Branch
    metrics:
    - library.googleapis.com/book/returned_count
  consumer_destinations:
  - monitored_resource: library.googleapis.com/Branch
    metrics:
    - library.googleapis.com/book/returned_count
    - library.googleapis.com/book/num_overdue

Defined Under Namespace

Classes: MonitoringDestination

Instance Attribute Summary collapse

Instance Attribute Details

#consumer_destinations ⇒ ::Array<::Google::Api::Monitoring::MonitoringDestination>

Returns Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

Returns:

  • (::Array<::Google::Api::Monitoring::MonitoringDestination>) —

    Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/api/monitoring.rb', line 90

class Monitoring
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration of a specific monitoring destination (the producer project
  # or the consumer project).
  # @!attribute [rw] monitored_resource
  #   @return [::String]
  #     The monitored resource type. The type must be defined in
  #     [Service.monitored_resources][google.api.Service.monitored_resources]
  #     section.
  # @!attribute [rw] metrics
  #   @return [::Array<::String>]
  #     Types of the metrics to report to this monitoring destination.
  #     Each type must be defined in
  #     [Service.metrics][google.api.Service.metrics] section.
  class MonitoringDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#producer_destinations ⇒ ::Array<::Google::Api::Monitoring::MonitoringDestination>

Returns Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.

Returns:

  • (::Array<::Google::Api::Monitoring::MonitoringDestination>) —

    Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used once in the Monitoring configuration.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/api/monitoring.rb', line 90

class Monitoring
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configuration of a specific monitoring destination (the producer project
  # or the consumer project).
  # @!attribute [rw] monitored_resource
  #   @return [::String]
  #     The monitored resource type. The type must be defined in
  #     [Service.monitored_resources][google.api.Service.monitored_resources]
  #     section.
  # @!attribute [rw] metrics
  #   @return [::Array<::String>]
  #     Types of the metrics to report to this monitoring destination.
  #     Each type must be defined in
  #     [Service.metrics][google.api.Service.metrics] section.
  class MonitoringDestination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end