Fix OpenSearch 3.4.0+ API compatibility and enhance test infrastructure

sean- · sean- · commit 54d08f697522 · 2026-01-22T16:58:53.000-08:00
This commit resolves compatibility issues discovered during integration testing
with OpenSearch 3.4.0+, ensuring the Go client works seamlessly with the
latest OpenSearch versions.

- **Nodes Stats API**: Add warmer fields to merges section with proper
  _count/_millis suffixes; add status_counter field with doc_status subfields
- **Indices Stats API**: Add warmer fields to IndicesStatsMerges struct
  with proper _count/_millis suffixes
- **Cat Thread Pool API**: Add parallelism field for thread pool metrics
- **Cat APIs** (indices, shards, nodes): Add comprehensive merges warmer
  fields matching flattened JSON structure from OpenSearch responses

- Fix Cat APIs JSON unmarshaling by changing byte fields from *int to *string
  to properly handle OpenSearch 3.4.0+ values like "0b"
- Remove incorrect ,string JSON tags from string fields
- Ensures compatibility with OpenSearch's mixed data type responses

- Correctly implement different naming patterns across API families:
  - Cat APIs: total_invocations, total_time
  - Stats APIs: total_invocations_count, total_time_millis

Signed-off-by: Sean Chittenden &lt;sean.chittenden@crowdstrike.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,10 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Fix cat APIs compatibility with OpenSearch 3.3.0+ by adding query_failed and startree_query_failed search fields
 - Fix cluster state API compatibility with OpenSearch 3.3.0+ by adding ingestion_status field to index metadata
 - Fix security config API compatibility with OpenSearch 3.3.0+ by adding jwks_uri field to JWT authentication configuration
+- Fix nodes stats API compatibility with OpenSearch 3.4.0+ by adding warmer field to merges section and status_counter field
+- Fix indices stats API compatibility with OpenSearch 3.4.0+ by adding warmer field to merges section
+- Fix cat APIs compatibility with OpenSearch 3.4.0+ by adding parallelism field to thread pool and warmer fields to merges section
+- Fix cat APIs data type compatibility by changing byte fields from int to string to properly handle values like "0b"
 
 ### Security
 
