prod api: repeated Java heap OutOfMemoryError exits (often all replicas together)

Open
#2,106 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
docker, java, kubernetes

Research direction

Start from the JVM flags in docker/build/service/entrypoint.sh (MaxRAMPercentage, HeapDumpOnOutOfMemoryError) and the deployment settings in vcell-fluxcd kustomize/base/api.yaml (memory limit, /dump emptyDir, imagePullPolicy). To identify the culprit request, add logging of request start or slow/large requests in the legacy Restlet /api/v0 path (LogService only logs completed requests), then copy the .hprof out of /dump after the next OOM. Done means either the offending request pattern is named with evidence, or a concrete config change (limit raise, IfNotPresent, restart-cron cleanup) is proposed and validated against Prometheus metrics; requires prod/Kubernetes access, so it is not startable from the issue text alone.

Written by the indexing model from the issue text.

Description

Summary

The prod api service (legacy Restlet /api/v0, the vcell-service image with arg api) repeatedly exits with Terminating due to java.lang.OutOfMemoryError: Java heap space. Several times, every replica failed within about 30 seconds of each other, which briefly takes down /api/v0 and trips the Better Stack health check.

This is separate from the 09-17/18 outage. That one came from an expired image pull secret: the OOM restarts couldn't pull the image. It was fixed by removing the pull secrets and making all images public, so restarts now recover in seconds. The OOMs themselves are unchanged.

Evidence (prod, 2026-09-16 → 09-25)

  • 12 container restarts in 10 days, all api. No other prod container restarted.

    • Kubernetes reports reason=Error, exit code 3. That's -XX:+ExitOnOutOfMemoryError, not the kernel OOM killer, so the container never shows OOMKilled.
    • Every one of them is logged as Terminating due to java.lang.OutOfMemoryError: Java heap space.
  • OOM times (UTC):

    • 09-16 17:35, 09-17 04:37, 09-17 20:53;
    • 09-18 22:14 (2 replicas);
    • 09-19 10:01 (2);
    • 09-20 22:49 (2);
    • 09-21 09:39 (all 3).

    None since 09-21. 8.1.8.04 went to prod on 09-25 with the same memory settings.

  • Memory is not leaking. Container working set swings between about 600 and 1,700 MiB (garbage collection) with no upward trend over pod lifetimes of up to 7 days (Prometheus, 10-day retention).

    • Limit: 2000 Mi.
    • -XX:MaxRAMPercentage=50 (docker/build/service/entrypoint.sh) gives a heap of about 1 GB.
    • Roughly 700 Mi is non-heap.
  • Pattern: replicas die close together, and the requests logged in the minutes before are ordinary (mostly /api/v0/events, /biomodel/{id}/simulation/{id}, /simtask). That points to a single heavy request (probably a large model) being retried on each replica in turn.

  • The offending request is unknown. The Restlet access log (LogService) is written when a request completes, so the one that ran out of memory never appears.

Possible actions

  1. Identify the request. Heap dumps go to /dump (-XX:+HeapDumpOnOutOfMemoryError). In vcell-fluxcd kustomize/base/api.yaml, /dump is an emptyDir (4Gi).
    • It survives OOM restarts (container restart, same pod) but is lost when a rollout replaces the pods. Today's 8.1.8.04 deploy discarded any earlier dumps.
    • After the next OOM, kubectl cp the .hprof out before redeploying.
    • Caution: a dump contains secrets (DB password, JWT key), so it must not go on user-reachable storage (/exportdir, /simdata).
    • Also consider logging request start (or slow/large requests), so the in-flight request is visible.
  2. More headroom. Raise the api memory limit in vcell-fluxcd kustomize/base/api.yaml, e.g. 2000 Mi → 3000 Mi (about a 1.5 GB heap at 50%). Nodes have 32 GB, and the busiest has about 80% committed as limits. Raising MaxRAMPercentage alone would push the working set toward the limit.
  3. Fix the root cause once the request is known, e.g. bound the work a single request can do (model size, math generation, result size).
  4. Restart resilience. api.yaml sets imagePullPolicy: "Always", so every restart re-pulls from GHCR. That's how the expired pull secret turned OOM restarts into an 18-hour outage. With immutable version tags, IfNotPresent would make restarts independent of the registry.
  5. Housekeeping. Delete the suspended hourly restart-api-cron (vcell-fluxcd kustomize/overlays/prod/restart-api-cronjob.yaml and its kustomization.yaml entry). It's suspended since 2026-08-22, memory isn't growing, and periodic restarts wouldn't prevent request-triggered OOMs anyway.

Related (observed while investigating)

  • /api/v0/simdata/{id}/jobindex/N returns a generic 500 when the simulation's results are missing or unreadable (bursts on 09-23 and 09-24). It should probably be a 404, like the BNGL fix in #2104.
  • Loki has no logs from any namespace for 09-21 18:00–21:00 UTC (a log-shipping outage).

🤖 Generated with Claude Code

Dominant language
Java
Stars
140
Forks
35
Avg merge
17h 39m
Merged PRs (30d)
19

Getting set up

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.

More from virtualcell/vcell

All issues in virtualcell/vcell

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.