-
Notifications
You must be signed in to change notification settings - Fork 35
Add proxy config guide for EDOT #354
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
bbd491c
Add proxy setting guide for EDOT
alexandra5000 4d065fb
Update cross-repo link
alexandra5000 7ab501e
Update the Collector proxy guide and create a new SDK proxy guide
alexandra5000 5be58db
Merge remote-tracking branch 'upstream/main' into proxy
alexandra5000 e593417
Add page to toc
alexandra5000 9abbe13
Merge remote-tracking branch 'upstream/main' into proxy
alexandra5000 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
--- | ||
navigation_title: Proxy settings | ||
description: Configuration of the EDOT Collector's proxy settings. | ||
applies_to: | ||
stack: | ||
serverless: | ||
observability: | ||
product: | ||
edot_collector: ga | ||
products: | ||
- id: cloud-serverless | ||
- id: observability | ||
- id: edot-collector | ||
--- | ||
|
||
# Configure proxy settings for EDOT components | ||
|
||
When running Elastic Distributions of OpenTelemetry (EDOT) in environments that require outbound traffic to go through a proxy, you must explicitly configure proxy settings. | ||
|
||
You may need to configure a proxy if: | ||
|
||
- Your app is deployed behind a corporate proxy or firewall. | ||
- Your telemetry is sent to Elastic APM in Elastic Cloud or another hosted destination. | ||
- Network errors such as `Connection timed out` or `SSL handshake failed` appear in logs. | ||
|
||
## Available proxy variables | ||
|
||
| Variable | Description | | ||
|--------------|---------------------------------------------| | ||
| HTTP_PROXY | URL of the proxy server for HTTP requests | | ||
| HTTPS_PROXY | URL of the proxy server for HTTPS requests | | ||
| NO_PROXY | Comma-separated list of hosts to exclude | | ||
|
||
## Configure proxy settings for the EDOT Collector | ||
|
||
Most EDOT components honor common proxy environment variables. The following examples show how to configure them: | ||
|
||
::::{tab-set} | ||
|
||
:::{tab-item} Docker run | ||
```bash | ||
docker run -e HTTP_PROXY=http://<proxy.address>:<port> \ | ||
-e HTTPS_PROXY=http://<proxy.address>:<port> \ | ||
otel/opentelemetry-collector:latest | ||
``` | ||
::: | ||
|
||
:::{tab-item} Docker compose | ||
```yaml | ||
services: | ||
edotcollector: | ||
environment: | ||
- HTTP_PROXY=http://<proxy.address>:<port> | ||
- HTTPS_PROXY=http://<proxy.address>:<port> | ||
``` | ||
::: | ||
|
||
:::{tab-item} Kubernetes pod manifest | ||
```yaml | ||
env: | ||
- name: HTTP_PROXY | ||
value: '<proxy.address>:<port>' | ||
- name: HTTPS_PROXY | ||
value: '<proxy.address>:<port>' | ||
``` | ||
::: | ||
|
||
:::{tab-item} systemmd [Service] unit file | ||
``` | ||
[Service] | ||
Environment="HTTP_PROXY=http://<proxy.address>:<port>" | ||
Environment="HTTPS_PROXY=http://<proxy.address>:<port>" | ||
Environment="NO_PROXY=<address1>,<address2>" | ||
``` | ||
::: | ||
|
||
:::: | ||
|
||
:::{{note}} | ||
For the Collector, proxy support applies to all exporters, including those using gRPC. No special configuration is needed beyond the environment variables. | ||
::: | ||
|
||
## Proxy settings for EDOT SDKs | ||
|
||
With the exception of Java SDK, EDOT SDKs use the `HTTP_PROXY / HTTPS_PROXY` settings from environment variables and require no extra configuration. | ||
theletterf marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
You can export environment variables like this: | ||
|
||
``` | ||
export HTTP_PROXY=http://<proxy.address>:<port> | ||
export HTTPS_PROXY=http://<proxy.address>:<port> | ||
``` | ||
|
||
### Java SDK | ||
|
||
If you’re using Java SDK, you must configure Java system properties using the Java Virtual Machine (JVM). Refer to [Troubleshooting Java SDK proxy issues](docs-content://troubleshoot/ingest/opentelemetry/edot-sdks/java/proxy-issues.md) for more information. | ||
Check failure on line 96 in docs/reference/edot-collector/config/proxy.md
|
||
|
||
## Resources | ||
|
||
[Proxy support - upstream documentation](https://opentelemetry.io/docs/collector/configuration/#proxy-support) |
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.