-
Notifications
You must be signed in to change notification settings - Fork 159
Add troubleshooting guide for OTel connectivity issues #3030
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
alexandra5000
merged 8 commits into
elastic:main
from
alexandra5000:network-connectivity
Oct 14, 2025
Merged
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
35cdf58
Add connectivity issues
alexandra5000 4b3885e
Apply peer comments
alexandra5000 aca7a32
Merge remote-tracking branch 'upstream/main' into network-connectivity
alexandra5000 558d74b
update yaml
alexandra5000 82d3ddb
Apply SME comments
alexandra5000 2e6825a
Add placeholders + minor changes
alexandra5000 13e9210
Add firewall to line 57
alexandra5000 f15a1d8
Merge branch 'main' into network-connectivity
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,159 @@ | ||
--- | ||
navigation_title: Connectivity issues | ||
description: Troubleshoot connectivity issues between EDOT SDKs, the EDOT Collector, and Elastic. | ||
applies_to: | ||
serverless: all | ||
product: | ||
edot_collector: ga | ||
products: | ||
- id: observability | ||
- id: edot-collector | ||
- id: edot-sdk | ||
--- | ||
|
||
# Connectivity issues with EDOT | ||
|
||
Connectivity problems occur when the EDOT SDKs or the EDOT Collector can't reach Elastic. Even with correct proxy settings, network restrictions such as blocked ports or firewalls can prevent data from flowing. | ||
|
||
|
||
## Symptoms | ||
|
||
You might see one or more of the following error messages: | ||
|
||
- `connection refused` | ||
- `network unreachable` | ||
- `i/o timeout` | ||
- `tls: handshake failure` | ||
|
||
These errors might appear either in application logs (from the SDK) or in the Collector logs. | ||
hegerchr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Example (Collector): | ||
|
||
```text | ||
2024-09-15T12:44:30Z error exporterhelper/queued_retry.go:149 Exporting failed. Rejecting data. Error: context deadline exceeded | ||
``` | ||
|
||
Example (Python SDK): | ||
|
||
```text | ||
opentelemetry.sdk ERROR OTLPSpanExporter - Failed to export spans: [Errno 111] Connection refused | ||
``` | ||
|
||
## Causes | ||
|
||
Connectivity errors usually trace back to one of the following issues: | ||
|
||
- **Firewall or port blocking** | ||
|
||
Outbound traffic may be blocked by corporate firewalls or network policies. | ||
|
||
Check that the required protocol and port combination is allowed: | ||
|
||
- OTLP/HTTP: TCP 4318 | ||
- OTLP/gRPC: TCP 4317 | ||
- {{es}} (over HTTPS): 443 | ||
- {{es}}: 9200 | ||
|
||
Also confirm whether your environment uses IPv4 or IPv6, as routing and firewall rules may differ. | ||
|
||
|
||
- **Endpoint errors** | ||
|
||
The endpoint is unreachable or not listening on the specified port: | ||
|
||
- `connection refused`: endpoint not listening | ||
- `network unreachable`: VPN, routing, or DNS failure | ||
- `timeout`: traffic dropped by firewall, proxy, or load balancer | ||
|
||
- **Proxy misconfiguration** | ||
|
||
Proxy environment variables (`HTTP_PROXY`, `HTTPS_PROXY`) might be set correctly but the proxy itself lacks access to Elastic or restricts ports. Refer to [Proxy settings](opentelemetry://reference/edot-collector/config/proxy.md) for more information. | ||
alexandra5000 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
### Differences between SDK and Collector issues | ||
|
||
Errors can look similar whether they come from an SDK or the Collector. Identifying the source helps you isolate the problem. | ||
|
||
:::{note} | ||
Note: Some SDKs support setting a proxy directly (for example, using `HTTPS_PROXY`). Refer to [Proxy settings for EDOT SDKs](../opentelemetry/edot-sdks/proxy.md) for details. | ||
::: | ||
|
||
#### SDK | ||
|
||
Application logs report failures when the SDK cannot send data to the Collector or directly to Elastic. These often appear as `connection refused` or `timeout` messages. If seen, verify that the Collector endpoint is reachable. | ||
hegerchr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
For guidance on enabling logs in your SDK, see [Enable SDK debug logging](../opentelemetry/edot-sdks/enable-debug-logging.md). | ||
|
||
Example (Java SDK): | ||
|
||
```text | ||
io.opentelemetry.exporter.otlp.internal.grpc.OkHttpGrpcExporter - Failed to export spans. Error: UNAVAILABLE: io exception | ||
``` | ||
|
||
#### The Collector | ||
|
||
Collector logs show export failures when it cannot forward data to Elastic. Look for messages like `cannot send spans` or `failed to connect to <endpoint>`. If present, confirm the Collector’s exporters configuration and network access. | ||
|
||
|
||
## Resolution | ||
|
||
Before you dig into SDK or Collector configuration, confirm that your environment can reach the Elastic endpoint. | ||
|
||
:::{note} | ||
The examples below use command syntax from Linux and macOS. On Windows or when testing IPv6, the equivalent tooling or syntax may differ (for example, `Test-NetConnection` in PowerShell). | ||
::: | ||
|
||
alexandra5000 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
:::::{stepper} | ||
|
||
::::{step} Verify DNS resolution | ||
|
||
Make sure the hostname for your Elastic endpoint resolves correctly: | ||
|
||
```bash | ||
nslookup <your-endpoint> | ||
``` | ||
|
||
:::: | ||
|
||
::::{step} Test network reachability | ||
|
||
```bash | ||
ping <your-endpoint> | ||
``` | ||
|
||
:::: | ||
|
||
::::{step} Check open ports | ||
|
||
Test whether the required OTLP ports are open (default `443` for HTTPS): | ||
|
||
```bash | ||
nc -vz <your-endpoint> 443 | ||
``` | ||
|
||
:::: | ||
|
||
::::{step} Verify TLS/SSL | ||
|
||
Check that TLS certificates can be validated: | ||
|
||
```bash | ||
openssl s_client -connect <your-endpoint>:443 | ||
``` | ||
|
||
:::: | ||
|
||
::::: | ||
|
||
If any of these steps fail, the issue is likely caused by network infrastructure rather than your SDK or Collector configuration. | ||
|
||
|
||
### Next steps | ||
|
||
If basic checks and configuration look correct but issues persist, collect more details before escalating: | ||
|
||
* Review proxy settings. For more information, refer to [Proxy settings](opentelemetry://reference/edot-collector/config/proxy.md). | ||
|
||
* If ports are confirmed open but errors persist, [enable debug logging in the SDK](../opentelemetry/edot-sdks/enable-debug-logging.md) or [in the Collector](../opentelemetry/edot-collector/enable-debug-logging.md) for more detail. | ||
|
||
* Contact your network administrator with test results if you suspect firewall restrictions. |
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.