api: create OpenRCA service proto file #6497

voidzcy · 2019-04-05T23:40:44Z

For an explanation of how to fill out the fields, please see the relevant section
in PULL_REQUESTS.md

Description: Created OpenRCA service proto file based on ORCA design
Risk Level: Low
Testing: None
Docs Changes: None
Release Notes: API: created service proto for Open Request Cost Aggregation
[Optional Fixes #Issue]
[Optional Deprecated:]

htuch

Thanks @voidzcy, I'm so excited to see ORCA finally making its way out to the world. I have some minor comments, the only major things to do are (1) decide where to put this in the Envoy API tree and (2) get the design doc published and GH issue opened so we can have others provide input into this. (1) we can discuss in this PR. For (2), I can own this.

api/envoy/service/load_stats/v2alpha/BUILD

api/envoy/service/load_stats/v2alpha/orca.proto

htuch · 2019-04-09T05:26:04Z

api/envoy/service/load_stats/v2alpha/orca.proto

+message LoadReportRequest {
+  // Interval for generating Open RCA core metric responses.
+  google.protobuf.Duration report_interval = 1;
+  // Request costs to collect. If this is empty, all known requests costs tracked by


Can you expand in this comment on how request cost names are specified? I think they probably should follow reverse DNS, e.g. com.acme.some_app.queue_length.

api/envoy/service/load_stats/v2alpha/orca.proto

htuch · 2019-04-09T05:28:10Z

api/envoy/service/load_stats/v2alpha/orca.proto

+
+import "validate/validate.proto";
+
+// Out-of-band (OOB) load reporting service for frontends to periodically get


We probably need a bunch more comments here. Let's discuss tomorrow on IM, but I think the first step is for me to create a public version of the design doc and share this as an Envoy issue, then we can crib from that.

voidzcy · 2019-04-09T18:12:30Z

@htuch Thanks for your help! I will fix the PR once we have an officially finalized design published. Look forward to seeing that!

htuch

#6614 is now filed, so let's continue the review. My main suggestion is to put this under udpa (universal data plane API), since that's the new location for things (starting in this PR ;) ) that are not Envoy specific. @mattklein123 do you concur?
/wait

api/envoy/data/orca/v1/BUILD

api/envoy/service/orca/v1/BUILD

api/envoy/data/orca/v1/orca_load_report.proto

api/envoy/service/orca/v1/orca.proto

mattklein123 · 2019-04-17T03:39:11Z

@mattklein123 do you concur?

Yes, +1. I will review once we move the files. Thank you.

htuch · 2019-04-17T17:33:58Z

api/udpa/data/orca/v1/orca_load_report.proto

+  // during the request.
+  double mem_utilization = 2 [(validate.rules).double.gte = 0, (validate.rules).double.lte = 1];
+
+  // Application specific requests costs. Values may be absolute costs (e.g.


Can you copy + paste the updated comment from the public ORCA doc here? I made some grammar changes.

htuch · 2019-04-17T17:35:27Z

api/udpa/service/orca/v1/orca.proto

+
+import "validate/validate.proto";
+
+// Out-of-band (OOB) load reporting service for the additional load reporting


Can you add a pointer and reference to the public design doc and relevant section?

htuch · 2019-04-17T17:35:33Z

api/udpa/data/orca/v1/orca_load_report.proto

+
+import "validate/validate.proto";
+
+message OrcaLoadReport {


Can you add a pointer and reference to the public design doc and relevant section?

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

tools/spelling_dictionary.txt

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

htuch

Thanks!

* master: (26 commits) docs: update docs to recommend /retest repokitteh command (envoyproxy#6655) http timeout integration test: wait for 15s for upstream reset (envoyproxy#6646) access log: add response code details to the access log formatter (envoyproxy#6626) build: add ppc build badge to README (envoyproxy#6629) Revert dispatcher stats (envoyproxy#6649) Batch implementation with timer (envoyproxy#6452) fault filter: reset token bucket on data start (envoyproxy#6627) event: update libevent dependency to fix race condition (envoyproxy#6637) examples: standardize docker-compose version and yaml extension (envoyproxy#6613) quiche: Implement SpdyUnsafeArena using SpdySimpleArena (envoyproxy#6612) router: support customizable retry back-off intervals (envoyproxy#6568) api: create OpenRCA service proto file (envoyproxy#6497) ext_authz: option for clearing route cache of authorized requests (envoyproxy#6503) build: update jinja to 2.10.1. (envoyproxy#6623) tools: check spelling in pre-push hook (envoyproxy#6631) security: blameless postmortem template. (envoyproxy#6553) Implementing Endpoint lease for ClusterLoadAssigment (envoyproxy#6477) add HTTP integration tests exercising timeouts (envoyproxy#6621) event: fix DispatcherImplTest::InitializeStats flake (envoyproxy#6619) Add tag extractor for RDS route config name (envoyproxy#6618) ... Signed-off-by: Michael Puncel <mpuncel@squareup.com>

voidzcy force-pushed the feature/create_orca_service_proto_file branch 2 times, most recently from 4e89193 to 581ea1f Compare April 7, 2019 23:56

htuch self-assigned this Apr 8, 2019

htuch suggested changes Apr 9, 2019

View reviewed changes

htuch added the waiting:any label Apr 9, 2019

repokitteh-read-only bot removed the waiting:any label Apr 9, 2019

htuch added the waiting:any label Apr 10, 2019

repokitteh-read-only bot removed the waiting:any label Apr 10, 2019

menghanl mentioned this pull request Apr 10, 2019

balancer: add server loads from RPC trailers to DoneInfo grpc/grpc-go#2641

Merged

htuch reviewed Apr 17, 2019

View reviewed changes

api/envoy/data/orca/v1/BUILD Outdated Show resolved Hide resolved

api/envoy/service/orca/v1/BUILD Outdated Show resolved Hide resolved

api/envoy/data/orca/v1/orca_load_report.proto Outdated Show resolved Hide resolved

api/envoy/service/orca/v1/orca.proto Outdated Show resolved Hide resolved

repokitteh-read-only bot added the waiting label Apr 17, 2019

mattklein123 self-assigned this Apr 17, 2019

voidzcy force-pushed the feature/create_orca_service_proto_file branch from c554cad to f51e2bd Compare April 17, 2019 05:15

repokitteh-read-only bot removed the waiting label Apr 17, 2019

voidzcy force-pushed the feature/create_orca_service_proto_file branch from f51e2bd to 7431bc3 Compare April 17, 2019 05:17

htuch reviewed Apr 17, 2019

View reviewed changes

voidzcy added 10 commits April 17, 2019 13:24

create orca.proto for open request cost aggregation service

9098d9e

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

add validation rules for resource utilization fields

d9bc222

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

add BUILD file

bf7c3b5

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

format with format tool

ac71382

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

fix envoy proto naming conventions

76b22cf

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

discard NIC metrics in load report message

e0984a0

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

reword the service comments

0c82663

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

split OrcaLoadReport message into seperate proto

3f59df8

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

moved ORCA protos into udpa directory

89617a1

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

fixed comment grammar and add reference to design doc

f71f81c

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

voidzcy force-pushed the feature/create_orca_service_proto_file branch 2 times, most recently from 8daf37f to c325921 Compare April 17, 2019 21:10

voidzcy force-pushed the feature/create_orca_service_proto_file branch from c325921 to bcd8516 Compare April 17, 2019 21:11

voidzcy commented Apr 17, 2019

View reviewed changes

tools/spelling_dictionary.txt Outdated Show resolved Hide resolved

add keywords to pass spellchecking

26c75a6

Signed-off-by: Chengyuan Zhang <chengyuanzhang@google.com>

voidzcy force-pushed the feature/create_orca_service_proto_file branch from bcd8516 to 26c75a6 Compare April 17, 2019 22:05

htuch approved these changes Apr 18, 2019

View reviewed changes

htuch merged commit 5cb2229 into envoyproxy:master Apr 18, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

api: create OpenRCA service proto file #6497

api: create OpenRCA service proto file #6497

voidzcy commented Apr 5, 2019

htuch left a comment

htuch Apr 9, 2019

htuch Apr 9, 2019

voidzcy commented Apr 9, 2019 •

edited

Loading

htuch left a comment

mattklein123 commented Apr 17, 2019

htuch Apr 17, 2019

voidzcy Apr 18, 2019

htuch Apr 17, 2019

voidzcy Apr 18, 2019

htuch Apr 17, 2019

voidzcy Apr 18, 2019

htuch left a comment


		import "validate/validate.proto";

		// Out-of-band (OOB) load reporting service for frontends to periodically get

api: create OpenRCA service proto file #6497

api: create OpenRCA service proto file #6497

Conversation

voidzcy commented Apr 5, 2019

htuch left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

voidzcy commented Apr 9, 2019 • edited Loading

htuch left a comment

Choose a reason for hiding this comment

mattklein123 commented Apr 17, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

htuch left a comment

Choose a reason for hiding this comment

voidzcy commented Apr 9, 2019 •

edited

Loading