elastic / elasticsearch

Free and Open Source, Distributed, RESTful Search Engine
https://www.elastic.co/products/elasticsearch
Other
69.94k stars 24.74k forks source link

[Docs] Node Stats - Byte field types do NOT return in API #85969

Closed stefnestor closed 2 years ago

stefnestor commented 2 years ago

👋🏼 The Node Stats API is not returning type:bytes JSON response fields starting in v8.0 or v8.1. (Confirmed returning in 7.13, 7.14, 7.16, 7.17.) Multiple/all fields with "byte value" are effected.

Node Stats API v8.1 ``` { "_nodes": { "failed": 0, "successful": 1, "total": 1 }, "cluster_name": "d176278892854f9c818e238ebe929f57", "nodes": { "SXVjUW5LRieDSdC41cKAUg": { "adaptive_selection": { "SXVjUW5LRieDSdC41cKAUg": { "avg_queue_size": 0, "avg_response_time_ns": 1053392, "avg_service_time_ns": 1073947, "outgoing_searches": 0, "rank": "1.1" } }, "attributes": { "availability_zone": "us-central1-c", "data": "hot", "instance_configuration": "gcp.es.datahot.n2.68x10x45", "logical_availability_zone": "zone-0", "region": "unknown-region", "server_name": "instance-0000000003.d176278892854f9c818e238ebe929f57", "xpack.installed": "true" }, "breakers": { "eql_sequence": { "estimated_size": "0b", "estimated_size_in_bytes": 0, "limit_size": "1gb", "limit_size_in_bytes": 1073741824, "overhead": 1, "tripped": 0 }, "fielddata": { "estimated_size": "0b", "estimated_size_in_bytes": 0, "limit_size": "819.1mb", "limit_size_in_bytes": 858993459, "overhead": 1.03, "tripped": 0 }, "inflight_requests": { "estimated_size": "0b", "estimated_size_in_bytes": 0, "limit_size": "2gb", "limit_size_in_bytes": 2147483648, "overhead": 2, "tripped": 0 }, "model_inference": { "estimated_size": "0b", "estimated_size_in_bytes": 0, "limit_size": "1gb", "limit_size_in_bytes": 1073741824, "overhead": 1, "tripped": 0 }, "parent": { "estimated_size": "1gb", "estimated_size_in_bytes": 1096897024, "limit_size": "1.8gb", "limit_size_in_bytes": 2040109465, "overhead": 1, "tripped": 0 }, "request": { "estimated_size": "0b", "estimated_size_in_bytes": 0, "limit_size": "1.1gb", "limit_size_in_bytes": 1288490188, "overhead": 1, "tripped": 0 } }, "discovery": { "cluster_applier_stats": { "recordings": [ ... ] }, "cluster_state_queue": { "committed": 0, "pending": 0, "total": 0 }, "cluster_state_update": { "failure": { "commit_time_millis": 0, "completion_time_millis": 0, "computation_time_millis": 0, "context_construction_time_millis": 0, "count": 0, "master_apply_time_millis": 0, "notification_time_millis": 0, "publication_time_millis": 0 }, "success": { "commit_time_millis": 231, "completion_time_millis": 245, "computation_time_millis": 69, "context_construction_time_millis": 13, "count": 20, "master_apply_time_millis": 142, "notification_time_millis": 11, "publication_time_millis": 421 }, "unchanged": { "computation_time_millis": 24, "count": 9, "notification_time_millis": 1 } }, "published_cluster_states": { "compatible_diffs": 140, "full_states": 1, "incompatible_diffs": 0 }, "serialized_cluster_states": { "diffs": { "compressed_size_in_bytes": 11677, "count": 20, "uncompressed_size_in_bytes": 22341 }, "full_states": { "compressed_size_in_bytes": 0, "count": 0, "uncompressed_size_in_bytes": 0 } } }, "fs": { "data": [ { "available_in_bytes": 193208057856, "free_in_bytes": 193208057856, "mount": "/app (/dev/mapper/lxc-data)", "path": "/app/data", "total_in_bytes": 193273528320, "type": "xfs" } ], "io_stats": { "devices": [ { "device_name": "dm-1", "io_time_in_millis": 7152, "operations": 20361, "read_kilobytes": 468, "read_operations": 58, "write_kilobytes": 284356, "write_operations": 20303 } ], "total": { "io_time_in_millis": 7152, "operations": 20361, "read_kilobytes": 468, "read_operations": 58, "write_kilobytes": 284356, "write_operations": 20303 } }, "timestamp": 1650312366053, "total": { "available_in_bytes": 193208057856, "free_in_bytes": 193208057856, "total_in_bytes": 193273528320 } }, "host": "10.42.9.23", "http": { "clients": [ ... ], "current_open": 71, "total_opened": 78 }, "indexing_pressure": { "memory": { "current": { "all_in_bytes": 0, "combined_coordinating_and_primary_in_bytes": 0, "coordinating_in_bytes": 0, "primary_in_bytes": 0, "replica_in_bytes": 0 }, "limit_in_bytes": 214748364, "total": { "all_in_bytes": 202002, "combined_coordinating_and_primary_in_bytes": 168672, "coordinating_in_bytes": 160116, "coordinating_rejections": 0, "primary_in_bytes": 156860, "primary_rejections": 0, "replica_in_bytes": 33330, "replica_rejections": 0 } } }, "indices": { "bulk": { "avg_size_in_bytes": 808, "avg_time_in_millis": 0, "total_operations": 133, "total_size_in_bytes": 128550, "total_time_in_millis": 301 }, "completion": { "size_in_bytes": 0 }, "docs": { "count": 42256, "deleted": 264 }, "fielddata": { "evictions": 0, "memory_size_in_bytes": 0 }, "flush": { "periodic": 0, "total": 7, "total_time_in_millis": 39 }, "get": { "current": 0, "exists_time_in_millis": 49, "exists_total": 128, "missing_time_in_millis": 0, "missing_total": 5, "time_in_millis": 49, "total": 133 }, "indexing": { "delete_current": 0, "delete_time_in_millis": 0, "delete_total": 0, "index_current": 0, "index_failed": 0, "index_time_in_millis": 221, "index_total": 219, "is_throttled": false, "noop_update_total": 0, "throttle_time_in_millis": 0 }, "merges": { "current": 0, "current_docs": 0, "current_size_in_bytes": 0, "total": 13, "total_auto_throttle_in_bytes": 838860800, "total_docs": 24620, "total_size_in_bytes": 4049366, "total_stopped_time_in_millis": 0, "total_throttled_time_in_millis": 0, "total_time_in_millis": 296 }, "query_cache": { "cache_count": 0, "cache_size": 0, "evictions": 0, "hit_count": 0, "memory_size_in_bytes": 0, "miss_count": 0, "total_count": 0 }, "recovery": { "current_as_source": 0, "current_as_target": 0, "throttle_time_in_millis": 1111 }, "refresh": { "external_total": 178, "external_total_time_in_millis": 1169, "listeners": 0, "total": 230, "total_time_in_millis": 1231 }, "request_cache": { "evictions": 0, "hit_count": 183, "memory_size_in_bytes": 592, "miss_count": 1 }, "search": { "fetch_current": 0, "fetch_time_in_millis": 50, "fetch_total": 461, "open_contexts": 0, "query_current": 0, "query_time_in_millis": 457, "query_total": 461, "scroll_current": 0, "scroll_time_in_millis": 1208, "scroll_total": 128, "suggest_current": 0, "suggest_time_in_millis": 0, "suggest_total": 0 }, "segments": { "count": 76, "doc_values_memory_in_bytes": 0, "file_sizes": {}, "fixed_bit_set_memory_in_bytes": 4400, "index_writer_memory_in_bytes": 358156, "max_unsafe_auto_id_timestamp": 1650312125255, "memory_in_bytes": 0, "norms_memory_in_bytes": 0, "points_memory_in_bytes": 0, "stored_fields_memory_in_bytes": 0, "term_vectors_memory_in_bytes": 0, "terms_memory_in_bytes": 0, "version_map_memory_in_bytes": 0 }, "shard_stats": { "total_count": 22 }, "store": { "reserved_in_bytes": 0, "size_in_bytes": 60432487, "total_data_set_size_in_bytes": 60432487 }, "translog": { "earliest_last_modified_age": 1972, "operations": 177, "size_in_bytes": 121551, "uncommitted_operations": 177, "uncommitted_size_in_bytes": 121551 }, "warmer": { "current": 0, "total": 100, "total_time_in_millis": 24 } }, "ingest": { "pipelines": { ... }, "total": { "count": 0, "current": 0, "failed": 0, "time_in_millis": 0 } }, "ip": "10.42.9.23:19480", "jvm": { "buffer_pools": { "direct": { "count": 36, "total_capacity_in_bytes": 2509340, "used_in_bytes": 2509342 }, "mapped": { "count": 160, "total_capacity_in_bytes": 9164241, "used_in_bytes": 9164241 }, "mapped - 'non-volatile memory'": { "count": 0, "total_capacity_in_bytes": 0, "used_in_bytes": 0 } }, "classes": { "current_loaded_count": 31939, "total_loaded_count": 31957, "total_unloaded_count": 18 }, "gc": { "collectors": { "old": { "collection_count": 0, "collection_time_in_millis": 0 }, "young": { "collection_count": 13, "collection_time_in_millis": 278 } } }, "mem": { "heap_committed_in_bytes": 2147483648, "heap_max_in_bytes": 2147483648, "heap_used_in_bytes": 1096897024, "heap_used_percent": 51, "non_heap_committed_in_bytes": 225771520, "non_heap_used_in_bytes": 221756584, "pools": { "old": { "max_in_bytes": 2147483648, "peak_max_in_bytes": 2147483648, "peak_used_in_bytes": 121721344, "used_in_bytes": 121721344 }, "survivor": { "max_in_bytes": 0, "peak_max_in_bytes": 0, "peak_used_in_bytes": 58075104, "used_in_bytes": 10485760 }, "young": { "max_in_bytes": 0, "peak_max_in_bytes": 0, "peak_used_in_bytes": 964689920, "used_in_bytes": 964689920 } } }, "threads": { "count": 60, "peak_count": 62 }, "timestamp": 1650312366053, "uptime_in_millis": 256507 }, "name": "instance-0000000003", "os": { "cgroup": { "cpu": { "cfs_period_micros": 100000, "cfs_quota_micros": 250000, "control_group": "/", "stat": { "number_of_elapsed_periods": 1835, "number_of_times_throttled": 35, "time_throttled_nanos": 4595071297 } }, "cpuacct": { "control_group": "/", "usage_nanos": 89411630605 }, "memory": { "control_group": "/", "limit_in_bytes": "4294967296", "usage_in_bytes": "2723307520" } }, "cpu": { "load_average": { "15m": 0.54, "1m": 0.41, "5m": 0.51 }, "percent": 5 }, "mem": { "adjusted_total_in_bytes": 4294967296, "free_in_bytes": 1571659776, "free_percent": 37, "total_in_bytes": 4294967296, "used_in_bytes": 2723307520, "used_percent": 63 }, "swap": { "free_in_bytes": 0, "total_in_bytes": 0, "used_in_bytes": 0 }, "timestamp": 1650312366052 }, "process": { "cpu": { "percent": 5, "total_in_millis": 82760 }, "max_file_descriptors": 1048576, "mem": { "total_virtual_in_bytes": 9113636864 }, "open_file_descriptors": 555, "timestamp": 1650312366052 }, "roles": [ "data_content", "data_hot", "ingest", "master", "remote_cluster_client", "transform" ], "script": { "cache_evictions": 0, "compilation_limit_triggered": 0, "compilations": 9, "compilations_history": { "15m": 9, "24h": 9, "5m": 9 }, "contexts": [] }, "script_cache": { "sum": { "cache_evictions": 0, "compilation_limit_triggered": 0, "compilations": 9 } }, "thread_pool": { ... }, "timestamp": 1650312366044, "transport": { "inbound_handling_time_histogram": [ ... ], "outbound_handling_time_histogram": [ ... ], "rx_count": 1863, "rx_size_in_bytes": 42309730, "server_open": 0, "total_outbound_connections": 6, "tx_count": 1863, "tx_size_in_bytes": 1564661 }, "transport_address": "10.42.9.23:19480" } } } ```
Example response fields NOT returning ``` nodes.fs.total.available nodes.fs.total.free nodes.fs.total.total nodes.indices.completion.size nodes.indices.fielddata.memory_size nodes.indices.flush.total_time nodes.indices.get.exists_time nodes.indices.get.getTime nodes.indices.get.missing_time nodes.indices.indexing.delete_time nodes.indices.indexing.index_time nodes.indices.indexing.throttle_time nodes.indices.merges.current_size nodes.indices.merges.total_auto_throttle nodes.indices.merges.total_size nodes.indices.merges.total_throttled_time nodes.indices.merges.total_time nodes.indices.query_cache.memory_size nodes.indices.recovery.throttle_time nodes.indices.refresh.external_total_time nodes.indices.refresh.total_time nodes.indices.request_cache.memory_size nodes.indices.search.fetch_time nodes.indices.search.query_time nodes.indices.search.scroll_time nodes.indices.search.suggest_time nodes.indices.segments.doc_values_memory nodes.indices.segments.file_sizes.description nodes.indices.segments.file_sizes.size nodes.indices.segments.fixed_bit_set_memory nodes.indices.segments.index_writer_memory nodes.indices.segments.memory nodes.indices.segments.norms_memory nodes.indices.segments.points_memory nodes.indices.segments.stored_fields_memory nodes.indices.segments.term_vectors_memory nodes.indices.segments.terms_memory nodes.indices.segments.version_map_memory nodes.indices.translog.size nodes.indices.translog.uncommitted_size nodes.indices.warmer.total_time nodes.jvm.buffer_pools.direct.total_capacity nodes.jvm.buffer_pools.direct.used nodes.jvm.buffer_pools.mapped.total_capacity nodes.jvm.buffer_pools.mapped.used nodes.jvm.gc.collectors.old.collection_time nodes.jvm.gc.collectors.young.collection_time nodes.jvm.mem.heap_committed nodes.jvm.mem.heap_max nodes.jvm.mem.heap_used nodes.jvm.mem.non_heap_committed nodes.jvm.mem.non_heap_used nodes.jvm.mem.pools.old.max nodes.jvm.mem.pools.old.peak_max nodes.jvm.mem.pools.old.peak_used nodes.jvm.mem.pools.old.used nodes.jvm.mem.pools.survivor.max nodes.jvm.mem.pools.survivor.peak_max nodes.jvm.mem.pools.survivor.peak_used_in nodes.jvm.mem.pools.survivor.used nodes.jvm.mem.pools.young.max nodes.jvm.mem.pools.young.peak_max nodes.jvm.mem.pools.young.peak_used nodes.jvm.mem.pools.young.used nodes.jvm.uptime nodes.os.mem.adjusted_total nodes.os.mem.free nodes.os.mem.total nodes.os.mem.used nodes.os.swap.free nodes.os.swap.total nodes.os.swap.used nodes.process.cpu.total nodes.process.mem.total_virtual ```

