Add docs for HTTPRoute timeouts + retries + route metrics #1814

adleong · 2024-08-05T23:52:58Z

No description provided.

Signed-off-by: Alex Leong <[email protected]>

kflynn

Overall I think this is really good! I've suggested some edits, but they're pretty minor things, really.

I wholeheartedly agree that not having Viz makes this kind of documentation much tougher, but I think you've done about as well as could be done there. Thanks!!

kflynn · 2024-08-06T00:32:03Z

linkerd.io/content/2.16/features/retries-and-timeouts.md

-release. Creating these policy resources will cause the Linkerd proxy to perform
-the appropriate retries or timeouts when calling that service. Retries and
-timeouts are always performed on the *outbound* (client) side.
+Timeouts and retries can be configured using [HTTPRoute], GrpcRoute, or Service


Suggested change

Timeouts and retries can be configured using [HTTPRoute], GrpcRoute, or Service

Timeouts and retries can be configured using [HTTPRoute], GRPCRoute, or Service

We should be consistent with the name of the resource, I think.

kflynn · 2024-08-06T14:45:59Z

linkerd.io/content/2.16/features/retries-and-timeouts.md

-implemented incorrectly retries can amplify small errors into system wide
-outages. For that reason, we made sure they were implemented in a way that would
-increase the reliability of the system while limiting the risk.
+has for gracefully handling partial or transient application failures.


Maybe include timeouts in here, too? "Timeouts and automatic retries are two of the most powerful and useful mechanisms..." ?

linkerd.io/content/2.16/features/retries-and-timeouts.md

kflynn · 2024-08-06T14:54:37Z

linkerd.io/content/2.16/reference/retries.md

+
+Retries are a client-side behavior, and are therefore performed by the
+outbound side of the Linkerd proxy.[^1] If retries are configured on an
+HttpRoute or GrpcRoute with multiple backends, each retry of a request can


Suggested change

HttpRoute or GrpcRoute with multiple backends, each retry of a request can

HTTPRoute or GRPCRoute with multiple backends, each retry of a request can

Should those be links?

kflynn · 2024-08-06T15:39:58Z

linkerd.io/content/2.16/tasks/getting-per-route-metrics.md

+To get per-route metrics, you must create [HTTPRoute] resources. If a route has
+a `parent_ref` which points to a Service resource, Linkerd will generate
+outbound per-route traffic metrics for all HTTP traffic that it sends to that
+Service. If a route has a `parent_ref` which points to a Server resource,


Suggested change

Service. If a route has a `parent_ref` which points to a Server resource,

Service. If a route has a `parent_ref` which points to a **Server** resource,

kflynn · 2024-08-06T15:42:32Z

linkerd.io/content/2.16/tasks/getting-per-route-metrics.md

+To get per-route metrics, you must create [HTTPRoute] resources. If a route has
+a `parent_ref` which points to a Service resource, Linkerd will generate
+outbound per-route traffic metrics for all HTTP traffic that it sends to that
+Service. If a route has a `parent_ref` which points to a Server resource,


This confuses me. 😂 Suppose I have meshed workloads foo and bar, and I have an HTTPRoute with a parent_ref of foo's Service. If bar sends a request to foo... I'm only going to get outbound metrics, unless I also have a parent_ref on my HTTPRoute that points to a Server for foo?

That's correct

Thanks for confirming! I think I'm gonna have to play with this a bit. 🙂

kflynn · 2024-08-06T15:43:39Z

linkerd.io/content/2.16/tasks/books.md

-out the profile that is generated:
+We know that the webapp component is getting 500s from the books component, but
+it would be great to narrow this down further and get per route metrics. To do
+this, we leverage the Gateway API and define a set of HTTPRoute resources, each


Suggested change

this, we leverage the Gateway API and define a set of HTTPRoute resources, each

this, we take advantage of the Gateway API and define a set of HTTPRoute resources, each

Pet peeve. 😂

kflynn · 2024-08-06T15:43:59Z

linkerd.io/content/2.16/tasks/books.md

