Skip to content

Document proxy configuration for Java SDK #2100

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
navigation_title: Proxy issues
description: Troubleshooting guide for the EDOT Java SDK, covering proxy issues.
applies_to:
stack:
serverless:
observability:
product:
edot_java: ga
products:
- id: cloud-serverless
- id: observability
- id: edot-sdk
---

# Proxy issues with EDOT Java SDK

If your Java SDK sends telemetry but fails to communicate with the APM server, the issue might be due to missing or misconfigured proxy settings, which are required for outbound HTTP/S communication in some environments.

## Symptoms

These symptoms typically indicate that your Java SDK is experiencing a proxy issue:

* Telemetry data is not received in Elastic APM after instrumenting the app.
* Logs show errors like `Connection timed out`, `TLS handshake failure`, or other network-related issues when connecting to Elastic APM.

## Resolution

Set standard Java system properties to configure proxy settings.

Configure the following JVM system properties to enable outbound HTTP/HTTPS communication through a proxy:

```bash
java \
-Dhttp.proxyHost=proxy.example.com \
-Dhttp.proxyPort=8080 \
-Dhttps.proxyHost=proxy.example.com \
-Dhttps.proxyPort=8080 \

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did expect this to not work, because to my knowledge the exporters use OkHttp3, which I thought would not respect these properties. However, according to this issue it should work. Did we test this?

```

## Best practices
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about calling this "Testing" "Validation" or "Test your proxy"?


You can test end-to-end connectivity to validate proxy routing. To confirm that your application or collector can reach the endpoint through the proxy, use `curl` with the `--proxy` option:

```bash
curl --proxy http://proxy.example.com:8080 https://example.elastic.co
```

If the proxy is working, you'll get a valid response. If not, common errors include:

* `Connection timed out`
* `Could not resolve host`
* `Proxy CONNECT aborted`

## Resources

* [Java networking and proxies](https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html)
* [Java agent configuration - upstream documentation](https://opentelemetry.io/docs/zero-code/java/agent/configuration/)
2 changes: 2 additions & 0 deletions troubleshoot/ingest/opentelemetry/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ toc:
children:
- file: edot-sdks/dotnet/index.md
- file: edot-sdks/java/index.md
children:
- file: edot-sdks/java/proxy-issues.md
- file: edot-sdks/nodejs/index.md
- file: edot-sdks/php/index.md
- file: edot-sdks/python/index.md
Loading