Reference documentation and code samples for the Google API Common Protos Client class Monitoring.
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. Thelibrary.googleapis.com/book/returned_countmetric is sent
to both producer and consumer projects, whereas thelibrary.googleapis.com/book/num_overduemetric 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:
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.
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.
getProducerDestinations
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google API Common Protos Client - Class Monitoring (4.12.3)\n\nVersion latestkeyboard_arrow_down\n\n- [4.12.3 (latest)](/php/docs/reference/common-protos/latest/Api.Monitoring)\n- [4.12.2](/php/docs/reference/common-protos/4.12.2/Api.Monitoring)\n- [4.11.0](/php/docs/reference/common-protos/4.11.0/Api.Monitoring)\n- [4.10.0](/php/docs/reference/common-protos/4.10.0/Api.Monitoring)\n- [4.9.0](/php/docs/reference/common-protos/4.9.0/Api.Monitoring)\n- [4.8.3](/php/docs/reference/common-protos/4.8.3/Api.Monitoring) \nReference documentation and code samples for the Google API Common Protos Client class Monitoring.\n\nMonitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/num_overdue` metric is only sent to the\nconsumer project.\nmonitored_resources:\n\n- type: library.googleapis.com/Branch display_name: \"Library Branch\" description: \"A branch of a library.\" launch_stage: GA labels:\n - key: resource_container description: \"The Cloud container (ie. project id) for the Branch.\"\n - key: location description: \"The location of the library branch.\"\n - key: branch_id description: \"The id of the branch.\" metrics:\n- 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:\n - key: customer_id description: \"The id of the customer.\"\n- 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:\n - key: customer_id description: \"The id of the customer.\" monitoring: producer_destinations:\n - monitored_resource: library.googleapis.com/Branch metrics:\n - library.googleapis.com/book/returned_count consumer_destinations:\n - monitored_resource: library.googleapis.com/Branch metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/num_overdue\n\nGenerated from protobuf message `google.api.Monitoring`\n\nNamespace\n---------\n\nGoogle \\\\ Api\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getProducerDestinations\n\nMonitoring configurations for sending metrics to the producer project.\n\nThere can be multiple producer destinations. A monitored resource type may\nappear in multiple monitoring destinations if different aggregations are\nneeded for different sets of metrics associated with that monitored\nresource type. A monitored resource and metric pair may only be used once\nin the Monitoring configuration.\n\n### setProducerDestinations\n\nMonitoring configurations for sending metrics to the producer project.\n\nThere can be multiple producer destinations. A monitored resource type may\nappear in multiple monitoring destinations if different aggregations are\nneeded for different sets of metrics associated with that monitored\nresource type. A monitored resource and metric pair may only be used once\nin the Monitoring configuration.\n\n### getConsumerDestinations\n\nMonitoring configurations for sending metrics to the consumer project.\n\nThere can be multiple consumer destinations. A monitored resource type may\nappear in multiple monitoring destinations if different aggregations are\nneeded for different sets of metrics associated with that monitored\nresource type. A monitored resource and metric pair may only be used once\nin the Monitoring configuration.\n\n### setConsumerDestinations\n\nMonitoring configurations for sending metrics to the consumer project.\n\nThere can be multiple consumer destinations. A monitored resource type may\nappear in multiple monitoring destinations if different aggregations are\nneeded for different sets of metrics associated with that monitored\nresource type. A monitored resource and metric pair may only be used once\nin the Monitoring configuration."]]