Support routing data through an HTTP proxy #11891
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Support routing data through an HTTP proxy This adds the ability for the HttpClient to connect through an HTTP proxy. We augment the channel factory to check if it is supposed to be proxied and, if so, we connect to the proxy host first, issue a CONNECT command through to the final recipient host and *then* give the channel to the normal http client for usage.
techdocsmith
reviewed
Nov 8, 2021
docs/development/modules.md
Outdated
Comment on lines
361
to
363
| It is possible to adds the ability for the HttpClient of your extension to connect through a HTTP proxy. | ||
| Internally, Druid will augment the channel factory to check if it is supposed to be proxied and, if so, connect to the proxy host first, | ||
| issue a CONNECT command through to the final recipient host and then give the channel to the normal http client for usage. |
There was a problem hiding this comment.
Suggested change
| It is possible to adds the ability for the HttpClient of your extension to connect through a HTTP proxy. | |
| Internally, Druid will augment the channel factory to check if it is supposed to be proxied and, if so, connect to the proxy host first, | |
| issue a CONNECT command through to the final recipient host and then give the channel to the normal http client for usage. | |
| You can add the ability for the `HttpClient` of your extension to connect through an HTTP proxy. | |
| Internally, Druid augments the channel factory to check if it should proxy connections. If so the client connects to the proxy host first to issue a subsequent `CONNECT` command through to the final recipient host. After the connection is established, the channel passes back to the original HTTP client for usage. |
I'm not sure what "normal" means in the connection here. It seems like the way that Druid handles it by passing the channel back and forth may be an implementation detail. I am wondering if I am enabling proxying why I need to know that?
There was a problem hiding this comment.
Reworded as suggestion and removed implementation details
docs/development/modules.md
Outdated
Comment on lines
365
to
367
| To enable this feature and allow for proxy in your extension's HTTP client, | ||
| first, add `HttpClientProxyConfig` as a `@JsonProperty` to the HTTP config class of your extension. | ||
| Next, in the extension's module class, add `HttpProxyConfig` to `HttpClientConfig`. For example, |
There was a problem hiding this comment.
Suggested change
| To enable this feature and allow for proxy in your extension's HTTP client, | |
| first, add `HttpClientProxyConfig` as a `@JsonProperty` to the HTTP config class of your extension. | |
| Next, in the extension's module class, add `HttpProxyConfig` to `HttpClientConfig`. For example, | |
| To enable proxy connection for your extension's HTTP client: | |
| 1. Add `HttpClientProxyConfig` as a `@JsonProperty` to the HTTP config class of your extension. | |
| 2. In the extension's module class, add `HttpProxyConfig` to `HttpClientConfig`. For example, where `HttpClientConfig` is the HTTP config class for your extension: |
(Not sure if I interpreted this correctly, but include the information from the note on line 375 in the for example statement here)
docs/development/modules.md
Outdated
| .withReadTimeout(config.getReadTimeout().toStandardDuration()) | ||
| .withHttpProxyConfig(config.getProxyConfig()); | ||
| ``` | ||
| (note that the `config` variable in the example above is the HTTP config class of your extension) |
There was a problem hiding this comment.
Suggested change
| (note that the `config` variable in the example above is the HTTP config class of your extension) |
cheddar
approved these changes
Nov 8, 2021
clintropolis
approved these changes
Nov 8, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Support routing data through a HTTP proxy
Description
This adds the ability for the HttpClient to connect through a HTTP proxy. We
augment the channel factory to check if it is supposed to be proxied and, if so,
we connect to the proxy host first, issue a CONNECT command through to the final
recipient host and then give the channel to the normal http client for usage.
Note that this is most useful for any extension (within Druid) that is using Druid's HttpClient and needs to make requests to endpoints outside of the Druid network where proxy is required.
This PR has: