Skip to content

api docs: improve wording of ext_proc ImmediateResponse.Details field#19813

Merged
ggreenway merged 1 commit intoenvoyproxy:mainfrom
chet:docs_ext_proc_details_field
Feb 4, 2022
Merged

api docs: improve wording of ext_proc ImmediateResponse.Details field#19813
ggreenway merged 1 commit intoenvoyproxy:mainfrom
chet:docs_ext_proc_details_field

Conversation

@chet
Copy link
Copy Markdown
Contributor

@chet chet commented Feb 4, 2022

Signed-off-by: Chet Nichols III chet@apple.com

Commit Message: api docs: improve wording of ext_proc ImmediateResponse.Details field

Addition Details: I had been trying to figure out a good way to provide more internally-derived feedback from an ext_proc implementation to envoy (without needing to do things like set response headers or rely on a separate log file), and was led to the discovery that the ImmediateResponse.Details field actually populates %RESPONSE_CODE_DETAILS% for use in access logging.

Due to how much better this discovery made my life, I am hoping it will make other people's lives better as well.

Risk Level: Low
Testing: Leveraged existing unit tests
Docs Changes: Yes
Release Notes: None
Platform Specific Features: None

@repokitteh-read-only
Copy link
Copy Markdown

Hi @chet, welcome and thank you for your contribution.

We will try to review your Pull Request as quickly as possible.

In the meantime, please take a look at the contribution guidelines if you have not done so already.

🐱

Caused by: #19813 was opened by chet.

see: more, trace.

@repokitteh-read-only
Copy link
Copy Markdown

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to (api/envoy/|docs/root/api-docs/).
envoyproxy/api-shepherds assignee is @lizan
CC @envoyproxy/api-watchers: FYI only for changes made to (api/envoy/|docs/root/api-docs/).

🐱

Caused by: #19813 was opened by chet.

see: more, trace.

Signed-off-by: Chet Nichols III <chet@apple.com>

Commit Message: api docs: improve wording of ext_proc ImmediateResponse.Details field

Addition Details: I had been trying to figure out a good way to provide more internally-derived feedback from an *ext_proc* implementation to *envoy* (without needing to do things like set response headers or rely on a separate log file), and was led to the discovery that the `ImmediateResponse.Details` field actually populates `%RESPONSE_CODE_DETAILS%` for use in access logging.

Due to how much better this discovery made my life, I am hoping it will make other people's lives better as well.

Risk Level: Low
Testing: Leveraged existing unit tests
Docs Changes: Yes
Release Notes: None
Platform Specific Features: None

Signed-off-by: Chet Nichols III <chet@apple.com>
@chet chet force-pushed the docs_ext_proc_details_field branch from 51da0d8 to 3d49fa8 Compare February 4, 2022 02:01
@repokitteh-read-only repokitteh-read-only bot removed the api label Feb 4, 2022
@ggreenway ggreenway merged commit e00aa66 into envoyproxy:main Feb 4, 2022
joshperry pushed a commit to joshperry/envoy that referenced this pull request Feb 13, 2022
…envoyproxy#19813)

I had been trying to figure out a good way to provide more internally-derived feedback from an *ext_proc* implementation to *envoy* (without needing to do things like set response headers or rely on a separate log file), and was led to the discovery that the `ImmediateResponse.Details` field actually populates `%RESPONSE_CODE_DETAILS%` for use in access logging.

Due to how much better this discovery made my life, I am hoping it will make other people's lives better as well.

Signed-off-by: Chet Nichols III <chet@apple.com>
Signed-off-by: Josh Perry <josh.perry@mx.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants