Introduction

Java ThreadLocal causes memory leak when thread pool threads retain references after use. This guide provides step-by-step diagnosis and resolution with specific commands and code examples.

Symptoms

Typical symptoms and error messages when this issue occurs:

bash
java.lang.Error: Unexpected error occurred
	at com.example.Application.main(Application.java:42)
Caused by: internal error

Observable indicators: - Application logs show errors or exceptions - JVM crashes or becomes unresponsive - Related services may fail or timeout

Common Causes

  1. 1.Memory issues are commonly caused by:
  2. 2.Memory leaks retaining unreachable objects
  3. 3.Insufficient heap size for workload
  4. 4.Incorrect GC algorithm selection
  5. 5.Large object allocation patterns

Step-by-Step Fix

Step 1: Check Current State

bash
java -version

Step 2: Identify Root Cause

bash
jcmd <pid> VM.info

Step 3: Apply Primary Fix

java
// Primary fix: update configuration
@Configuration
public class AppConfig {
    @Bean
    public MyBean myBean() {
        MyBean bean = new MyBean();
        bean.setTimeout(30000);
        return bean;
    }
}

Apply this configuration and restart the application.

Step 4: Apply Alternative Fix (If Needed)

java
// Alternative fix: use properties
# application.properties
app.timeout=30000
app.retry-count=3
app.enabled=true

Run load tests to verify thread safety under concurrent access.

Step 5: Verify the Fix

After applying the fix, verify with:

bash
jstack <pid> | grep -A 10 "BLOCKED\|WAITING"

Expected output should show successful operation without errors.

Common Pitfalls

  • Forgetting to unlock in finally block
  • Using synchronized incorrectly
  • Not handling InterruptedException

Best Practices

  • Use ExecutorService instead of creating threads
  • Always handle InterruptedException
  • Use concurrent collections for shared state
  • Java ThreadPoolExecutor Rejected Execution
  • Java ConcurrentModificationException
  • Java ThreadLocal Memory Leak