1/*
2 * Copyright 2019 gRPC authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17syntax = "proto3";
18
19package orca.v1;
20
21import "google/protobuf/duration.proto";
22
23message LoadReport {
24  // CPU utilization expressed as a fraction of available CPU resources. This
25  // should be derived from a sample or measurement taken during the request.
26  double cpu_utilization = 1;
27
28  // Memory utilization expressed as a fraction of available memory
29  // resources. This should be derived from a sample or measurement taken
30  // during the request.
31  double mem_utilization = 2;
32
33  // NIC inbound/outbound utilization expressed as a fraction of available NIC
34  // bandwidth. The request in/out bytes can be inferred by Envoy, but not the
35  // NIC availability at the endpoint, hence reporting
36  double nic_in_utilization = 3;
37  double nic_out_utilization = 4;
38
39  // Application specific requests costs. Values may be absolute costs (e.g.
40  // 3487 bytes of storage) associated with the cost or utilization,
41  // expressed as a fraction of total resources available. Utilization
42  // metrics should be derived from a sample or measurement taken
43  // during the request.
44  map<string, double> request_cost_or_utilization = 5;
45}
46
47message LoadReportRequest {
48  // Interval for generating Open RCA core metric responses.
49  google.protobuf.Duration report_interval = 1;
50  // Request costs to collect. If this is empty, all known requests costs tracked by
51  // the load reporting agent will be returned. This provides an opportunity for
52  // the client to selectively obtain a subset of tracked costs.
53  repeated string request_cost_names = 2;
54}
55
56service OpenRCAService {
57  rpc StreamCoreMetrics(LoadReportRequest) returns (stream LoadReport) {
58  }
59}
60
61