As narrowed problem example, response body > store doesn’t seem to return [size, total_data_set_size, reserved] byte-type fields, but do still return their corresponding integer fields.

"store": {
    "reserved_in_bytes": 0,
    "size_in_bytes": 60432487,
    "total_data_set_size_in_bytes": 60432487 }
elasticmachine commented 2 years ago

Pinging @elastic/es-docs (Team:Docs)

kunisen commented 2 years ago

hi @stefnestor cc @jtibshirani

My test results showed that, it seems we need to add ?human to make the target fields visible.

GET test-cold-index-1/_stats/store

      "store" : {
        "size_in_bytes" : 4377,
        "total_data_set_size_in_bytes" : 4377,
        "reserved_in_bytes" : 0
      }
    }
GET test-cold-index-1/_stats/store?human

      "store" : {
        "size" : "4.2kb",
        "size_in_bytes" : 4377,
        "total_data_set_size" : "4.2kb",
        "total_data_set_size_in_bytes" : 4377,
        "reserved" : "0b",
        "reserved_in_bytes" : 0
      }
    }

I think it's a doc bug at least, while we state the human parameter in i.e. following docs for datastream, https://www.elastic.co/guide/en/elasticsearch/reference/8.1/data-stream-stats-api.html

we don't seem to state this parameter (and it's default value is false) for index/node stats API https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html

elasticmachine commented 2 years ago

Pinging @elastic/es-data-management (Team:Data Management)