Affected: Relay Proxy
Overview
This document provides guidance for addressing issues with the Relay Proxy. Follow the steps below in order to identify and resolve the issue.
Solution
Follow these steps to troubleshoot the Relay Proxy:
1. Verify the Relay Proxy configuration and ensure that the Relay Proxy is configured as described in the documentation:
- Connected to all required environments or using auto-configuration.
- Optionally configured to support JS or mobile SDKs.
- Optionally configured to receive events.
2. Check the network architecture:
- Confirm that the SDK is connecting to the Relay Proxy.
- If you use a load balancer and dynamic scaling:
- Rebalance the load balancer after downscaling.
- For many SDK instances, consider using a Relay Proxy array or local Relay Proxies.
- Ensure SDK implementations follow a singleton pattern. The Relay Proxy may mask SDK issues that would otherwise be evident when connected directly to LaunchDarkly.
3. Verify Relay Proxy connections:
SDK to Relay Proxy
- Confirm the SDK is properly connecting to the Relay Proxy.
Relay Proxy to LaunchDarkly
- Check the LaunchDarkly Status Page for reported incidents.
- Verify the Relay Proxy's health by sending a
GET
request to/status
on the Relay Proxy URL.
4. Confirm network configuration:
- Ensure the network allows server-side events and long-lived connections.
- Address application load balancer (ALB) disconnection issues:
- ALBs often disconnect idle connections after 60 seconds of inactivity.
- The Relay Proxy sends a one-byte heartbeat every 3 minutes to keep connections alive. Adjust the ALB idle timeout to exceed 3 minutes to prevent premature disconnection.
5. Additional configurations depending on organizational requirements:
- Persistent store connections:
- Ensure the Relay Proxy connects to the persistent store if SDK instances will use it without directly connecting to LaunchDarkly.
- Note: The Relay Proxy does not support Redis clusters or Redis Sentinel.
- Metric-export integrations:
- If configured, verify activity on the Relay Proxy to generate metrics. Metrics are not reported without activity.