-For this demo, the method is appended to the route regex.
-
-To get profiles for `authors` and `books`, you can run:
+We can then check that these HTTPRoute have been accepted by their parent


Suggested change

We can then check that these HTTPRoute have been accepted by their parent

We can then check that these HTTPRoutes have been accepted by their parent

kflynn · 2024-08-06T15:47:02Z

linkerd.io/content/2.16/tasks/books.md

+This tells us that Linkerd make a total of 469 retry requests and 247 of those
+were successful and the other 222 were not and hit the default retry limit of
+`1`. We can improve this further by increasing this limit to allow more than


Suggested change

This tells us that Linkerd make a total of 469 retry requests and 247 of those

were successful and the other 222 were not and hit the default retry limit of

`1`. We can improve this further by increasing this limit to allow more than

This tells us that Linkerd make a total of 469 retry requests, of which 247 were

successful. The remaining 222 failed and could not be retried again, since we didn't

raise the retry limit from its default of 1.

We can improve this further by increasing this limit to allow more than

Signed-off-by: Alex Leong <[email protected]>

kflynn

Ship it! 🙂

* update 2.16 retries + timeouts + route metrics docs Signed-off-by: Alex Leong <[email protected]> Co-authored-by: Flynn <[email protected]>

adleong added 2 commits August 5, 2024 22:30

update 2.16 retries + timeouts + route metrics docs

89c6176

Signed-off-by: Alex Leong <[email protected]>

fix lints and checks

024bfbb

Signed-off-by: Alex Leong <[email protected]>

kflynn requested changes Aug 6, 2024

View reviewed changes

adleong and others added 2 commits August 6, 2024 19:55

feedback

dcdcd82

Signed-off-by: Alex Leong <[email protected]>

HttpRotue -> HTTPRoute, GrpcRoute -> GRPCRoute

8d2dd82

kflynn approved these changes Aug 6, 2024

View reviewed changes

adleong merged commit 36d62ab into alpeb/2.16 Aug 7, 2024
3 checks passed

adleong deleted the alex/retries-timeouts branch August 7, 2024 17:39

alpeb pushed a commit that referenced this pull request Aug 13, 2024

Add docs for HTTPRoute timeouts + retries + route metrics (#1814)

8254d95

* update 2.16 retries + timeouts + route metrics docs Signed-off-by: Alex Leong <[email protected]> Co-authored-by: Flynn <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docs for HTTPRoute timeouts + retries + route metrics #1814

Add docs for HTTPRoute timeouts + retries + route metrics #1814

adleong commented Aug 5, 2024

kflynn left a comment

kflynn Aug 6, 2024

kflynn Aug 6, 2024

kflynn Aug 6, 2024

kflynn Aug 6, 2024

kflynn Aug 6, 2024

adleong Aug 6, 2024

kflynn Aug 6, 2024 •

edited

Loading

kflynn Aug 6, 2024

kflynn Aug 6, 2024

kflynn Aug 6, 2024

kflynn left a comment

	Timeouts and retries can be configured using [HTTPRoute], GrpcRoute, or Service
	Timeouts and retries can be configured using [HTTPRoute], GRPCRoute, or Service

	HttpRoute or GrpcRoute with multiple backends, each retry of a request can
	HTTPRoute or GRPCRoute with multiple backends, each retry of a request can

	Service. If a route has a `parent_ref` which points to a Server resource,
	Service. If a route has a `parent_ref` which points to a Server resource,

	this, we leverage the Gateway API and define a set of HTTPRoute resources, each
	this, we take advantage of the Gateway API and define a set of HTTPRoute resources, each

	We can then check that these HTTPRoute have been accepted by their parent
	We can then check that these HTTPRoutes have been accepted by their parent

Add docs for HTTPRoute timeouts + retries + route metrics #1814

Add docs for HTTPRoute timeouts + retries + route metrics #1814

Conversation

adleong commented Aug 5, 2024

kflynn left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kflynn Aug 6, 2024 • edited Loading

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

kflynn left a comment

Choose a reason for hiding this comment

kflynn Aug 6, 2024 •

edited

Loading