From f43249ef6f8a80ff6f3ae1f8eacdd82f5a089605 Mon Sep 17 00:00:00 2001 From: Jakob Hahn Date: Wed, 11 Sep 2024 11:28:08 +0200 Subject: [PATCH] spec: rename Bytes to ByteCount Signed-off-by: Jakob Hahn --- spec/namespaces/indices.yaml | 2 +- spec/schemas/_common.yaml | 73 +++++++-------- spec/schemas/cluster.allocation_explain.yaml | 10 +-- spec/schemas/cluster.stats.yaml | 36 ++++---- spec/schemas/indices.data_streams_stats.yaml | 2 +- spec/schemas/indices.recovery.yaml | 8 +- spec/schemas/indices.rollover.yaml | 8 +- spec/schemas/indices.segments.yaml | 4 +- spec/schemas/indices.stats.yaml | 8 +- spec/schemas/nodes._common.yaml | 94 ++++++++++---------- spec/schemas/nodes.info.yaml | 18 ++-- spec/schemas/snapshot._common.yaml | 6 +- 12 files changed, 135 insertions(+), 134 deletions(-) diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml index e3e0926f..4dcf6d39 100644 --- a/spec/namespaces/indices.yaml +++ b/spec/namespaces/indices.yaml @@ -2388,7 +2388,7 @@ components: $ref: '../schemas/_common.yaml#/components/schemas/StorageSize' total_store_size_bytes: description: Total size, in bytes, of all shards for the selected data streams. - $ref: '../schemas/_common.yaml#/components/schemas/Bytes' + $ref: '../schemas/_common.yaml#/components/schemas/ByteCount' required: - _shards - backing_indices diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml index 551efa82..218ce6f4 100644 --- a/spec/schemas/_common.yaml +++ b/spec/schemas/_common.yaml @@ -742,8 +742,9 @@ components: - pb - t - tb - Bytes: + ByteCount: type: integer + format: int64 Percentage: oneOf: - type: string @@ -928,7 +929,7 @@ components: properties: size_in_bytes: description: Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' size: $ref: '#/components/schemas/StorageSize' fields: @@ -943,7 +944,7 @@ components: size: $ref: '#/components/schemas/StorageSize' size_in_bytes: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' required: - size_in_bytes DocStats: @@ -970,7 +971,7 @@ components: memory_size: $ref: '#/components/schemas/StorageSize' memory_size_in_bytes: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' fields: type: object additionalProperties: @@ -983,7 +984,7 @@ components: memory_size: $ref: '#/components/schemas/StorageSize' memory_size_in_bytes: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' required: - memory_size_in_bytes QueryCacheStats: @@ -1007,7 +1008,7 @@ components: $ref: '#/components/schemas/StorageSize' memory_size_in_bytes: description: Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' miss_count: description: Total count of query cache misses across all shards assigned to selected nodes. type: number @@ -1077,19 +1078,19 @@ components: $ref: '#/components/schemas/StorageSize' failed_bytes: description: The number of bytes that failed to upload to the remote translog store. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' started: description: The number of bytes successfully uploaded to the remote translog store. $ref: '#/components/schemas/StorageSize' started_bytes: description: The number of bytes successfully uploaded to the remote translog store. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' succeeded: description: The number of bytes successfully uploaded to the remote translog store. $ref: '#/components/schemas/StorageSize' succeeded_bytes: description: The number of bytes successfully uploaded to the remote translog store. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' required: - failed_bytes - started_bytes @@ -1131,19 +1132,19 @@ components: $ref: '#/components/schemas/StorageSize' failed_bytes: description: The number of bytes that failed to upload/upload to/from the remote segment store. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' started: description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started. $ref: '#/components/schemas/StorageSize' started_bytes: description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' succeeded: description: The number of bytes successfully uploaded/downloaded to/from the remote segment store. $ref: '#/components/schemas/StorageSize' succeeded_bytes: description: The number of bytes successfully uploaded/downloaded to/from the remote segment store. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' required: - failed_bytes - started_bytes @@ -1166,13 +1167,13 @@ components: $ref: '#/components/schemas/StorageSize' max_bytes: description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' total: description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store. $ref: '#/components/schemas/StorageSize' total_bytes: description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' required: - max_bytes - total_bytes @@ -1196,11 +1197,11 @@ components: type: object properties: max_bytes_behind: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' max_replication_lag: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' total_bytes_behind: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' required: - max_bytes_behind - max_replication_lag @@ -1215,7 +1216,7 @@ components: $ref: '#/components/schemas/StorageSize' doc_values_memory_in_bytes: description: Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' file_sizes: description: |- This object is not populated by the cluster stats API. @@ -1227,14 +1228,14 @@ components: $ref: '#/components/schemas/StorageSize' fixed_bit_set_memory_in_bytes: description: Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' index_writer_memory: $ref: '#/components/schemas/StorageSize' index_writer_max_memory_in_bytes: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' index_writer_memory_in_bytes: description: Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' max_unsafe_auto_id_timestamp: description: Unix timestamp, in milliseconds, of the most recently retried indexing request. type: number @@ -1243,43 +1244,43 @@ components: $ref: '#/components/schemas/StorageSize' memory_in_bytes: description: Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' norms_memory: description: Total amount of memory used for normalization factors across all shards assigned to selected nodes. $ref: '#/components/schemas/StorageSize' norms_memory_in_bytes: description: Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' points_memory: description: Total amount of memory used for points across all shards assigned to selected nodes. $ref: '#/components/schemas/StorageSize' points_memory_in_bytes: description: Total amount, in bytes, of memory used for points across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' stored_fields_memory: description: Total amount of memory used for stored fields across all shards assigned to selected nodes. $ref: '#/components/schemas/StorageSize' stored_fields_memory_in_bytes: description: Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' terms_memory: description: Total amount of memory used for terms across all shards assigned to selected nodes. $ref: '#/components/schemas/StorageSize' terms_memory_in_bytes: description: Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' term_vectors_memory: description: Total amount of memory used for term vectors across all shards assigned to selected nodes. $ref: '#/components/schemas/StorageSize' term_vectors_memory_in_bytes: description: Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' version_map_memory: description: Total amount of memory used by all version maps across all shards assigned to selected nodes. $ref: '#/components/schemas/StorageSize' version_map_memory_in_bytes: description: Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' remote_store: $ref: '#/components/schemas/RemoteStoreStats' segment_replication: @@ -1305,12 +1306,12 @@ components: $ref: '#/components/schemas/StorageSize' size_in_bytes: description: Total size, in bytes, of all shards assigned to selected nodes. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' reserved: $ref: '#/components/schemas/StorageSize' reserved_in_bytes: description: A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' required: - reserved_in_bytes - size_in_bytes @@ -1626,19 +1627,19 @@ components: current_size: $ref: '#/components/schemas/StorageSize' current_size_in_bytes: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' total: type: number total_auto_throttle: $ref: '#/components/schemas/StorageSize' total_auto_throttle_in_bytes: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' total_docs: type: number total_size: $ref: '#/components/schemas/StorageSize' total_size_in_bytes: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' total_stopped_time: $ref: '#/components/schemas/Duration' total_stopped_time_in_millis: @@ -1712,7 +1713,7 @@ components: memory_size: $ref: '#/components/schemas/StorageSize' memory_size_in_bytes: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' miss_count: type: number required: @@ -1835,13 +1836,13 @@ components: size: $ref: '#/components/schemas/StorageSize' size_in_bytes: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' uncommitted_operations: type: number uncommitted_size: $ref: '#/components/schemas/StorageSize' uncommitted_size_in_bytes: - $ref: '#/components/schemas/Bytes' + $ref: '#/components/schemas/ByteCount' required: - earliest_last_modified_age - operations diff --git a/spec/schemas/cluster.allocation_explain.yaml b/spec/schemas/cluster.allocation_explain.yaml index ec55c7ca..09885edd 100644 --- a/spec/schemas/cluster.allocation_explain.yaml +++ b/spec/schemas/cluster.allocation_explain.yaml @@ -48,7 +48,7 @@ components: type: object additionalProperties: oneOf: - - $ref: '_common.yaml#/components/schemas/Bytes' + - $ref: '_common.yaml#/components/schemas/ByteCount' - $ref: '_common.yaml#/components/schemas/StorageSize' shard_data_set_sizes: type: object @@ -88,15 +88,15 @@ components: total: $ref: '_common.yaml#/components/schemas/StorageSize' total_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' used: $ref: '_common.yaml#/components/schemas/StorageSize' used_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' free: $ref: '_common.yaml#/components/schemas/StorageSize' free_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' free_disk_percent: type: number used_disk_percent: @@ -188,7 +188,7 @@ components: in_sync: type: boolean matching_size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' matching_sync_id: type: boolean store_exception: diff --git a/spec/schemas/cluster.stats.yaml b/spec/schemas/cluster.stats.yaml index 62e43b54..96e970c3 100644 --- a/spec/schemas/cluster.stats.yaml +++ b/spec/schemas/cluster.stats.yaml @@ -216,7 +216,7 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' total_deduplicated_mapping_size_in_bytes: description: Total size of all mappings, in bytes, after deduplication and compression. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' required: - field_types RuntimeFieldTypes: @@ -288,7 +288,7 @@ components: primary_shard_count: type: number total_primary_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' version: $ref: '_common.yaml#/components/schemas/VersionString' required: @@ -407,26 +407,26 @@ components: Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`. This is the actual amount of free disk space the selected OpenSearch nodes can use. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' free: description: Total number of unallocated bytes in file stores across all selected nodes. $ref: '_common.yaml#/components/schemas/StorageSize' free_in_bytes: description: Total number of unallocated bytes in file stores across all selected nodes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' total: description: Total size, of all file stores across all selected nodes. $ref: '_common.yaml#/components/schemas/StorageSize' total_in_bytes: description: Total size, in bytes, of all file stores across all selected nodes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' cache_reserved: description: Total size, of all cache reserved across all selected nodes. $ref: '_common.yaml#/components/schemas/StorageSize' x-version-added: '2.7' cache_reserved_in_bytes: description: Total size, in bytes, of all cache reserved across all selected nodes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' x-version-added: '2.7' required: - available_in_bytes @@ -445,7 +445,7 @@ components: current: $ref: '#/components/schemas/IndexingPressureMemorySummary' limit_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' total: $ref: '#/components/schemas/IndexingPressureMemorySummary' required: @@ -456,19 +456,19 @@ components: type: object properties: all_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' combined_coordinating_and_primary_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' coordinating_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' coordinating_rejections: type: number primary_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' primary_rejections: type: number replica_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' replica_rejections: type: number required: @@ -537,13 +537,13 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' heap_max_in_bytes: description: Maximum amount of memory, in bytes, available for use by the heap across all selected nodes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' heap_used: description: Memory currently in use by the heap across all selected nodes. $ref: '_common.yaml#/components/schemas/StorageSize' heap_used_in_bytes: description: Memory, in bytes, currently in use by the heap across all selected nodes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' required: - heap_max_in_bytes - heap_used_in_bytes @@ -645,13 +645,13 @@ components: properties: adjusted_total_in_bytes: description: Total amount, in bytes, of memory across all selected nodes, but using the value specified using the `es.total_memory_bytes` system property instead of measured total memory for those nodes where that system property was set. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' free: description: Amount, in bytes, of free physical memory across all selected nodes. $ref: '_common.yaml#/components/schemas/StorageSize' free_in_bytes: description: Amount, in bytes, of free physical memory across all selected nodes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' free_percent: description: Percentage of free physical memory across all selected nodes. type: number @@ -660,13 +660,13 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' total_in_bytes: description: Total amount, in bytes, of physical memory across all selected nodes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' used: description: Amount of physical memory in use across all selected nodes. $ref: '_common.yaml#/components/schemas/StorageSize' used_in_bytes: description: Amount, in bytes, of physical memory in use across all selected nodes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' used_percent: description: Percentage of physical memory in use across all selected nodes. type: number diff --git a/spec/schemas/indices.data_streams_stats.yaml b/spec/schemas/indices.data_streams_stats.yaml index aec96d68..c4ae2504 100644 --- a/spec/schemas/indices.data_streams_stats.yaml +++ b/spec/schemas/indices.data_streams_stats.yaml @@ -20,7 +20,7 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' store_size_bytes: description: Total size, in bytes, of all shards for the data stream's backing indices. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' required: - backing_indices - data_stream diff --git a/spec/schemas/indices.recovery.yaml b/spec/schemas/indices.recovery.yaml index c0d45547..3e384573 100644 --- a/spec/schemas/indices.recovery.yaml +++ b/spec/schemas/indices.recovery.yaml @@ -97,19 +97,19 @@ components: recovered: $ref: '_common.yaml#/components/schemas/StorageSize' recovered_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' recovered_from_snapshot: $ref: '_common.yaml#/components/schemas/StorageSize' recovered_from_snapshot_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' reused: $ref: '_common.yaml#/components/schemas/StorageSize' reused_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' total: $ref: '_common.yaml#/components/schemas/StorageSize' total_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' required: - percent - recovered_in_bytes diff --git a/spec/schemas/indices.rollover.yaml b/spec/schemas/indices.rollover.yaml index 05e73c31..251d80d7 100644 --- a/spec/schemas/indices.rollover.yaml +++ b/spec/schemas/indices.rollover.yaml @@ -22,19 +22,19 @@ components: max_size: $ref: '_common.yaml#/components/schemas/StorageSize' max_size_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' min_size: $ref: '_common.yaml#/components/schemas/StorageSize' min_size_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' max_primary_shard_size: $ref: '_common.yaml#/components/schemas/StorageSize' max_primary_shard_size_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' min_primary_shard_size: $ref: '_common.yaml#/components/schemas/StorageSize' min_primary_shard_size_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' max_primary_shard_docs: type: number min_primary_shard_docs: diff --git a/spec/schemas/indices.segments.yaml b/spec/schemas/indices.segments.yaml index c049e3ef..29490137 100644 --- a/spec/schemas/indices.segments.yaml +++ b/spec/schemas/indices.segments.yaml @@ -62,11 +62,11 @@ components: size: $ref: '_common.yaml#/components/schemas/StorageSize' size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' memory: $ref: '_common.yaml#/components/schemas/StorageSize' memory_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' committed: type: boolean search: diff --git a/spec/schemas/indices.stats.yaml b/spec/schemas/indices.stats.yaml index 6a12537b..849bcf64 100644 --- a/spec/schemas/indices.stats.yaml +++ b/spec/schemas/indices.stats.yaml @@ -14,13 +14,13 @@ components: size: $ref: '_common.yaml#/components/schemas/StorageSize' size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' min_size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' max_size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' average_size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' count: type: number required: diff --git a/spec/schemas/nodes._common.yaml b/spec/schemas/nodes._common.yaml index eb0c14f8..c6a253c2 100644 --- a/spec/schemas/nodes._common.yaml +++ b/spec/schemas/nodes._common.yaml @@ -56,7 +56,7 @@ components: type: number request_size_bytes: description: Cumulative size in bytes of all requests from this client. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' x_opaque_id: description: |- Value from the client's `x-opaque-id` HTTP header. @@ -390,7 +390,7 @@ components: size: $ref: '_common.yaml#/components/schemas/StorageSize' size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' evictions: type: number hit_count: @@ -431,13 +431,13 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' estimated_size_in_bytes: description: Estimated memory used, in bytes, for the operation. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' limit_size: description: Memory limit for the circuit breaker. $ref: '_common.yaml#/components/schemas/StorageSize' limit_size_in_bytes: description: Memory limit, in bytes, for the circuit breaker. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' overhead: description: A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. type: number @@ -469,7 +469,7 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' available_in_bytes: description: Total number of bytes available to this Java virtual machine on this file store. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' cache_reserved: x-version-added: '2.7' description: Total number of cache bytes reserved available to this Java virtual machine on this file store. @@ -477,7 +477,7 @@ components: cache_reserved_in_bytes: x-version-added: '2.7' description: Total number of cache bytes reserved available to this Java virtual machine on this file store. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' disk_queue: type: string disk_reads: @@ -485,19 +485,19 @@ components: disk_read_size: $ref: '_common.yaml#/components/schemas/StorageSize' disk_read_size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' disk_writes: type: number disk_write_size: $ref: '_common.yaml#/components/schemas/StorageSize' disk_write_size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' free: description: Total amount of unallocated disk space in the file store. $ref: '_common.yaml#/components/schemas/StorageSize' free_in_bytes: description: Total number of unallocated bytes in the file store. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' mount: description: 'Mount point of the file store (for example: `/dev/sda2`).' type: string @@ -509,7 +509,7 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' total_in_bytes: description: Total size of the file store in bytes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' type: description: 'Type of the file store (ex: ext4).' type: string @@ -527,19 +527,19 @@ components: Total number of bytes available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free_in_bytes`. This is the actual amount of free disk space the OpenSearch node can utilize. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' free: description: Total unallocated disk space in all file stores. $ref: '_common.yaml#/components/schemas/StorageSize' free_in_bytes: description: Total number of unallocated bytes in all file stores. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' total: description: Total size of all file stores. $ref: '_common.yaml#/components/schemas/StorageSize' total_in_bytes: description: Total size of all file stores in bytes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' cache_reserved: x-version-added: '2.7' description: Total size of cache bytes reserved in all file stores. @@ -547,7 +547,7 @@ components: cache_reserved_in_bytes: x-version-added: '2.7' description: Total size of cache bytes reserved in all file stores. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' IoStats: type: object properties: @@ -627,13 +627,13 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' total_capacity_in_bytes: description: Total capacity of buffer pools in bytes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' used: description: Size of buffer pools. $ref: '_common.yaml#/components/schemas/StorageSize' used_in_bytes: description: Size of buffer pools in bytes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' JvmClasses: type: object properties: @@ -674,7 +674,7 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' heap_used_in_bytes: description: Memory, in bytes, currently in use by the heap. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' heap_used_percent: description: Percentage of memory currently in use by the heap. type: number @@ -683,25 +683,25 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' heap_committed_in_bytes: description: Amount of memory, in bytes, available for use by the heap. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' heap_max: description: Maximum amount of memory available for use by the heap. $ref: '_common.yaml#/components/schemas/StorageSize' heap_max_in_bytes: description: Maximum amount of memory, in bytes, available for use by the heap. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' non_heap_used: description: Non-heap memory used. $ref: '_common.yaml#/components/schemas/StorageSize' non_heap_used_in_bytes: description: Non-heap memory used, in bytes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' non_heap_committed: description: Amount of non-heap memory available. $ref: '_common.yaml#/components/schemas/StorageSize' non_heap_committed_in_bytes: description: Amount of non-heap memory available, in bytes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' pools: description: Contains statistics about heap memory usage for the node. type: object @@ -715,25 +715,25 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' used_in_bytes: description: Memory, in bytes, used by the heap. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' max: description: Maximum amount of memory available for use by the heap. $ref: '_common.yaml#/components/schemas/StorageSize' max_in_bytes: description: Maximum amount of memory, in bytes, available for use by the heap. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' peak_used: description: Largest amount of memory historically used by the heap. $ref: '_common.yaml#/components/schemas/StorageSize' peak_used_in_bytes: description: Largest amount of memory, in bytes, historically used by the heap. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' peak_max: description: Largest amount of memory historically used by the heap. $ref: '_common.yaml#/components/schemas/StorageSize' peak_max_in_bytes: description: Largest amount of memory, in bytes, historically used by the heap. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' last_gc_stats: description: Most recent GC cycle stats for a particular memory pool. $ref: '#/components/schemas/LastGcStats' @@ -743,11 +743,11 @@ components: used: $ref: '_common.yaml#/components/schemas/StorageSize' used_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' max: $ref: '_common.yaml#/components/schemas/StorageSize' max_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' usage_percent: type: number JvmThreads: @@ -811,37 +811,37 @@ components: description: |- If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes. Otherwise it reports the same value as `total_in_bytes`. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' resident: $ref: '_common.yaml#/components/schemas/StorageSize' resident_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' share: $ref: '_common.yaml#/components/schemas/StorageSize' share_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' total_virtual: $ref: '_common.yaml#/components/schemas/StorageSize' total_virtual_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' total: description: Total amount of physical memory. $ref: '_common.yaml#/components/schemas/StorageSize' total_in_bytes: description: Total amount of physical memory in bytes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' free: description: Amount of free physical memory. $ref: '_common.yaml#/components/schemas/StorageSize' free_in_bytes: description: Amount of free physical memory in bytes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' used: description: Amount of used physical memory. $ref: '_common.yaml#/components/schemas/StorageSize' used_in_bytes: description: Amount of used physical memory in bytes. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' Cgroup: type: object properties: @@ -954,7 +954,7 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' rx_size_in_bytes: description: Size, in bytes, of RX packets received by the node during internal cluster communication. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' server_open: description: Current number of inbound TCP connections used for internal communication between nodes. type: number @@ -966,7 +966,7 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' tx_size_in_bytes: description: Size, in bytes, of TX packets sent by the node during internal cluster communication. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' total_outbound_connections: description: |- The cumulative number of outbound transport connections that this node has opened since it started. @@ -1098,11 +1098,11 @@ components: uncompressed_size: $ref: '_common.yaml#/components/schemas/StorageSize' uncompressed_size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' compressed_size: $ref: '_common.yaml#/components/schemas/StorageSize' compressed_size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' ClusterAppliedStats: type: object properties: @@ -1181,15 +1181,15 @@ components: current_max: $ref: '_common.yaml#/components/schemas/StorageSize' current_max_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' current_avg: $ref: '_common.yaml#/components/schemas/StorageSize' current_avg_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' rolling_avg: $ref: '_common.yaml#/components/schemas/StorageSize' rolling_avg_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats: type: object properties: @@ -1245,7 +1245,7 @@ components: description: |- Configured memory limit, in bytes, for the indexing requests. Replica requests have an automatic limit that is 1.5x this value. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' current: $ref: '#/components/schemas/PressureMemory' total: @@ -1257,29 +1257,29 @@ components: $ref: '_common.yaml#/components/schemas/StorageSize' all_in_bytes: description: Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' combined_coordinating_and_primary: $ref: '_common.yaml#/components/schemas/StorageSize' combined_coordinating_and_primary_in_bytes: description: |- Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' coordinating: $ref: '_common.yaml#/components/schemas/StorageSize' coordinating_in_bytes: description: Memory consumed, in bytes, by indexing requests in the coordinating stage. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' primary: $ref: '_common.yaml#/components/schemas/StorageSize' primary_in_bytes: description: Memory consumed, in bytes, by indexing requests in the primary stage. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' replica: $ref: '_common.yaml#/components/schemas/StorageSize' replica_in_bytes: description: Memory consumed, in bytes, by indexing requests in the replica stage. - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' coordinating_rejections: description: Number of indexing requests rejected in the coordinating stage. type: number diff --git a/spec/schemas/nodes.info.yaml b/spec/schemas/nodes.info.yaml index 7102b54b..fa9708a9 100644 --- a/spec/schemas/nodes.info.yaml +++ b/spec/schemas/nodes.info.yaml @@ -82,7 +82,7 @@ components: description: Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings. type: number total_indexing_buffer_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' transport: $ref: '#/components/schemas/NodeInfoTransport' transport_address: @@ -117,7 +117,7 @@ components: max_content_length: $ref: '_common.yaml#/components/schemas/StorageSize' max_content_length_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' publish_address: type: string required: @@ -172,23 +172,23 @@ components: direct_max: $ref: '_common.yaml#/components/schemas/StorageSize' direct_max_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' heap_init: $ref: '_common.yaml#/components/schemas/StorageSize' heap_init_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' heap_max: $ref: '_common.yaml#/components/schemas/StorageSize' heap_max_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' non_heap_init: $ref: '_common.yaml#/components/schemas/StorageSize' non_heap_init_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' non_heap_max: $ref: '_common.yaml#/components/schemas/StorageSize' non_heap_max_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' required: - direct_max_in_bytes - heap_init_in_bytes @@ -253,7 +253,7 @@ components: cache_size: $ref: '_common.yaml#/components/schemas/StorageSize' cache_size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' cores_per_socket: type: number mhz: @@ -281,7 +281,7 @@ components: total: $ref: '_common.yaml#/components/schemas/StorageSize' total_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' required: - total - total_in_bytes diff --git a/spec/schemas/snapshot._common.yaml b/spec/schemas/snapshot._common.yaml index f00611ec..4d39c459 100644 --- a/spec/schemas/snapshot._common.yaml +++ b/spec/schemas/snapshot._common.yaml @@ -91,7 +91,7 @@ components: size: $ref: '_common.yaml#/components/schemas/StorageSize' size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' max_segments_per_shard: type: number required: @@ -228,7 +228,7 @@ components: file_count: type: number size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' required: - file_count - size_in_bytes @@ -278,7 +278,7 @@ components: file_count: type: number size_in_bytes: - $ref: '_common.yaml#/components/schemas/Bytes' + $ref: '_common.yaml#/components/schemas/ByteCount' required: - file_count - size_in_bytes