Add Client Status Discovery Service (CSDS) API definition by fuqianggao · Pull Request #9383 · envoyproxy/envoy

fuqianggao · 2019-12-17T18:19:10Z

Add Client Status Discovery Service (CSDS) API definition. This can be used by debug tools to obtain config information for specific clients from control plane.

Risk Level: Low
Testing: N/A
Docs Changes: N/A
Release Notes: N/A

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

repokitteh-read-only · 2019-12-17T18:19:15Z

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to api/.

🐱

Caused by: #9383 was opened by fuqianggao.

see: more, trace.

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

jmarantz · 2019-12-18T03:17:10Z

@fuqianggao can you look at CI?

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

fuqianggao · 2019-12-18T21:15:53Z

CI is passing. htuch@ PTAL.

mattklein123 · 2019-12-19T17:06:11Z

@fuqianggao thanks for this. This is interesting. To help with review, can you provide some more high level context on rationale, etc.? Thank you.

/wait-any

fuqianggao · 2019-12-19T18:11:32Z

@mattklein123 The purpose of this API is to provide a way for control plane to expose its view on the status of clients connected to it. For example, in a service mesh with many Envoys, a standalone debug tool can connect to control plane and stream CSDS, to know which Envoys are actually connected to the control plane and what configs they are getting. This will be very helpful for debugging purpose. Istio has a similar command line tool: https://istio.io/docs/ops/diagnostic-tools/proxy-cmd/, I imagine they can possibly use CSDS. Besides configs, it's also possible to include other stats in CSDS, but there are other means to expose those (e.g. stackdriver).

mattklein123 · 2019-12-19T19:49:00Z

@fuqianggao agreed this is a very useful thing to add, thanks for the context. I'm tagging a bunch of people at Lyft who will be interested in this as we are looking at building out some behavior along these lines in a management tool.

cc @danielhochman @ryancox @sindhura

htuch

@mattklein123 FWIW, I've already done some internal design discussion with @fuqianggao on this, definitely valuable to see what other orgs and potential users think.

api/envoy/service/discovery/v2/csds.proto

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

mattklein123

Cool stuff. Generally LGTM w/ one question.

api/envoy/service/discovery/v2/csds.proto

stale · 2019-12-30T03:29:09Z

This pull request has been automatically marked as stale because it has not had activity in the last 7 days. It will be closed in 7 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions!

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

fuqianggao · 2020-01-18T01:03:22Z

@htuch @mattklein123 Made a minor change: make MetadataMatcher inside NodeMatcher repeated to enable match on multiple metadata fields. PTAL again. Thanks!

htuch · 2020-01-20T23:28:02Z

api/envoy/type/matcher/v3/node.proto

+  StringMatcher node_id = 1;
+
+  // Specifies match criteria on the node metadata.
+  repeated MetadataMatcher node_metadatas = 2;


Is this AND semantics? Might it be the case that someone one day wants OR?

Yes, this is intended to be AND. If OR is needed, one can have repeated NodeMatcher, and only include either node_id or node_metadatas in them.

Can you clarify this in the docs per my other comment both here and there?

Done. Thank you.

htuch · 2020-01-20T23:28:32Z

api/envoy/service/status/v3/csds.proto

+      "envoy.service.status.v2.ClientStatusRequest";
+
+  // Management server can use these match criteria to identify clients.
+  repeated type.matcher.v3.NodeMatcher node_matchers = 1;


Do we need multiple of these if NodeMatcher is sufficiently expressive?

I don't see how we could achieve requesting client status for multiple unique node ids with only a single NodeMatcher. For example, if I want to request client status for "client-abc", and "client-123", it's hard to come up with a match that will only select this two.

So this is an OR match, right? Can you clarify this in the docs?

mattklein123

LGTM other than remaining doc comments. Please merge master as you will need to add another protodoc-title I think. Thank you.

/wait

mattklein123 · 2020-01-21T16:48:18Z

api/envoy/service/status/v3/csds.proto

+      "envoy.service.status.v2.ClientStatusRequest";
+
+  // Management server can use these match criteria to identify clients.
+  repeated type.matcher.v3.NodeMatcher node_matchers = 1;


So this is an OR match, right? Can you clarify this in the docs?

mattklein123 · 2020-01-21T16:48:37Z

api/envoy/type/matcher/v3/node.proto

+  StringMatcher node_id = 1;
+
+  // Specifies match criteria on the node metadata.
+  repeated MetadataMatcher node_metadatas = 2;


Can you clarify this in the docs per my other comment both here and there?

mattklein123 · 2020-01-21T16:49:10Z

api/envoy/type/matcher/node.proto

+option java_outer_classname = "NodeProto";
+option java_multiple_files = true;
+
+// [#protodoc-title:NodeMatcher]


nit: "// [#protodoc-title: Node matcher]"

I see that other files still have the original format, e.g.: https://github.com/envoyproxy/envoy/blob/master/api/envoy/type/matcher/v3/metadata.proto#L15

Do you mind fixing the other one(s)? It's a doc nit but generally we try for human readable docs.

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

mattklein123

LGTM other than small doc nit, thanks.

/wait

mattklein123 · 2020-01-21T21:55:10Z

api/envoy/type/matcher/node.proto

+option java_outer_classname = "NodeProto";
+option java_multiple_files = true;
+
+// [#protodoc-title:NodeMatcher]