diff --git a/opensearchapi/api_cat-indices.go b/opensearchapi/api_cat-indices.go
diff --git a/opensearchapi/api_cat-nodes.go b/opensearchapi/api_cat-nodes.go
@@ -37,72 +37,81 @@ type CatNodesResp struct {
 
 // CatNodesItemResp represents one index of the CatNodesResp
 type CatNodesItemResp struct {
-	ID                              string  `json:"id"`
-	PID                             *string `json:"pid"`
-	IP                              string  `json:"ip"`
-	Port                            int     `json:"port,string"`
-	HTTPAddress                     string  `json:"http_address"`
-	Version                         string  `json:"version"`
-	Type                            *string `json:"type"`
-	Build                           *string `json:"build"`
-	JDK                             *string `json:"jdk"`
-	DiskTotal                       *string `json:"disk.total"`
-	DiskUsed                        *string `json:"disk.used"`
-	DiskAvail                       *string `json:"disk.avail"`
-	DiskUsedPercent                 *string `json:"disk.used_percent"`
-	HeapCurrent                     *string `json:"heap.current"`
-	HeapPercent                     *int    `json:"heap.percent,string"`
-	HeapMax                         *string `json:"heap.max"`
-	RAMCurrent                      *string `json:"ram.current"`
-	RAMPercent                      *int    `json:"ram.percent,string"`
-	RAMMax                          *string `json:"ram.max"`
-	FileDescCurrent                 *int    `json:"file_desc.current,string"`
-	FileDescPercent                 *int    `json:"file_desc.percent,string"`
-	FileDescMax                     *int    `json:"file_desc.max,string"`
-	CPU                             *int    `json:"cpu,string"`
-	Load1M                          *string `json:"load_1m"`
-	Load5M                          *string `json:"load_5m"`
-	Load15M                         *string `json:"load_15m"`
-	Uptime                          *string `json:"uptime"`
-	Role                            string  `json:"node.role"`
-	Roles                           string  `json:"node.roles"`
-	Master                          string  `json:"master"`
-	ClusterManager                  string  `json:"cluster_manager"`
-	Name                            string  `json:"name"`
-	CompletionSize                  *string `json:"completion.size"`
-	FieldDataMemorySize             *string `json:"fielddata.memory_size"`
-	FileldDataEvictions             *int    `json:"fielddata.evictions,string"`
-	QueryCacheMemorySize            *string `json:"query_cache.memory_size"`
-	QueryCacheEvictions             *int    `json:"query_cache.evictions,string"`
-	QueryCacheHitCount              *int    `json:"query_cache.hit_count,string"`
-	QueryCacheMissCount             *int    `json:"query_cache.miss_count,string"`
-	RequestCacheMemorySize          *string `json:"request_cache.memory_size"`
-	RequestCacheEvictions           *int    `json:"request_cache.evictions,string"`
-	RequestCacheHitCount            *int    `json:"request_cache.hit_count,string"`
-	RequestCacheMissCount           *int    `json:"request_cache.miss_count,string"`
-	FlushTotal                      *int    `json:"flush.total,string"`
-	FlushTotalTime                  *string `json:"flush.total_time"`
-	GetCurrent                      *int    `json:"get.current,string"`
-	GetTime                         *string `json:"get.time"`
-	GetTotal                        *int    `json:"get.total,string"`
-	GetExistsTime                   *string `json:"get.exists_time"`
-	GetExistsTotal                  *int    `json:"get.exists_total,string"`
-	GetMissingTime                  *string `json:"get.missing_time"`
-	GetMissingTotal                 *int    `json:"get.missing_total,string"`
-	IndexingDeleteCurrent           *int    `json:"indexing.delete_current,string"`
-	IndexingDeleteTime              *string `json:"indexing.delete_time"`
-	IndexingDeleteTotal             *int    `json:"indexing.delete_total,string"`
-	IndexingIndexCurrent            *int    `json:"indexing.index_current,string"`
-	IndexingIndexTime               *string `json:"indexing.index_time"`
-	IndexingIndexTotal              *int    `json:"indexing.index_total,string"`
-	IndexingIndexFailed             *int    `json:"indexing.index_failed,string"`
-	MergesCurrent                   *int    `json:"merges.current,string"`
-	MergesCurrentDoc                *int    `json:"merges.current_docs,string"`
-	MergesCurrentSize               *string `json:"merges.current_size"`
-	MergesTotal                     *int    `json:"merges.total,string"`
-	MergesTotalDocs                 *int    `json:"merges.total_docs,string"`
-	MergesTotalSize                 *string `json:"merges.total_size"`
-	MergesTotalTime                 *string `json:"merges.total_time"`
+	ID                     string  `json:"id"`
+	PID                    *string `json:"pid"`
+	IP                     string  `json:"ip"`
+	Port                   int     `json:"port,string"`
+	HTTPAddress            string  `json:"http_address"`
+	Version                string  `json:"version"`
+	Type                   *string `json:"type"`
+	Build                  *string `json:"build"`
+	JDK                    *string `json:"jdk"`
+	DiskTotal              *string `json:"disk.total"`
+	DiskUsed               *string `json:"disk.used"`
+	DiskAvail              *string `json:"disk.avail"`
+	DiskUsedPercent        *string `json:"disk.used_percent"`
+	HeapCurrent            *string `json:"heap.current"`
+	HeapPercent            *int    `json:"heap.percent,string"`
+	HeapMax                *string `json:"heap.max"`
+	RAMCurrent             *string `json:"ram.current"`
+	RAMPercent             *int    `json:"ram.percent,string"`
+	RAMMax                 *string `json:"ram.max"`
+	FileDescCurrent        *int    `json:"file_desc.current,string"`
+	FileDescPercent        *int    `json:"file_desc.percent,string"`
+	FileDescMax            *int    `json:"file_desc.max,string"`
+	CPU                    *int    `json:"cpu,string"`
+	Load1M                 *string `json:"load_1m"`
+	Load5M                 *string `json:"load_5m"`
+	Load15M                *string `json:"load_15m"`
+	Uptime                 *string `json:"uptime"`
+	Role                   string  `json:"node.role"`
+	Roles                  string  `json:"node.roles"`
+	Master                 string  `json:"master"`
+	ClusterManager         string  `json:"cluster_manager"`
+	Name                   string  `json:"name"`
+	CompletionSize         *string `json:"completion.size"`
+	FieldDataMemorySize    *string `json:"fielddata.memory_size"`
+	FileldDataEvictions    *int    `json:"fielddata.evictions,string"`
+	QueryCacheMemorySize   *string `json:"query_cache.memory_size"`
+	QueryCacheEvictions    *int    `json:"query_cache.evictions,string"`
+	QueryCacheHitCount     *int    `json:"query_cache.hit_count,string"`
+	QueryCacheMissCount    *int    `json:"query_cache.miss_count,string"`
+	RequestCacheMemorySize *string `json:"request_cache.memory_size"`
+	RequestCacheEvictions  *int    `json:"request_cache.evictions,string"`
+	RequestCacheHitCount   *int    `json:"request_cache.hit_count,string"`
+	RequestCacheMissCount  *int    `json:"request_cache.miss_count,string"`
+	FlushTotal             *int    `json:"flush.total,string"`
+	FlushTotalTime         *string `json:"flush.total_time"`
+	GetCurrent             *int    `json:"get.current,string"`
+	GetTime                *string `json:"get.time"`
+	GetTotal               *int    `json:"get.total,string"`
+	GetExistsTime          *string `json:"get.exists_time"`
+	GetExistsTotal         *int    `json:"get.exists_total,string"`
+	GetMissingTime         *string `json:"get.missing_time"`
+	GetMissingTotal        *int    `json:"get.missing_total,string"`
+	IndexingDeleteCurrent  *int    `json:"indexing.delete_current,string"`
+	IndexingDeleteTime     *string `json:"indexing.delete_time"`
+	IndexingDeleteTotal    *int    `json:"indexing.delete_total,string"`
+	IndexingIndexCurrent   *int    `json:"indexing.index_current,string"`
+	IndexingIndexTime      *string `json:"indexing.index_time"`
+	IndexingIndexTotal     *int    `json:"indexing.index_total,string"`
+	IndexingIndexFailed    *int    `json:"indexing.index_failed,string"`
+	MergesCurrent          *int    `json:"merges.current,string"`
+	MergesCurrentDoc       *int    `json:"merges.current_docs,string"`
+	MergesCurrentSize      *string `json:"merges.current_size"`
+	MergesTotal            *int    `json:"merges.total,string"`
+	MergesTotalDocs        *int    `json:"merges.total_docs,string"`
+	MergesTotalSize        *string `json:"merges.total_size"`
+	MergesTotalTime        *string `json:"merges.total_time"`
+	// Merges warmer fields added in OpenSearch 3.4.0+
+	MergesWarmerOngoingCount        *int    `json:"merges.warmer.ongoing_count,string"`
+	MergesWarmerTotalInvocations    *int    `json:"merges.warmer.total_invocations,string"`
+	MergesWarmerTotalTime           *string `json:"merges.warmer.total_time"`
+	MergesWarmerTotalFailureCount   *int    `json:"merges.warmer.total_failure_count,string"`
+	MergesWarmerTotalBytesSent      *string `json:"merges.warmer.total_bytes_sent"`
+	MergesWarmerTotalBytesReceived  *string `json:"merges.warmer.total_bytes_received"`
+	MergesWarmerTotalSendTime       *string `json:"merges.warmer.total_send_time"`
+	MergesWarmerTotalReceiveTime    *string `json:"merges.warmer.total_receive_time"`
 	RefreshTotal                    *int    `json:"refresh.total,string"`
 	RefreshTime                     *string `json:"refresh.time"`
 	RefreshExternalTotal            *int    `json:"refresh.external_total,string"`
diff --git a/opensearchapi/api_cat-shards.go b/opensearchapi/api_cat-shards.go
@@ -47,49 +47,58 @@ type CatShardsResp struct {
 
 // CatShardResp represents one index of the CatShardsResp
 type CatShardResp struct {
-	Index                          string  `json:"index"`
-	Shard                          int     `json:"shard,string"`
-	Prirep                         string  `json:"prirep"`
-	State                          string  `json:"state"`
-	Docs                           *string `json:"docs"`
-	Store                          *string `json:"store"`
-	IP                             *string `json:"ip"`
-	ID                             *string `json:"id"`
-	Node                           *string `json:"node"`
-	SyncID                         *string `json:"sync_id"`
-	UnassignedReason               *string `json:"unassigned.reason"`
-	UnassignedAt                   *string `json:"unassigned.at"`
-	UnassignedFor                  *string `json:"unassigned.for"`
-	UnassignedDetails              *string `json:"unassigned.details"`
-	RecoverysourceType             *string `json:"recoverysource.type"`
-	CompletionSize                 *string `json:"completion.size"`
-	FielddataMemorySize            *string `json:"fielddata.memory_size"`
-	FielddataEvictions             *int    `json:"fielddata.evictions,string"`
-	QueryCacheMemorySize           *string `json:"query_cache.memory_size"`
-	QueryCacheEvictions            *int    `json:"query_cache.evictions,string"`
-	FlushTotal                     *int    `json:"flush.total,string"`
-	FlushTotalTime                 *string `json:"flush.total_time"`
-	GetCurrent                     *int    `json:"get.current,string"`
-	GetTime                        *string `json:"get.time"`
-	GetTotal                       *int    `json:"get.total,string"`
-	GetExistsTime                  *string `json:"get.exists_time"`
-	GetExistsTotal                 *int    `json:"get.exists_total,string"`
-	GetMissingTime                 *string `json:"get.missing_time"`
-	GetMissingTotal                *int    `json:"get.missing_total,string"`
-	IndexingDeleteCurrent          *int    `json:"indexing.delete_current,string"`
-	IndexingDeleteTime             *string `json:"indexing.delete_time"`
-	IndexingDeleteTotal            *string `json:"indexing.delete_total"`
-	IndexingIndexCurrent           *int    `json:"indexing.index_current,string"`
-	IndexingIndexTime              *string `json:"indexing.index_time"`
-	IndexingIndexTotal             *int    `json:"indexing.index_total,string"`
-	IndexingIndexFailed            *int    `json:"indexing.index_failed,string"`
-	MergesCurrent                  *int    `json:"merges.current,string"`
-	MergesCurrentDocs              *int    `json:"merges.current_docs,string"`
-	MergesCurrentSize              *string `json:"merges.current_size"`
-	MergesTotal                    *int    `json:"merges.total,string"`
-	MergesTotalDocs                *int    `json:"merges.total_docs,string"`
-	MergesTotalSize                *string `json:"merges.total_size"`
-	MergesTotalTime                *string `json:"merges.total_time"`
+	Index                 string  `json:"index"`
+	Shard                 int     `json:"shard,string"`
+	Prirep                string  `json:"prirep"`
+	State                 string  `json:"state"`
+	Docs                  *string `json:"docs"`
+	Store                 *string `json:"store"`
+	IP                    *string `json:"ip"`
+	ID                    *string `json:"id"`
+	Node                  *string `json:"node"`
+	SyncID                *string `json:"sync_id"`
+	UnassignedReason      *string `json:"unassigned.reason"`
+	UnassignedAt          *string `json:"unassigned.at"`
+	UnassignedFor         *string `json:"unassigned.for"`
+	UnassignedDetails     *string `json:"unassigned.details"`
+	RecoverysourceType    *string `json:"recoverysource.type"`
+	CompletionSize        *string `json:"completion.size"`
+	FielddataMemorySize   *string `json:"fielddata.memory_size"`
+	FielddataEvictions    *int    `json:"fielddata.evictions,string"`
+	QueryCacheMemorySize  *string `json:"query_cache.memory_size"`
+	QueryCacheEvictions   *int    `json:"query_cache.evictions,string"`
+	FlushTotal            *int    `json:"flush.total,string"`
+	FlushTotalTime        *string `json:"flush.total_time"`
+	GetCurrent            *int    `json:"get.current,string"`
+	GetTime               *string `json:"get.time"`
+	GetTotal              *int    `json:"get.total,string"`
+	GetExistsTime         *string `json:"get.exists_time"`
+	GetExistsTotal        *int    `json:"get.exists_total,string"`
+	GetMissingTime        *string `json:"get.missing_time"`
+	GetMissingTotal       *int    `json:"get.missing_total,string"`
+	IndexingDeleteCurrent *int    `json:"indexing.delete_current,string"`
+	IndexingDeleteTime    *string `json:"indexing.delete_time"`
+	IndexingDeleteTotal   *string `json:"indexing.delete_total"`
+	IndexingIndexCurrent  *int    `json:"indexing.index_current,string"`
+	IndexingIndexTime     *string `json:"indexing.index_time"`
+	IndexingIndexTotal    *int    `json:"indexing.index_total,string"`
+	IndexingIndexFailed   *int    `json:"indexing.index_failed,string"`
+	MergesCurrent         *int    `json:"merges.current,string"`
+	MergesCurrentDocs     *int    `json:"merges.current_docs,string"`
+	MergesCurrentSize     *string `json:"merges.current_size"`
+	MergesTotal           *int    `json:"merges.total,string"`
+	MergesTotalDocs       *int    `json:"merges.total_docs,string"`
+	MergesTotalSize       *string `json:"merges.total_size"`
+	MergesTotalTime       *string `json:"merges.total_time"`
+	// Merges warmer fields added in OpenSearch 3.4.0+
+	MergesWarmerOngoingCount       *int    `json:"merges.warmer.ongoing_count,string"`
+	MergesWarmerTotalInvocations   *int    `json:"merges.warmer.total_invocations,string"`
+	MergesWarmerTotalTime          *string `json:"merges.warmer.total_time"`
+	MergesWarmerTotalFailureCount  *int    `json:"merges.warmer.total_failure_count,string"`
+	MergesWarmerTotalBytesSent     *string `json:"merges.warmer.total_bytes_sent"`
+	MergesWarmerTotalBytesReceived *string `json:"merges.warmer.total_bytes_received"`
+	MergesWarmerTotalSendTime      *string `json:"merges.warmer.total_send_time"`
+	MergesWarmerTotalReceiveTime   *string `json:"merges.warmer.total_receive_time"`
 	RefreshTotal                   *int    `json:"refresh.total,string"`
 	RefreshTime                    *string `json:"refresh.time"`
 	RefreshExternalTotal           *int    `json:"refresh.external_total,string"`
diff --git a/opensearchapi/api_cat-thread_pool.go b/opensearchapi/api_cat-thread_pool.go
@@ -68,6 +68,8 @@ type CatThreadPoolItemResp struct {
 	Size            *int    `json:"size,string"`
 	KeepAlive       *string `json:"keep_alive"`
 	TotalWaitTime   string  `json:"total_wait_time"`
+	// Parallelism field added in OpenSearch 3.4.0+
+	Parallelism *int `json:"parallelism,string"`
 }
 
 // Inspect returns the Inspect type containing the raw *opensearch.Response
diff --git a/opensearchapi/api_indices-stats.go b/opensearchapi/api_indices-stats.go
@@ -152,6 +152,17 @@ type IndicesStatsMerges struct {
 	TotalThrottledTimeInMillis        int   `json:"total_throttled_time_in_millis"`
 	TotalAutoThrottleInBytes          int   `json:"total_auto_throttle_in_bytes"`
 	UnreferencedFileCleanupsPerformed int   `json:"unreferenced_file_cleanups_performed"`
+	// Warmer field added in OpenSearch 3.4.0+
+	Warmer *struct {
+		TotalInvocationsCount  int `json:"total_invocations_count"`
+		TotalTimeMillis        int `json:"total_time_millis"`
+		TotalFailureCount      int `json:"total_failure_count"`
+		TotalBytesSent         int `json:"total_bytes_sent"`
+		TotalBytesReceived     int `json:"total_bytes_received"`
+		TotalSendTimeMillis    int `json:"total_send_time_millis"`
+		TotalReceiveTimeMillis int `json:"total_receive_time_millis"`
+		OngoingCount           int `json:"ongoing_count"`
+	} `json:"warmer,omitempty"`
 }
 
 // IndicesStatsRefresh is a sub type of IndicesStatsInfo containing stats about index refresh
diff --git a/opensearchapi/api_nodes-stats.go b/opensearchapi/api_nodes-stats.go
@@ -198,6 +198,17 @@ type NodesStatsIndices struct {
 		TotalThrottledTimeInMillis        int `json:"total_throttled_time_in_millis"`
 		TotalAutoThrottleInBytes          int `json:"total_auto_throttle_in_bytes"`
 		UnreferencedFileCleanupsPerformed int `json:"unreferenced_file_cleanups_performed"`
+		// Warmer field added in OpenSearch 3.4.0+
+		Warmer *struct {
+			TotalInvocationsCount  int `json:"total_invocations_count"`
+			TotalTimeMillis        int `json:"total_time_millis"`
+			TotalFailureCount      int `json:"total_failure_count"`
+			TotalBytesSent         int `json:"total_bytes_sent"`
+			TotalBytesReceived     int `json:"total_bytes_received"`
+			TotalSendTimeMillis    int `json:"total_send_time_millis"`
+			TotalReceiveTimeMillis int `json:"total_receive_time_millis"`
+			OngoingCount           int `json:"ongoing_count"`
+		} `json:"warmer,omitempty"`
 	} `json:"merges"`
 	Refresh struct {
 		Total                     int `json:"total"`
@@ -311,6 +322,19 @@ type NodesStatsIndices struct {
 		CurrentAsTarget      int `json:"current_as_target"`
 		ThrottleTimeInMillis int `json:"throttle_time_in_millis"`
 	} `json:"recovery"`
+	// StatusCounter field added in OpenSearch 3.4.0+
+	StatusCounter *struct {
+		DocStatus struct {
+			Success       int `json:"success"`
+			UserError     int `json:"user_error"`
+			SystemFailure int `json:"system_failure"`
+		} `json:"doc_status"`
+		SearchResponseStatus struct {
+			Success       int `json:"success"`
+			UserError     int `json:"user_error"`
+			SystemFailure int `json:"system_failure"`
+		} `json:"search_response_status"`
+	} `json:"status_counter,omitempty"`
 }
 
 // NodesStatsOS is a sub type of NodesStats representing operating system information of the node

Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,8 @@ type CatThreadPoolItemResp struct {`
`68`	`68`	Size *int `json:"size,string"`
`69`	`69`	KeepAlive *string `json:"keep_alive"`
`70`	`70`	TotalWaitTime string `json:"total_wait_time"`
	`71`	`+ // Parallelism field added in OpenSearch 3.4.0+`
	`72`	+ Parallelism *int `json:"parallelism,string"`
`71`	`73`	`}`
`72`	`74`
`73`	`75`	`// Inspect returns the Inspect type containing the raw *opensearch.Response`