Surface OS page-cache stats (Buffers/Cached) in /status?full=true

Aperta
#267 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
1/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
python

Direzione di ricerca

Read the issue update and #287 for the current node-exporter approach; #231 documents why the proposed /status implementation was removed. The issue says api/solr.py exists only on the unmerged #253 branch, and Solr's metrics API does not expose these page-cache values. This issue is superseded, so its requested /status change is not a viable completion target.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

performance

[!NOTE]
Superseded by #287. Kept open pending a decision on that issue — see the update below for why the approach proposed here is not achievable from /status.

Update (2026-07-24): why this cannot be served from /status

Investigated while building #231 (/status metrics). The premise of this issue is right — free_physical_memory_bytes is misleading, and #231 removed that field for exactly the reason described below. But the proposed mechanism turns out not to be achievable, for two independent reasons:

1. Solr's metrics API cannot report Buffers/Cached. Verified empirically against Solr 9.10 (/admin/metrics, all groups): the JVM's OperatingSystemMXBean exposes only freePhysicalMemorySize (= Linux MemFree, which excludes page cache) and totalPhysicalMemorySize. There is no Buffers/Cached/MemAvailable anywhere in Solr's metrics output, so there is nothing for NameRes to fetch.

2. The suggested implementation point cannot read the Solr host. The plan above ("read inside the Solr container ... implementation belongs in api/solr.py (SolrClient.fetch_status)") conflates two different machines: that code runs in the NameRes API process, which reaches Solr only over HTTP — it cannot read the Solr container's /proc/meminfo. Reading its own /proc/meminfo reports the API node, which equals the Solr node only when the two are co-located. This was prototyped in #231 as an api_node_memory block and then removed, because a figure labelled as Solr's page cache that silently isn't is worse than no figure at all. (Separately, api/solr.py exists only on the #253 branch, which is not being merged to main.)

So the "Alternative" already noted in this issue — a node-level exporter — is in fact the only workable path. That is now tracked in #287.

What /status?full=true does provide as of #231

Enough to confirm the #265 heap reduction landed and to size the pod, though not page-cache occupancy:

  • solr_metrics.jvm — heap_used_mb / heap_max_mb / heap_used_pct, gc_count / gc_time_ms
  • solr_metrics.host — total_physical_mem_mb, available_processors, system_load_average, system_cpu_load

free_physical_mem_mb was deliberately not carried over, for the reason this issue opens with. Solr's GC logs now also go to stdout, so they are visible in Grafana next to whatever a node exporter would publish.


Summary

solr.os.free_physical_memory_bytes alone is misleading on Linux — what matters for Solr/Lucene query performance is Buffers + Cached from /proc/meminfo. The currently exposed free_physical_memory_bytes reports as 632 KB on the production node, which is alarming-looking but technically expected on Linux even when there is plenty of cache available.

This makes it hard to tell at a glance whether the heap-vs-cache fix proposed in #265 has actually freed enough memory for the OS page cache to hold a useful portion of the 142 GB index.

Suggested action

Add a solr.os.linux_meminfo block to the /status?full=true payload populated from /proc/meminfo (read inside the Solr container — readable by any user). Surface at least:

  • MemAvailable_bytes
  • Cached_bytes
  • Buffers_bytes

Implementation belongs in api/solr.py (SolrClient.fetch_status) since this is part of the Solr-host story rather than the API process. The existing parse_os helper can be extended.

Alternative: scrape from a node-exporter sidecar and link the dashboard from /status. Either is fine; the goal is one place to look during incident triage.

Why this matters

After deploying the heap reduction in #265, we want a single check that confirms the cache is actually being populated, not just that the heap was reduced. Right now we would have to SSH into the Solr container to read /proc/meminfo directly.

Lingua principale
Python
Stelle
5
Fork
4
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NCATSTranslator/NameResolution

Tutte le issue di NCATSTranslator/NameResolution

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.