Do you mind fixing the other one(s)? It's a doc nit but generally we try for human readable docs.

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

fuqianggao · 2020-01-21T22:23:24Z

LGTM other than small doc nit, thanks.

/wait

Done. Thanks for your review!

mattklein123

Thank you!

htuch

Thanks!

Since envoyproxy#9383 merged, I've been unable to bazel build @envoy_api//... Upsteam fix at protocolbuffers/protobuf#7135 Adding as a patch to avoid having to bump protobuf version when that merges just for this. Risk level: Low Testing: bazel build @envoy_api//... Signed-off-by: Harvey Tuch <htuch@google.com>

Since #9383 merged, I've been unable to bazel build @envoy_api//... Upstream fix at protocolbuffers/protobuf#7135 Adding as a patch to avoid having to bump protobuf version when that merges just for this. Risk level: Low Testing: bazel build @envoy_api//... Signed-off-by: Harvey Tuch <htuch@google.com>

fuqianggao added 2 commits December 16, 2019 16:55

Add proto definition for CSDS.

2691086

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Add CSDS to spelling_dictionary.txt.

825a020

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

repokitteh-read-only bot added the api label Dec 17, 2019

fuqianggao added 3 commits December 17, 2019 10:26

Fix typos.

ddb16d5

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Fix csds.proto.

91dfab2

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Add more comments.

1b264a1

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

jmarantz assigned htuch Dec 18, 2019

fuqianggao added 3 commits December 18, 2019 12:00

Fix BUILD file.

1df6184

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Re-format csds.proto.

ba5a647

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Add auto-generated v3alpha version of CSDS.

c66b01b

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

mattklein123 self-assigned this Dec 19, 2019

repokitteh-read-only bot added the waiting:any label Dec 19, 2019

repokitteh-read-only bot removed the waiting:any label Dec 19, 2019

htuch reviewed Dec 19, 2019

View reviewed changes

api/envoy/service/discovery/v2/csds.proto Show resolved Hide resolved

api/envoy/service/discovery/v2/csds.proto Show resolved Hide resolved

Add more comments in csds.proto.

0917d31

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

mattklein123 reviewed Dec 20, 2019

View reviewed changes

api/envoy/service/discovery/v2/csds.proto Outdated Show resolved Hide resolved

stale bot added the stale stalebot believes this issue/PR has not been touched recently label Dec 30, 2019

fuqianggao added 3 commits January 2, 2020 12:08

Update comment about CSDS.

902e1cd

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Fix typo.

8fb1ad7

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Update v3 version of csds.

1c23e84

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

stale bot removed the stale stalebot believes this issue/PR has not been touched recently label Jan 2, 2020

fuqianggao requested review from htuch and mattklein123 January 2, 2020 21:08

fuqianggao requested a review from mattklein123 January 18, 2020 01:03

htuch reviewed Jan 20, 2020

View reviewed changes

fuqianggao requested a review from htuch January 21, 2020 01:26

mattklein123 requested changes Jan 21, 2020

View reviewed changes

repokitteh-read-only bot added the waiting label Jan 21, 2020

fuqianggao added 2 commits January 21, 2020 10:23

Merge remote-tracking branch 'upstream/master'

8cef120

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Address comments.

a6a8bde

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

repokitteh-read-only bot removed the waiting label Jan 21, 2020

fuqianggao added 4 commits January 21, 2020 10:58

Fix build file.

12eb167

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Add status to v3 doc.

836b2e2

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Add protodoc-title in csds.proto.

e6f6716

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Add node.proto to api-v3 doc tree.

540a0e5

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

fuqianggao requested a review from mattklein123 January 21, 2020 20:10

mattklein123 requested changes Jan 21, 2020

View reviewed changes

repokitteh-read-only bot added the waiting label Jan 21, 2020

fuqianggao added 2 commits January 21, 2020 14:16

Fix protodoc-title for all the proto under type/matcher

b405e1c

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

Updated generated api.

d5528f1

Signed-off-by: Fuqiang Gao <fuqianggao@google.com>

repokitteh-read-only bot removed the waiting label Jan 21, 2020

mattklein123 approved these changes Jan 21, 2020

View reviewed changes

repokitteh-read-only bot removed the api label Jan 21, 2020

htuch approved these changes Jan 22, 2020

View reviewed changes

htuch merged commit 10f756e into envoyproxy:master Jan 22, 2020

htuch mentioned this pull request Jan 24, 2020

build: patch protobuf to deal with too long CLI issues. #9824

Merged

Conversation

fuqianggao commented Dec 17, 2019

Uh oh!

repokitteh-read-only bot commented Dec 17, 2019

Uh oh!

jmarantz commented Dec 18, 2019

Uh oh!

fuqianggao commented Dec 18, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mattklein123 commented Dec 19, 2019

Uh oh!

fuqianggao commented Dec 19, 2019

Uh oh!

mattklein123 commented Dec 19, 2019

Uh oh!

htuch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mattklein123 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stale bot commented Dec 30, 2019

Uh oh!

fuqianggao commented Jan 18, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mattklein123 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mattklein123 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fuqianggao commented Jan 21, 2020

Uh oh!

mattklein123 left a comment

Choose a reason for hiding this comment

Uh oh!

htuch left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

fuqianggao commented Dec 18, 2019 •

edited

Loading

fuqianggao commented Jan 18, 2020 •

edited

Loading