@@ -140,6 +140,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes]
140
140
[[cluster-nodes-stats-api-response-body-indices]]
141
141
===== `indices` section
142
142
143
+ [%collapsible]
144
+ ====
143
145
`indices.docs.count`::
144
146
(integer)
145
147
include::{docdir}/rest-api/common-parms.asciidoc[tag=docs-count]
@@ -536,97 +538,13 @@ that used an index shard as a target.
536
538
(integer)
537
539
Time in milliseconds
538
540
recovery operations were delayed due to throttling.
539
-
540
- [[cluster-nodes-stats-api-response-body-fs]]
541
- ===== `fs` section
542
-
543
- `fs.timestamp`::
544
- Last time the file stores statistics have been refreshed.
545
-
546
- `fs.total.total_in_bytes`::
547
- Total size (in bytes) of all file stores.
548
-
549
- `fs.total.free_in_bytes`::
550
- Total number of unallocated bytes in all file stores.
551
-
552
- `fs.total.available_in_bytes`::
553
- Total number of bytes available to this Java virtual machine on all file
554
- stores. Depending on OS or process level restrictions, this might appear
555
- less than `fs.total.free_in_bytes`. This is the actual amount of free disk
556
- space the {es} node can utilise.
557
-
558
- `fs.data`::
559
- List of all file stores.
560
-
561
- `fs.data.path`::
562
- Path to the file store.
563
-
564
- `fs.data.mount`::
565
- Mount point of the file store (ex: /dev/sda2).
566
-
567
- `fs.data.type`::
568
- Type of the file store (ex: ext4).
569
-
570
- `fs.data.total_in_bytes`::
571
- Total size (in bytes) of the file store.
572
-
573
- `fs.data.free_in_bytes`::
574
- Total number of unallocated bytes in the file store.
575
-
576
- `fs.data.available_in_bytes`::
577
- Total number of bytes available to this Java virtual machine on this file
578
- store.
579
-
580
- `fs.io_stats.devices` (Linux only)::
581
- Array of disk metrics for each device that is backing an {es} data path.
582
- These disk metrics are probed periodically and averages between the last
583
- probe and the current probe are computed.
584
-
585
- `fs.io_stats.devices.device_name` (Linux only)::
586
- The Linux device name.
587
-
588
- `fs.io_stats.devices.operations` (Linux only)::
589
- The total number of read and write operations for the device completed since
590
- starting {es}.
591
-
592
- `fs.io_stats.devices.read_operations` (Linux only)::
593
- The total number of read operations for the device completed since starting
594
- {es}.
595
-
596
- `fs.io_stats.devices.write_operations` (Linux only)::
597
- The total number of write operations for the device completed since starting
598
- {es}.
599
-
600
- `fs.io_stats.devices.read_kilobytes` (Linux only)::
601
- The total number of kilobytes read for the device since starting {es}.
602
-
603
- `fs.io_stats.devices.write_kilobytes` (Linux only)::
604
- The total number of kilobytes written for the device since starting {es}.
605
-
606
- `fs.io_stats.operations` (Linux only)::
607
- The total number of read and write operations across all devices used by
608
- {es} completed since starting {es}.
609
-
610
- `fs.io_stats.read_operations` (Linux only)::
611
- The total number of read operations for across all devices used by {es}
612
- completed since starting {es}.
613
-
614
- `fs.io_stats.write_operations` (Linux only)::
615
- The total number of write operations across all devices used by {es}
616
- completed since starting {es}.
617
-
618
- `fs.io_stats.read_kilobytes` (Linux only)::
619
- The total number of kilobytes read across all devices used by {es} since
620
- starting {es}.
621
-
622
- `fs.io_stats.write_kilobytes` (Linux only)::
623
- The total number of kilobytes written across all devices used by {es} since
624
- starting {es}.
625
-
541
+ ====
626
542
627
543
[[cluster-nodes-stats-api-response-body-os]]
628
544
===== `os` section
629
545
546
+ [%collapsible]
547
+ ====
630
548
`os.timestamp`::
631
549
Last time the operating system statistics have been refreshed.
632
550
@@ -720,10 +638,13 @@ recovery operations were delayed due to throttling.
720
638
NOTE: For the cgroup stats to be visible, cgroups must be compiled into the
721
639
kernel, the `cpu` and `cpuacct` cgroup subsystems must be configured and stats
722
640
must be readable from `/sys/fs/cgroup/cpu` and `/sys/fs/cgroup/cpuacct`.
641
+ ====
723
642
724
643
[[cluster-nodes-stats-api-response-body-process]]
725
644
===== `process` section
726
645
646
+ [%collapsible]
647
+ ====
727
648
`process.timestamp`::
728
649
Last time the process statistics have been refreshed.
729
650
@@ -745,10 +666,13 @@ must be readable from `/sys/fs/cgroup/cpu` and `/sys/fs/cgroup/cpuacct`.
745
666
`process.mem.total_virtual_in_bytes`::
746
667
Size in bytes of virtual memory that is guaranteed to be available to the
747
668
running process.
669
+ ====
748
670
749
671
[[cluster-nodes-stats-api-response-body-jvm]]
750
672
===== `jvm` section
751
673
674
+ [%collapsible]
675
+ ====
752
676
`jvm.timestamp`::
753
677
(integer)
754
678
Last time JVM statistics were refreshed.
@@ -894,10 +818,13 @@ Total number of buffer pool classes loaded since the JVM started.
894
818
`jvm.classes.total_unloaded_count`::
895
819
(integer)
896
820
Total number of buffer pool classes unloaded since the JVM started.
821
+ ====
897
822
898
823
[[cluster-nodes-stats-api-response-body-threadpool]]
899
824
===== `thread_pool` section
900
825
826
+ [%collapsible]
827
+ ====
901
828
`thread_pool.<thread_pool_name>.threads`::
902
829
(integer)
903
830
Number of threads in the thread pool.
@@ -921,10 +848,102 @@ Highest number of active threads in the thread pool.
921
848
`thread_pool.<thread_pool_name>.completed`::
922
849
(integer)
923
850
Number of tasks completed by the thread pool executor.
851
+ ====
852
+
853
+ [[cluster-nodes-stats-api-response-body-fs]]
854
+ ===== `fs` section
855
+
856
+ [%collapsible]
857
+ ====
858
+ `fs.timestamp`::
859
+ Last time the file stores statistics have been refreshed.
860
+
861
+ `fs.total.total_in_bytes`::
862
+ Total size (in bytes) of all file stores.
863
+
864
+ `fs.total.free_in_bytes`::
865
+ Total number of unallocated bytes in all file stores.
866
+
867
+ `fs.total.available_in_bytes`::
868
+ Total number of bytes available to this Java virtual machine on all file
869
+ stores. Depending on OS or process level restrictions, this might appear
870
+ less than `fs.total.free_in_bytes`. This is the actual amount of free disk
871
+ space the {es} node can utilise.
872
+
873
+ `fs.data`::
874
+ List of all file stores.
875
+
876
+ `fs.data.path`::
877
+ Path to the file store.
878
+
879
+ `fs.data.mount`::
880
+ Mount point of the file store (ex: /dev/sda2).
881
+
882
+ `fs.data.type`::
883
+ Type of the file store (ex: ext4).
884
+
885
+ `fs.data.total_in_bytes`::
886
+ Total size (in bytes) of the file store.
887
+
888
+ `fs.data.free_in_bytes`::
889
+ Total number of unallocated bytes in the file store.
890
+
891
+ `fs.data.available_in_bytes`::
892
+ Total number of bytes available to this Java virtual machine on this file
893
+ store.
894
+
895
+ `fs.io_stats.devices` (Linux only)::
896
+ Array of disk metrics for each device that is backing an {es} data path.
897
+ These disk metrics are probed periodically and averages between the last
898
+ probe and the current probe are computed.
899
+
900
+ `fs.io_stats.devices.device_name` (Linux only)::
901
+ The Linux device name.
902
+
903
+ `fs.io_stats.devices.operations` (Linux only)::
904
+ The total number of read and write operations for the device completed since
905
+ starting {es}.
906
+
907
+ `fs.io_stats.devices.read_operations` (Linux only)::
908
+ The total number of read operations for the device completed since starting
909
+ {es}.
910
+
911
+ `fs.io_stats.devices.write_operations` (Linux only)::
912
+ The total number of write operations for the device completed since starting
913
+ {es}.
914
+
915
+ `fs.io_stats.devices.read_kilobytes` (Linux only)::
916
+ The total number of kilobytes read for the device since starting {es}.
917
+
918
+ `fs.io_stats.devices.write_kilobytes` (Linux only)::
919
+ The total number of kilobytes written for the device since starting {es}.
920
+
921
+ `fs.io_stats.operations` (Linux only)::
922
+ The total number of read and write operations across all devices used by
923
+ {es} completed since starting {es}.
924
+
925
+ `fs.io_stats.read_operations` (Linux only)::
926
+ The total number of read operations for across all devices used by {es}
927
+ completed since starting {es}.
928
+
929
+ `fs.io_stats.write_operations` (Linux only)::
930
+ The total number of write operations across all devices used by {es}
931
+ completed since starting {es}.
932
+
933
+ `fs.io_stats.read_kilobytes` (Linux only)::
934
+ The total number of kilobytes read across all devices used by {es} since
935
+ starting {es}.
936
+
937
+ `fs.io_stats.write_kilobytes` (Linux only)::
938
+ The total number of kilobytes written across all devices used by {es} since
939
+ starting {es}.
940
+ ====
924
941
925
942
[[cluster-nodes-stats-api-response-body-transport]]
926
943
===== `transport` section
927
944
945
+ [%collapsible]
946
+ ====
928
947
`transport.server_open`::
929
948
(integer)
930
949
Number of open TCP connections used for internal communication between nodes.
@@ -948,21 +967,27 @@ communication.
948
967
(integer)
949
968
Size, in bytes, of TX packets sent by the node during internal cluster
950
969
communication.
970
+ ====
951
971
952
972
[[cluster-nodes-stats-api-response-body-http]]
953
973
===== `http` section
954
974
975
+ [%collapsible]
976
+ ====
955
977
`http.current_open`::
956
978
(integer)
957
979
Current number of open HTTP connections for the node.
958
980
959
981
`http.total_opened`::
960
982
(integer)
961
983
Total number of HTTP connections opened for the node.
984
+ ====
962
985
963
986
[[cluster-nodes-stats-api-response-body-breakers]]
964
987
===== `breakers` section
965
988
989
+ [%collapsible]
990
+ ====
966
991
`breakers.<circuit_breaker_name>.limit_size_in_bytes`::
967
992
(integer)
968
993
Memory limit, in bytes, for the circuit breaker.
@@ -988,10 +1013,13 @@ calculate a final estimate.
988
1013
(integer)
989
1014
Total number of times the circuit breaker has been triggered and prevented an
990
1015
out of memory error.
1016
+ ====
991
1017
992
1018
[[cluster-nodes-stats-api-response-body-script]]
993
1019
===== `script` section
994
1020
1021
+ [%collapsible]
1022
+ ====
995
1023
`script.compilations`::
996
1024
(integer)
997
1025
Total number of inline script compilations performed by the node.
@@ -1004,10 +1032,13 @@ Total number of times the script cache has evicted old data.
1004
1032
(integer)
1005
1033
Total number of times the <<script-compilation-circuit-breaker,script
1006
1034
compilation>> circuit breaker has limited inline script compilations.
1035
+ ====
1007
1036
1008
1037
[[cluster-nodes-stats-api-response-body-discovery]]
1009
1038
===== `discovery` section
1010
1039
1040
+ [%collapsible]
1041
+ ====
1011
1042
`discovery.cluster_state_queue.total`::
1012
1043
(integer)
1013
1044
Total number of cluster states in queue.
@@ -1031,10 +1062,13 @@ Number of incompatible differences between published cluster states.
1031
1062
`discovery.published_cluster_states.compatible_diffs`::
1032
1063
(integer)
1033
1064
Number of compatible differences between published cluster states.
1065
+ ====
1034
1066
1035
1067
[[cluster-nodes-stats-api-response-body-ingest]]
1036
1068
===== `ingest` section
1037
1069
1070
+ [%collapsible]
1071
+ ====
1038
1072
`ingest.total.count`::
1039
1073
(integer)
1040
1074
Total number of documents ingested during the lifetime of this node.
@@ -1079,10 +1113,13 @@ Number of compatible differences between published cluster states.
1079
1113
`ingest.pipelines.<pipeline_id>.<processor>.failed`::
1080
1114
(integer)
1081
1115
Number of failed operations for the processor.
1116
+ ====
1082
1117
1083
1118
[[cluster-nodes-stats-api-response-body-adaptive-selection]]
1084
1119
===== `adaptive_selection` section
1085
1120
1121
+ [%collapsible]
1122
+ ====
1086
1123
The `adaptive_selection` statistics are keyed by node. For each node:
1087
1124
1088
1125
`adaptive_selection.outgoing_searches`::
@@ -1104,6 +1141,7 @@ The `adaptive_selection` statistics are keyed by node. For each node:
1104
1141
`rank`::
1105
1142
The rank of this node; used for shard selection when routing search
1106
1143
requests.
1144
+ ====
1107
1145
1108
1146
1109
1147
[[cluster-nodes-stats-api-example]]
0 commit comments