forked from opensearch-project/opensearch-api-specification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
nodes._common.yaml
1322 lines (1322 loc) · 51.9 KB
/
nodes._common.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: Schemas of `nodes._common` Category
description: Schemas of `nodes._common` category.
version: 1.0.0
paths: {}
components:
schemas:
Http:
type: object
properties:
current_open:
description: Current number of open HTTP connections for the node.
type: number
total_opened:
description: Total number of HTTP connections opened for the node.
type: number
clients:
description: |-
Information on current and recently-closed HTTP client connections.
Clients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here.
type: array
items:
$ref: '#/components/schemas/Client'
Client:
type: object
properties:
id:
description: Unique ID for the HTTP client.
type: number
agent:
description: |-
Reported agent for the HTTP client.
If unavailable, this property is not included in the response.
type: string
local_address:
description: Local address for the HTTP connection.
type: string
remote_address:
description: Remote address for the HTTP connection.
type: string
last_uri:
description: The URI of the client's most recent request.
type: string
opened_time_millis:
description: Time at which the client opened the connection.
type: number
closed_time_millis:
description: Time at which the client closed the connection if the connection is closed.
type: number
last_request_time_millis:
description: Time of the most recent request from this client.
type: number
request_count:
description: Number of requests from this client.
type: number
request_size_bytes:
description: Cumulative size in bytes of all requests from this client.
$ref: '_common.yaml#/components/schemas/ByteCount'
x_opaque_id:
description: |-
Value from the client's `x-opaque-id` HTTP header.
If unavailable, this property is not included in the response.
type: string
Ingest:
type: object
properties:
pipelines:
description: Contains statistics about ingest pipelines for the node.
type: object
additionalProperties:
$ref: '#/components/schemas/IngestTotal'
total:
$ref: '#/components/schemas/IngestTotal'
IngestTotal:
type: object
properties:
count:
description: Total number of documents ingested during the lifetime of this node.
type: number
current:
description: Total number of documents currently being ingested.
type: number
failed:
description: Total number of failed ingest operations during the lifetime of this node.
type: number
processors:
description: Total number of ingest processors.
type: array
items:
type: object
additionalProperties:
$ref: '#/components/schemas/KeyedProcessor'
time:
$ref: '_common.yaml#/components/schemas/Duration'
time_in_millis:
$ref: '_common.yaml#/components/schemas/DurationValueUnitMillis'
KeyedProcessor:
type: object
properties:
stats:
$ref: '#/components/schemas/Processor'
type:
type: string
Processor:
type: object
properties:
count:
description: Number of documents transformed by the processor.
type: number
current:
description: Number of documents currently being transformed by the processor.
type: number
failed:
description: Number of failed operations for the processor.
type: number
time:
$ref: '_common.yaml#/components/schemas/Duration'
time_in_millis:
$ref: '_common.yaml#/components/schemas/DurationValueUnitMillis'
ThreadCount:
type: object
properties:
active:
description: Number of active threads in the thread pool.
type: number
completed:
description: Number of tasks completed by the thread pool executor.
type: number
largest:
description: Highest number of active threads in the thread pool.
type: number
queue:
description: Number of tasks in queue for the thread pool.
type: number
rejected:
description: Number of tasks rejected by the thread pool executor.
type: number
threads:
description: Number of threads in the thread pool.
type: number
total_wait_time:
description: |
The total amount of time that tasks spend waiting in the thread pool queue.
Currently, only `search`, `search_throttled`, and `index_searcher` thread pools support this metric.
$ref: '_common.yaml#/components/schemas/Duration'
total_wait_time_in_nanos:
description: |
The total amount of time that tasks spend waiting in the thread pool queue.
Currently, only `search`, `search_throttled`, and `index_searcher` thread pools support this metric.
type: number
Scripting:
type: object
properties:
cache_evictions:
description: Total number of times the script cache has evicted old data.
type: number
compilations:
description: Total number of inline script compilations performed by the node.
type: number
compilations_history:
description: Contains this recent history of script compilations.
type: object
additionalProperties:
type: number
compilation_limit_triggered:
description: Total number of times the script compilation circuit breaker has limited inline script compilations.
type: number
contexts:
type: array
items:
$ref: '#/components/schemas/Context'
Context:
type: object
properties:
context:
type: string
compilations:
type: number
cache_evictions:
type: number
compilation_limit_triggered:
type: number
NodesResponseBase:
type: object
properties:
_nodes:
$ref: '_common.yaml#/components/schemas/NodeStatistics'
NodeReloadResult:
anyOf:
- $ref: '#/components/schemas/NodeReloadResponse'
- $ref: '#/components/schemas/NodeReloadError'
Stats:
type: object
properties:
adaptive_selection:
description: Statistics about adaptive replica selection.
type: object
additionalProperties:
$ref: '#/components/schemas/AdaptiveSelection'
breakers:
description: Statistics about the field data circuit breaker.
type: object
additionalProperties:
$ref: '#/components/schemas/Breaker'
fs:
$ref: '#/components/schemas/FileSystem'
host:
$ref: '_common.yaml#/components/schemas/Host'
http:
$ref: '#/components/schemas/Http'
ingest:
$ref: '#/components/schemas/Ingest'
ip:
description: IP address and port for the node.
oneOf:
- $ref: '_common.yaml#/components/schemas/Ip'
- type: array
items:
$ref: '_common.yaml#/components/schemas/Ip'
jvm:
$ref: '#/components/schemas/Jvm'
name:
$ref: '_common.yaml#/components/schemas/Name'
os:
$ref: '#/components/schemas/OperatingSystem'
process:
$ref: '#/components/schemas/Process'
roles:
$ref: '_common.yaml#/components/schemas/NodeRoles'
script:
$ref: '#/components/schemas/Scripting'
script_cache:
type: object
additionalProperties:
oneOf:
- $ref: '#/components/schemas/ScriptCache'
- type: array
items:
$ref: '#/components/schemas/ScriptCache'
thread_pool:
description: Statistics about each thread pool, including current size, queue and rejected tasks.
type: object
additionalProperties:
$ref: '#/components/schemas/ThreadCount'
timestamp:
type: number
transport:
$ref: '#/components/schemas/Transport'
transport_address:
$ref: '_common.yaml#/components/schemas/TransportAddress'
attributes:
description: Contains a list of attributes for the node.
type: object
additionalProperties:
type: string
discovery:
$ref: '#/components/schemas/Discovery'
indexing_pressure:
$ref: '#/components/schemas/IndexingPressure'
indices:
$ref: 'indices.stats.yaml#/components/schemas/IndexShardStats'
shard_indexing_pressure:
$ref: '#/components/schemas/ShardIndexingPressureStats'
search_backpressure:
$ref: '#/components/schemas/ShardSearchBackpressureStats'
cluster_manager_throttling:
$ref: '#/components/schemas/ShardClusterManagerThrottlingStats'
weighted_routing:
$ref: '#/components/schemas/ShardWeightedRoutingStats'
task_cancellation:
$ref: '#/components/schemas/ShardTaskCancellationStats'
resource_usage_stats:
$ref: '#/components/schemas/ShardResourceUsageStats'
search_pipeline:
$ref: '#/components/schemas/ShardSearchPipelineStats'
segment_replication_backpressure:
$ref: '#/components/schemas/ShardSegmentReplicationBackpressureStats'
remote_store:
$ref: '#/components/schemas/RemoteStoreStats'
repositories:
$ref: '#/components/schemas/ShardRepositoriesStats'
admission_control:
$ref: '#/components/schemas/ShardAdmissionControlStats'
caches:
$ref: '#/components/schemas/ShardCachesStats'
RemoteStoreStats:
type: object
properties:
last_successful_fetch_of_pinned_timestamps:
description: Timestamp for the last successful fetch of pinned timestamps.
$ref: '_common.yaml#/components/schemas/StringifiedEpochTimeUnitSeconds'
ShardClusterManagerThrottlingStats:
type: object
properties:
stats:
$ref: '#/components/schemas/ShardClusterManagerThrottlingStatsDetail'
ShardClusterManagerThrottlingStatsDetail:
type: object
properties:
total_throttled_tasks:
type: number
throttled_tasks_per_task_type:
type: object # TODO: list of tasks
ShardWeightedRoutingStats:
type: object
properties:
stats:
$ref: '#/components/schemas/ShardWeightedRoutingStatsDetail'
ShardWeightedRoutingStatsDetail:
type: object
properties:
fail_open_count:
type: number
ShardTaskCancellationStats:
type: object
properties:
search_shard_task:
$ref: '#/components/schemas/ShardTaskCancellationStatsDetail'
ShardTaskCancellationStatsDetail:
type: object
properties:
current_count_post_cancel:
type: number
total_count_post_cancel:
type: number
ShardSearchPipelineStats:
type: object
properties:
total_request:
$ref: '#/components/schemas/ShardSearchPipelineTotalStats'
total_response:
$ref: '#/components/schemas/ShardSearchPipelineTotalStats'
pipelines:
type: object
ShardSearchPipelineTotalStats:
type: object
properties:
count:
type: number
time:
$ref: '_common.yaml#/components/schemas/Duration'
time_in_millis:
$ref: '_common.yaml#/components/schemas/DurationValueUnitMillis'
current:
type: number
failed:
type: number
ShardResourceUsageStats:
type: object
additionalProperties:
$ref: '#/components/schemas/ShardResourceUsageStatsDetail'
ShardResourceUsageStatsDetail:
type: object
properties:
timestamp:
type: number
cpu_utilization_percent:
$ref: '_common.yaml#/components/schemas/PercentageString'
memory_utilization_percent:
$ref: '_common.yaml#/components/schemas/PercentageString'
io_usage_stats:
$ref: '#/components/schemas/ShardResourceUsageStatsIoUsageStats'
ShardResourceUsageStatsIoUsageStats:
type: object
properties:
max_io_utilization_percent:
$ref: '_common.yaml#/components/schemas/PercentageString'
ShardSegmentReplicationBackpressureStats:
type: object
properties:
total_rejected_requests:
type: number
ShardRepositoriesStats:
type: array
ShardAdmissionControlStats:
type: object
properties:
global_io_usage:
$ref: '#/components/schemas/UsageStats'
global_cpu_usage:
$ref: '#/components/schemas/UsageStats'
UsageStats:
type: object
properties:
transport:
$ref: '#/components/schemas/TransportUsageStats'
TransportUsageStats:
type: object
properties:
rejection_count:
type: object
ShardCachesStats:
type: object
additionalProperties:
$ref: '#/components/schemas/ShardCacheStats'
ShardCacheStats:
type: object
properties:
size:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
size_in_bytes:
$ref: '_common.yaml#/components/schemas/ByteCount'
evictions:
type: number
hit_count:
type: number
miss_count:
type: number
item_count:
type: number
store_name:
type: string
AdaptiveSelection:
type: object
properties:
avg_queue_size:
description: The exponentially weighted moving average queue size of search requests on the keyed node.
type: number
avg_response_time:
$ref: '_common.yaml#/components/schemas/Duration'
avg_response_time_ns:
description: The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.
type: number
avg_service_time:
$ref: '_common.yaml#/components/schemas/Duration'
avg_service_time_ns:
description: The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.
type: number
outgoing_searches:
description: The number of outstanding search requests to the keyed node from the node these stats are for.
type: number
rank:
description: The rank of this node; used for shard selection when routing search requests.
type: string
Breaker:
type: object
properties:
estimated_size:
description: Estimated memory used for the operation.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
estimated_size_in_bytes:
description: Estimated memory used, in bytes, for the operation.
$ref: '_common.yaml#/components/schemas/ByteCount'
limit_size:
description: Memory limit for the circuit breaker.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
limit_size_in_bytes:
description: Memory limit, in bytes, for the circuit breaker.
$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
tripped:
description: Total number of times the circuit breaker has been triggered and prevented an out of memory error.
type: number
FileSystem:
type: object
properties:
data:
description: List of all file stores.
type: array
items:
$ref: '#/components/schemas/DataPathStats'
timestamp:
description: |-
Last time the file stores statistics were refreshed.
Recorded in milliseconds since the Unix Epoch.
type: number
total:
$ref: '#/components/schemas/FileSystemTotal'
io_stats:
$ref: '#/components/schemas/IoStats'
DataPathStats:
type: object
properties:
available:
description: Total amount of disk space available to this Java virtual machine on this file store.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
available_in_bytes:
description: Total number of bytes available to this Java virtual machine on this file store.
$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.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
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/ByteCount'
disk_queue:
type: string
disk_reads:
type: number
disk_read_size:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
disk_read_size_in_bytes:
$ref: '_common.yaml#/components/schemas/ByteCount'
disk_writes:
type: number
disk_write_size:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
disk_write_size_in_bytes:
$ref: '_common.yaml#/components/schemas/ByteCount'
free:
description: Total amount of unallocated disk space in the file store.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
free_in_bytes:
description: Total number of unallocated bytes in the file store.
$ref: '_common.yaml#/components/schemas/ByteCount'
mount:
description: 'Mount point of the file store (for example: `/dev/sda2`).'
type: string
path:
description: Path to the file store.
type: string
total:
description: Total size of the file store.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
total_in_bytes:
description: Total size of the file store in bytes.
$ref: '_common.yaml#/components/schemas/ByteCount'
type:
description: 'Type of the file store (ex: ext4).'
type: string
FileSystemTotal:
type: object
properties:
available:
description: |-
Total disk space available to this Java virtual machine on all file stores.
Depending on OS or process level restrictions, this might appear less than `free`.
This is the actual amount of free disk space the OpenSearch node can utilize.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
available_in_bytes:
description: |-
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/ByteCount'
free:
description: Total unallocated disk space in all file stores.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
free_in_bytes:
description: Total number of unallocated bytes in all file stores.
$ref: '_common.yaml#/components/schemas/ByteCount'
total:
description: Total size of all file stores.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
total_in_bytes:
description: Total size of all file stores in 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.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
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/ByteCount'
IoStats:
type: object
properties:
devices:
description: |-
Array of disk metrics for each device that is backing an OpenSearch data path.
These disk metrics are probed periodically and averages between the last probe and the current probe are computed.
type: array
items:
$ref: '#/components/schemas/IoStatDevice'
total:
$ref: '#/components/schemas/IoStatDevice'
IoStatDevice:
type: object
properties:
device_name:
description: The Linux device name.
type: string
operations:
description: The total number of read and write operations for the device completed since starting OpenSearch.
type: number
read_kilobytes:
description: The total number of kilobytes read for the device since starting OpenSearch.
type: number
read_operations:
description: The total number of read operations for the device completed since starting OpenSearch.
type: number
write_kilobytes:
description: The total number of kilobytes written for the device since starting OpenSearch.
type: number
write_operations:
description: The total number of write operations for the device completed since starting OpenSearch.
type: number
read_time:
type: number
write_time:
type: number
queue_size:
type: number
io_time_in_millis:
$ref: '_common.yaml#/components/schemas/DurationValueUnitMillis'
Jvm:
type: object
properties:
buffer_pools:
description: Contains statistics about JVM buffer pools for the node.
type: object
additionalProperties:
$ref: '#/components/schemas/NodeBufferPool'
classes:
$ref: '#/components/schemas/JvmClasses'
gc:
$ref: '#/components/schemas/GarbageCollector'
mem:
$ref: '#/components/schemas/JvmMemoryStats'
threads:
$ref: '#/components/schemas/JvmThreads'
timestamp:
description: Last time JVM statistics were refreshed.
type: number
uptime:
description: |-
Human-readable JVM uptime.
Only returned if the `human` query parameter is `true`.
type: string
uptime_in_millis:
description: JVM uptime in milliseconds.
type: number
NodeBufferPool:
type: object
properties:
count:
description: Number of buffer pools.
type: number
total_capacity:
description: Total capacity of buffer pools.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
total_capacity_in_bytes:
description: Total capacity of buffer pools in bytes.
$ref: '_common.yaml#/components/schemas/ByteCount'
used:
description: Size of buffer pools.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
used_in_bytes:
description: Size of buffer pools in bytes.
$ref: '_common.yaml#/components/schemas/ByteCount'
JvmClasses:
type: object
properties:
current_loaded_count:
description: Number of classes currently loaded by JVM.
type: number
total_loaded_count:
description: Total number of classes loaded since the JVM started.
type: number
total_unloaded_count:
description: Total number of classes unloaded since the JVM started.
type: number
GarbageCollector:
type: object
properties:
collectors:
description: Contains statistics about JVM garbage collectors for the node.
type: object
additionalProperties:
$ref: '#/components/schemas/GarbageCollectorTotal'
GarbageCollectorTotal:
type: object
properties:
collection_count:
description: Total number of JVM garbage collectors that collect objects.
type: number
collection_time:
description: Total time spent by JVM collecting objects.
type: string
collection_time_in_millis:
description: Total time, in milliseconds, spent by JVM collecting objects.
type: number
JvmMemoryStats:
type: object
properties:
heap_used:
description: Memory currently in use by the heap.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
heap_used_in_bytes:
description: Memory, in bytes, currently in use by the heap.
$ref: '_common.yaml#/components/schemas/ByteCount'
heap_used_percent:
description: Percentage of memory currently in use by the heap.
$ref: '_common.yaml#/components/schemas/PercentageNumber'
heap_committed:
description: Amount of memory available for use by the heap.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
heap_committed_in_bytes:
description: Amount of memory, in bytes, available for use by the heap.
$ref: '_common.yaml#/components/schemas/ByteCount'
heap_max:
description: Maximum amount of memory available for use by the heap.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
heap_max_in_bytes:
description: Maximum amount of memory, in bytes, available for use by the heap.
$ref: '_common.yaml#/components/schemas/ByteCount'
non_heap_used:
description: Non-heap memory used.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
non_heap_used_in_bytes:
description: Non-heap memory used, in bytes.
$ref: '_common.yaml#/components/schemas/ByteCount'
non_heap_committed:
description: Amount of non-heap memory available.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
non_heap_committed_in_bytes:
description: Amount of non-heap memory available, in bytes.
$ref: '_common.yaml#/components/schemas/ByteCount'
pools:
description: Contains statistics about heap memory usage for the node.
type: object
additionalProperties:
$ref: '#/components/schemas/Pool'
Pool:
type: object
properties:
used:
description: Memory used by the heap.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
used_in_bytes:
description: Memory, in bytes, used by the heap.
$ref: '_common.yaml#/components/schemas/ByteCount'
max:
description: Maximum amount of memory available for use by the heap.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
max_in_bytes:
description: Maximum amount of memory, in bytes, available for use by the heap.
$ref: '_common.yaml#/components/schemas/ByteCount'
peak_used:
description: Largest amount of memory historically used by the heap.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
peak_used_in_bytes:
description: Largest amount of memory, in bytes, historically used by the heap.
$ref: '_common.yaml#/components/schemas/ByteCount'
peak_max:
description: Largest amount of memory historically used by the heap.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
peak_max_in_bytes:
description: Largest amount of memory, in bytes, historically used by the heap.
$ref: '_common.yaml#/components/schemas/ByteCount'
last_gc_stats:
description: Most recent GC cycle stats for a particular memory pool.
$ref: '#/components/schemas/LastGcStats'
LastGcStats:
type: object
properties:
used:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
used_in_bytes:
$ref: '_common.yaml#/components/schemas/ByteCount'
max:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
max_in_bytes:
$ref: '_common.yaml#/components/schemas/ByteCount'
usage_percent:
$ref: '_common.yaml#/components/schemas/PercentageNumber'
JvmThreads:
type: object
properties:
count:
description: Number of active threads in use by JVM.
type: number
peak_count:
description: Highest number of threads used by JVM.
type: number
OperatingSystem:
type: object
properties:
cpu:
$ref: '#/components/schemas/Cpu'
mem:
$ref: '#/components/schemas/ExtendedMemoryStats'
swap:
$ref: '#/components/schemas/MemoryStats'
cgroup:
$ref: '#/components/schemas/Cgroup'
timestamp:
type: number
Cpu:
type: object
properties:
percent:
$ref: '_common.yaml#/components/schemas/PercentageNumber'
sys:
$ref: '_common.yaml#/components/schemas/Duration'
sys_in_millis:
$ref: '_common.yaml#/components/schemas/DurationValueUnitMillis'
total:
$ref: '_common.yaml#/components/schemas/Duration'
total_in_millis:
$ref: '_common.yaml#/components/schemas/DurationValueUnitMillis'
user:
$ref: '_common.yaml#/components/schemas/Duration'
user_in_millis:
$ref: '_common.yaml#/components/schemas/DurationValueUnitMillis'
load_average:
type: object
additionalProperties:
type: number
ExtendedMemoryStats:
allOf:
- $ref: '#/components/schemas/MemoryStats'
- type: object
properties:
free_percent:
description: Percentage of free memory.
$ref: '_common.yaml#/components/schemas/PercentageNumber'
used_percent:
description: Percentage of used memory.
$ref: '_common.yaml#/components/schemas/PercentageNumber'
MemoryStats:
type: object
properties:
adjusted_total_in_bytes:
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/ByteCount'
resident:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
resident_in_bytes:
$ref: '_common.yaml#/components/schemas/ByteCount'
share:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
share_in_bytes:
$ref: '_common.yaml#/components/schemas/ByteCount'
total_virtual:
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
total_virtual_in_bytes:
$ref: '_common.yaml#/components/schemas/ByteCount'
total:
description: Total amount of physical memory.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
total_in_bytes:
description: Total amount of physical memory in bytes.
$ref: '_common.yaml#/components/schemas/ByteCount'
free:
description: Amount of free physical memory.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
free_in_bytes:
description: Amount of free physical memory in bytes.
$ref: '_common.yaml#/components/schemas/ByteCount'
used:
description: Amount of used physical memory.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
used_in_bytes:
description: Amount of used physical memory in bytes.
$ref: '_common.yaml#/components/schemas/ByteCount'
Cgroup:
type: object
properties:
cpuacct:
$ref: '#/components/schemas/CpuAcct'
cpu:
$ref: '#/components/schemas/CgroupCpu'
memory:
$ref: '#/components/schemas/CgroupMemory'
CpuAcct:
type: object
properties:
control_group:
description: The `cpuacct` control group to which the OpenSearch process belongs.
type: string
usage_nanos:
$ref: '_common.yaml#/components/schemas/DurationValueUnitNanos'
CgroupCpu:
type: object
properties:
control_group:
description: The `cpu` control group to which the OpenSearch process belongs.
type: string
cfs_period_micros:
description: The period of time, in microseconds, for how regularly all tasks in the same cgroup as the OpenSearch process should have their access to CPU resources reallocated.
type: number
cfs_quota_micros:
description: The total amount of time, in microseconds, for which all tasks in the same cgroup as the OpenSearch process can run during one period `cfs_period_micros`.
type: number
stat:
$ref: '#/components/schemas/CgroupCpuStat'
CgroupCpuStat:
type: object
properties:
number_of_elapsed_periods:
description: The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed.
type: number
number_of_times_throttled:
description: The number of times all tasks in the same cgroup as the OpenSearch process have been throttled.
type: number
time_throttled_nanos:
$ref: '_common.yaml#/components/schemas/DurationValueUnitNanos'
CgroupMemory:
type: object
properties:
control_group:
description: The `memory` control group to which the OpenSearch process belongs.
type: string
limit_in_bytes:
description: |-
The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the OpenSearch process.
This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns.
Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup.
type: string
usage_in_bytes:
description: |-
The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the OpenSearch process.
This value is stored as a string for consistency with `limit_in_bytes`.
type: string
Process:
type: object
properties:
cpu:
$ref: '#/components/schemas/Cpu'
mem:
$ref: '#/components/schemas/MemoryStats'
open_file_descriptors:
description: Number of opened file descriptors associated with the current or `-1` if not supported.
type: number
max_file_descriptors:
description: Maximum number of file descriptors allowed on the system, or `-1` if not supported.
type: number
timestamp:
description: |-
Last time the statistics were refreshed.
Recorded in milliseconds since the Unix Epoch.
type: number
ScriptCache:
type: object
properties:
cache_evictions:
description: Total number of times the script cache has evicted old data.
type: number
compilation_limit_triggered:
description: Total number of times the script compilation circuit breaker has limited inline script compilations.
type: number
compilations:
description: Total number of inline script compilations performed by the node.
type: number
context:
type: string
Transport:
type: object
properties:
inbound_handling_time_histogram:
description: The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram.
type: array
items:
$ref: '#/components/schemas/TransportHistogram'
outbound_handling_time_histogram:
description: The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram.
type: array
items:
$ref: '#/components/schemas/TransportHistogram'
rx_count:
description: Total number of RX (receive) packets received by the node during internal cluster communication.
type: number
rx_size:
description: Size of RX packets received by the node during internal cluster communication.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
rx_size_in_bytes:
description: Size, in bytes, of RX packets received by the node during internal cluster communication.
$ref: '_common.yaml#/components/schemas/ByteCount'
server_open:
description: Current number of inbound TCP connections used for internal communication between nodes.
type: number
tx_count:
description: Total number of TX (transmit) packets sent by the node during internal cluster communication.
type: number
tx_size:
description: Size of TX packets sent by the node during internal cluster communication.
$ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
tx_size_in_bytes:
description: Size, in bytes, of TX packets sent by the node during internal cluster communication.
$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.
Each transport connection may comprise multiple TCP connections but is only counted once in this statistic.
Transport connections are typically long-lived so this statistic should remain constant in a stable cluster.
type: number
TransportHistogram:
type: object
properties:
count:
description: The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message.
type: number
lt_millis:
description: |-
The exclusive upper bound of the bucket in milliseconds.
May be omitted on the last bucket if this bucket has no upper bound.
type: number
ge_millis:
description: The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound.
type: number
Discovery: