spring-cloud/spring-cloud-netflix

Document Load Balancing in Spring Cloud Netflix

Open

#4527 opened on Jan 23, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4,805 stars) (2,433 forks)batch import
documentationhelp wanted

Description

Documentation Request: Load Balancing in Spring Cloud Netflix

Overview

Spring Cloud Netflix provides integrated load balancing capabilities primarily via Spring Cloud LoadBalancer and Eureka service discovery. Clear documentation will help users understand:

  • How load balancing works with Eureka and Spring Cloud LoadBalancer
  • Key configuration properties
  • Zone-preference logic and metadata
  • How to enable/disable or customize load balancing for services
  • Best practices and common pitfalls

Core Areas to Cover

  • Spring Cloud LoadBalancer Usage
    • How service instances are selected for requests
    • Relationship to DiscoveryClient and logical Eureka service identifiers (VIPs)
  • Zone Preference and Configuration
    • How zone is determined (instance metadata, hostname, client config)
    • The role of spring.cloud.loadbalancer.eureka.approximateZoneFromHostname
  • Properties and Customization
    • Main configuration properties (with sample values)
    • Example YAML/Java configuration snippets
  • Eureka Metadata & Filtering
    • Use of eureka.instance.metadataMap.zone
  • Troubleshooting Tips
    • Common misconfigurations
    • How to verify load balancing behavior in logs
  • References to Source Code

Benefit

Improved documentation will assist users in comprehending, enabling, and troubleshooting load balancing in Spring Cloud Netflix microservice deployments.

Contributor guide

Tech stack
java
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Spring CloudUnderstanding of microservicesFamiliarity with Eureka
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Review the referenced source files (EurekaLoadBalancerProperties.java and EurekaLoadBalancerClientConfiguration.java) to understand current implementation. Then draft documentation covering the outlined areas including configuration properties, zone preference, and troubleshooting tips. Ensure the documentation aligns with the existing Spring Cloud documentation style.