OSB is not compatible with Shenandoah GC | Java 17

[ayushav12]

Describe the bug
I created an OpenSearch-2.3 domain with updated JVM settings to use single-generation Shenandoah Garbage Collector. Then, to test my domain for performance, I setup OSB and ran nyc_taxis workload. The test run failed giving error :

in jvm_stats
old_gen_collection_time = gc["old"]["collection_time_in_millis"]

KeyError: 'old'

Since, Shenandoah is single-generation GC, there's no concept on old-generation, new-generation and permanent-generation as in generic garbage collector algorithms.

More Context (please complete the following information):

• Workload(Share link for custom workloads) : nyc_taxis
• Service(E.g OpenSearch) : OpenSearch
• Version (E.g. 1.0) : 2.3

[IanHoang]

After taking a quick glance in the codebase, this is correct, OSB so far only supports multi-generational garbage collectors (like G1GC and CMS) and does not support experimental types of Garbage Collectors like Shenandoah. We'd have to look at incorporating support for single-generation GCs.

Although it's unlikely that you won't be needing it, if you still want to run node-stats on OS 2.3 without GC metrics, this can be done by running with additional parameters --telemetry-params=node-stats-include-gc=false in the OSB command.

[IanHoang]

Update: It seems like passing in false for node-stats-include-gc doesn't tell OSB to not collect GC data. It only tells OSB to not include GC data into the final node-metrics document that is produced and ingested into the metrics data store. This is why it still fails and encounters the same issue about unable to find old GC even when parameter is passed in.

opensearch-benchmark/osbenchmark/telemetry.py

Lines 706 to 721 in a1f4550

	if self.include_mem_stats:
	collected_node_stats.update(self.jvm_mem_stats(node_name, node_stats))
	if self.include_gc_stats:
	collected_node_stats.update(self.jvm_gc_stats(node_name, node_stats))
	if self.include_network:
	collected_node_stats.update(self.network_stats(node_name, node_stats))
	if self.include_process:
	collected_node_stats.update(self.process_stats(node_name, node_stats))
	if self.include_indexing_pressure:
	collected_node_stats.update(self.indexing_pressure(node_name, node_stats))
	self.metrics_store.put_doc(dict(collected_node_stats),
	level=MetaInfoScope.node,
	node_name=node_name,
	meta_data=metrics_store_meta_data)

[IanHoang]

This issue is similar to #206 and should be regarded as an enhancement rather than a bug because OSB currently supports GCs with concepts of old / young generations like G1GC and CMS GCs. We've currently implemented a short-term fix but will work on a long-term fix eventually.

[IanHoang]

No plans for adding support for Shenandoah GC for now