Skip to content

Commit 7b7fec0

Browse files
jrodewigjbaiera
andcommitted
[DOCS] Document JVM node stats (#49500)
* [DOCS] Document JVM node stats Documents the `jvm` parameters returned by the `_nodes/stats` API. Co-Authored-By: James Baiera <[email protected]>
1 parent ba2dc49 commit 7b7fec0

File tree

1 file changed

+148
-1
lines changed

1 file changed

+148
-1
lines changed

docs/reference/cluster/nodes-stats.asciidoc

+148-1
Original file line numberDiff line numberDiff line change
@@ -721,7 +721,6 @@ NOTE: For the cgroup stats to be visible, cgroups must be compiled into the
721721
kernel, the `cpu` and `cpuacct` cgroup subsystems must be configured and stats
722722
must be readable from `/sys/fs/cgroup/cpu` and `/sys/fs/cgroup/cpuacct`.
723723

724-
725724
[[cluster-nodes-stats-api-response-body-process]]
726725
===== `process` section
727726

@@ -747,6 +746,154 @@ must be readable from `/sys/fs/cgroup/cpu` and `/sys/fs/cgroup/cpuacct`.
747746
Size in bytes of virtual memory that is guaranteed to be available to the
748747
running process.
749748

749+
[[cluster-nodes-stats-api-response-body-jvm]]
750+
===== `jvm` section
751+
752+
`jvm.timestamp`::
753+
(integer)
754+
Last time JVM statistics were refreshed.
755+
756+
`jvm.uptime_in_millis`::
757+
(integer)
758+
JVM uptime in milliseconds.
759+
760+
`jvm.mem.heap_used_in_bytes`::
761+
(integer)
762+
Memory, in bytes, currently in use by the heap.
763+
764+
`jvm.mem.heap_used_percent`::
765+
(integer)
766+
Percentage of memory currently in use by the heap.
767+
768+
`jvm.mem.heap_committed_in_bytes`::
769+
(integer)
770+
Amount of memory, in bytes, available for use by the heap.
771+
772+
`jvm.mem.heap_max_in_bytes`::
773+
(integer)
774+
Maximum amount of memory, in bytes, available for use by the heap.
775+
776+
`jvm.mem.non_heap_used_in_bytes`::
777+
(integer)
778+
Non-heap memory used, in bytes.
779+
780+
`jvm.mem.non_heap_committed_in_bytes`::
781+
(integer)
782+
Amount of non-heap memory available, in bytes.
783+
784+
`jvm.mem.pools.young.used_in_bytes`::
785+
(integer)
786+
Memory, in bytes, used by the young generation heap.
787+
788+
`jvm.mem.pools.young.max_in_bytes`::
789+
(integer)
790+
Maximum amount of memory, in bytes, available for use by the young generation
791+
heap.
792+
793+
`jvm.mem.pools.young.peak_used_in_bytes`::
794+
(integer)
795+
Largest amount of memory, in bytes, historically used by the young generation
796+
heap.
797+
798+
`jvm.mem.pools.young.peak_max_in_bytes`::
799+
(integer)
800+
Largest amount of memory, in bytes, historically used by the young generation
801+
heap.
802+
803+
`jvm.mem.pools.survivor.used_in_bytes`::
804+
(integer)
805+
Memory, in bytes, used by the survivor space.
806+
807+
`jvm.mem.pools.survivor.max_in_bytes`::
808+
(integer)
809+
Maximum amount of memory, in bytes, available for use by the survivor space.
810+
811+
`jvm.mem.pools.survivor.peak_used_in_bytes`::
812+
(integer)
813+
Largest amount of memory, in bytes, historically used by the survivor space.
814+
815+
`jvm.mem.pools.survivor.peak_max_in_bytes`::
816+
(integer)
817+
Largest amount of memory, in bytes, historically used by the survivor space.
818+
819+
`jvm.mem.pools.old.used_in_bytes`::
820+
(integer)
821+
Memory, in bytes, used by the old generation heap.
822+
823+
`jvm.mem.pools.old.max_in_bytes`::
824+
(integer)
825+
Maximum amount of memory, in bytes, available for use by the old generation
826+
heap.
827+
828+
`jvm.mem.pools.old.peak_used_in_bytes`::
829+
(integer)
830+
Largest amount of memory, in bytes, historically used by the old generation
831+
heap.
832+
833+
`jvm.mem.pools.old.peak_max_in_bytes`::
834+
(integer)
835+
Highest memory limit, in bytes, historically available for use by the old
836+
generation heap.
837+
838+
`jvm.threads.count`::
839+
(integer)
840+
Number of active threads in use by JVM.
841+
842+
`jvm.threads.peak_count`::
843+
(integer)
844+
Highest number of threads used by JVM.
845+
846+
`jvm.gc.collectors.young.collection_count`::
847+
(integer)
848+
Number of JVM garbage collectors that collect young generation objects.
849+
850+
`jvm.gc.collectors.young.collection_time_in_millis`::
851+
(integer)
852+
Total time in milliseconds spent by JVM collecting young generation objects.
853+
854+
`jvm.gc.collectors.old.collection_count`::
855+
(integer)
856+
Number of JVM garbage collectors that collect old generation objects.
857+
858+
`jvm.gc.collectors.old.collection_time_in_millis`::
859+
(integer)
860+
Total time in milliseconds spent by JVM collecting old generation objects.
861+
862+
`jvm.buffer_pools.mapped.count`::
863+
(integer)
864+
Number of mapped buffer pools.
865+
866+
`jvm.buffer_pools.mapped.used_in_bytes`::
867+
(integer)
868+
Size, in bytes, of mapped buffer pools.
869+
870+
`jvm.buffer_pools.mapped.total_capacity_in_bytes`::
871+
(integer)
872+
Total capacity, in bytes, of mapped buffer pools.
873+
874+
`jvm.buffer_pools.direct.count`::
875+
(integer)
876+
Number of direct buffer pools.
877+
878+
`jvm.buffer_pools.direct.used_in_bytes`::
879+
(integer)
880+
Size, in bytes, of direct buffer pools.
881+
882+
`jvm.buffer_pools.direct.total_capacity_in_bytes`::
883+
(integer)
884+
Total capacity, in bytes, of direct buffer pools.
885+
886+
`jvm.classes.current_loaded_count`::
887+
(integer)
888+
Number of buffer pool classes currently loaded by JVM.
889+
890+
`jvm.classes.total_loaded_count`::
891+
(integer)
892+
Total number of buffer pool classes loaded since the JVM started.
893+
894+
`jvm.classes.total_unloaded_count`::
895+
(integer)
896+
Total number of buffer pool classes unloaded since the JVM started.
750897

751898
[[cluster-nodes-stats-api-response-body-ingest]]
752899
===== `ingest` section

0 commit comments

Comments
 (0)