108 lines
4.4 KiB
Protocol Buffer
108 lines
4.4 KiB
Protocol Buffer
// Copyright 2023 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
syntax = "proto3";
|
|
|
|
package google.api;
|
|
|
|
option go_package = "google.golang.org/genproto/googleapis/api/serviceconfig;serviceconfig";
|
|
option java_multiple_files = true;
|
|
option java_outer_classname = "MonitoringProto";
|
|
option java_package = "com.google.api";
|
|
option objc_class_prefix = "GAPI";
|
|
|
|
// 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
|
|
message Monitoring {
|
|
// Configuration of a specific monitoring destination (the producer project
|
|
// or the consumer project).
|
|
message MonitoringDestination {
|
|
// The monitored resource type. The type must be defined in
|
|
// [Service.monitored_resources][google.api.Service.monitored_resources]
|
|
// section.
|
|
string monitored_resource = 1;
|
|
|
|
// Types of the metrics to report to this monitoring destination.
|
|
// Each type must be defined in
|
|
// [Service.metrics][google.api.Service.metrics] section.
|
|
repeated string metrics = 2;
|
|
}
|
|
|
|
// 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.
|
|
repeated MonitoringDestination producer_destinations = 1;
|
|
|
|
// 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.
|
|
repeated MonitoringDestination consumer_destinations = 2;
|
|
}
|