spring-cloud / spring-cloud/spring-cloud-netflix

Document Load Balancing in Spring Cloud Netflix

Open
#4,527 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted
Dominant language
Java
Stars
5k
Forks
2.5k
Avg merge
1d 2h
Merged PRs (30d)
10

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading EurekaLoadBalancerProperties.java and EurekaLoadBalancerClientConfiguration.java, the two source files referenced in the request, to verify configuration and zone-preference behavior. Done means documentation covers LoadBalancer usage, Eureka discovery and metadata filtering, configuration and customization examples, troubleshooting, and relevant source references.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring-boot
Domain
cloud, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.