domino_admin_toolkit.checks.test_nucleus module

domino_admin_toolkit.checks.test_nucleus.get_nucleus_pods()

domino_admin_toolkit.checks.test_nucleus.parse_max_heap_size(java_opts)

domino_admin_toolkit.checks.test_nucleus.test_jvm_heap(platform_namespace, container_name)

Description:

Test whether dispatcher heap has more than half of instance total memory

Result:

Dispatcher memory limits and JVM heap size

Public Facing KB:

https://support.domino.ai/support/s/article/Domino-Run-with-Large-Repo-Fails-to-Start-Due-to-JVM-Heap-Space-Out-of-Memory-Error-1718868040163

domino_admin_toolkit.checks.test_nucleus.test_nucleus_dispatcher_latency()

Description:

Tests nucleus dispatcher latency

Result:

Test passes if the latency is less than 500 milliseconds, else fails

domino_admin_toolkit.checks.test_nucleus.test_nucleus_old_gc_percent_and_current_heap_usage(gc_percentage, heap_threshold)

Description:

Extract the percentages of heap utilization for dispatcher and frontend from Prometheus. Examine the duration spent on garbage collection for old generations in nucleus pods. The heap utilization becomes problematic when the nucleus spends an excessive amount of CPU time on garbage collection. This check helps identify potential performance issues related to garbage collection in the nucleus pod’s JVM

Result:

Test and display the average JVM memory heap usage over time, and check that it stays below 90%. Print out the percentage of time spent on garbage collection of old generations in JVMs If the time spent collecting old generations exceeds 25%, the test will fail. The results are printed out in table format.