forked from elastic/logstash
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlogstash-api.yaml
More file actions
2630 lines (2574 loc) · 108 KB
/
logstash-api.yaml
File metadata and controls
2630 lines (2574 loc) · 108 KB
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: Logstash APIs
description: |
When you run Logstash, it automatically captures runtime metrics that you can use to monitor the health and performance of your Logstash deployment.
The metrics collected by Logstash include:
- Health report.
- Hot threads.
- Logstash node info, like pipeline settings, OS info, and JVM info.
- Node stats, like JVM stats, process stats, event-related stats, and pipeline runtime stats.
- Plugins info, including a list of installed plugins.
The APIs that retrieve these metrics are available by default, with no extra configuration needed.
## Documentation source and versions
This documentation is derived from the `main` branch of the [logstash](https://github.com/elastic/logstash) repository.
It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).
version: '1.0'
x-doc-license:
name: Attribution-NonCommercial-NoDerivatives 4.0 International
url: https://creativecommons.org/licenses/by-nc-nd/4.0/
x-feedbackLink:
label: Feedback
url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- url: /
security:
- {} # Allows requests without authentication
- BasicAuth: [] # Allows requests with Basic Authentication
tags:
- name: health
x-displayName: Health report
# description:
# externalDocs:
# description:
# url:
- name: hot threads
x-displayName: Hot threads
# description:
# externalDocs:
# description:
# url:
- name: root
x-displayName: Metadata
description: |
Build and service metadata, including build info, pipeline info and the service's status.
# externalDocs:
# description:
# url:
- name: node info
x-displayName: Node info
description: |
Logstash node info, like pipeline settings, OS info, and JVM info.
# externalDocs:
# description:
# url:
- name: node stats
x-displayName: Node stats
description: |
Node stats, like JVM stats, process stats, event-related stats, and pipeline runtime stats.
# externalDocs:
# description:
# url:
- name: plugin info
x-displayName: Plugins info
description: |
Plugin info, including a list of installed plugins.
# externalDocs:
# description:
# url:
paths:
/:
get:
summary: Get build and service metadata
description: |
Shows basic metadata about the running logstash service. This includes build info, pipeline info and the service's status.
operationId: root
tags:
- root
parameters:
- name: wait_for_status
in: query
required: false
schema:
type: string
description: Wait (until the timeout expires) for the service changes to a specific health status (or a better status). A green status is better than yellow and yellow is better than red. The `timeout` query parameter is required when you use this parameter.
- name: timeout
in: query
required: false
schema:
type: string
description: Period to wait for the status to reach the requested target status. Must be an integer with units, for example `3s`. If the target status is not reached before the timeout expires, the request returns status code 408.
- $ref: "#/components/parameters/pretty"
responses:
'200':
description: Indicates a successful call
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Common'
- type: object
properties:
build_date:
type: string
description: The timestamp when this Logstash build was created.
build_sha:
type: string
description: The SHA-1 hash of the Logstash build.
build_snapshot:
type: boolean
description: Whether this Logstash build is a snapshot build.
pipeline:
type: object
properties:
workers:
type: integer
description: The number of workers in the pipeline.
batch_size:
type: integer
description: The batch size for the pipeline.
batch_delay:
type: integer
description: The batch delay for the pipeline.
examples:
basicMetadataExample1:
value:
host: "logstash-pipelines.example.com"
version: "9.2.1"
http_address: "127.0.0.1:9600"
id: "58df6f7c-eb5c-5d42-bc20-c7b22779aa12"
name: "logstash-pipelines"
ephemeral_id: "59df6f6c-eb5c-4d42-bc20-c7b44779aa12"
snapshot: true
status: "green"
build_date: "2025-11-20T01:18:55+00:00"
build_sha: "ff3e87d66f10c05a74d0cef7bc2911d60cee1ebc"
build_snapshot: true
pipeline:
workers: 10
batch_size: 125
batch_delay: 50
x-metaTags:
- content: Logstash
name: product_name
/_node/jvm:
get:
summary: Gets node-level JVM info
description: |
Show node-level JVM stats, such as the JVM process id, version, VM info, memory usage, and info about garbage collectors.
operationId: nodeInfoJVM
tags:
- node info
parameters:
- $ref: "#/components/parameters/pretty"
responses:
'200':
description: Indicates a successful call
content:
application/json:
schema:
allOf:
# - $ref: '#/components/schemas/Common'
# - $ref: '#/components/schemas/PipelineSettings'
- type: object
properties:
jvm:
type: object
properties:
pid:
type: integer
version:
type: string
vm_name:
type: string
vm_version:
type: string
vm_vendor:
type: string
start_time_in_millis:
type: integer
mem:
type: object
properties:
heap_init_in_bytes:
type: integer
heap_max_in_bytes:
type: integer
non_heap_init_in_bytes:
type: integer
non_heap_max_in_bytes:
type: integer
gc_collectors:
type: array
items:
type: string
example:
jvm:
pid: 84013
version: "21.0.4"
vm_name: "OpenJDK 64-Bit Server VM"
vm_version: "21.0.4"
vm_vendor: "Eclipse Adoptium"
start_time_in_millis: 1630980000000
mem:
heap_init_in_bytes: 1073741824
heap_max_in_bytes: 1073741824
non_heap_init_in_bytes: 2555904
non_heap_max_in_bytes: 0
gc_collectors:
- "G1 Young Generation"
- "G1 Concurrent GC"
- "G1 Old Generation"
x-metaTags:
- content: Logstash
name: product_name
/_node/os:
get:
summary: Get node-level OS info
description: |
Get the operating system (OS) name, architecture, version, and available processors.
operationId: nodeInfoOS
tags:
- node info
parameters:
- $ref: "#/components/parameters/pretty"
responses:
'200':
description: Indicates a successful call
content:
application/json:
schema:
allOf:
# - $ref: '#/components/schemas/Common'
# - $ref: '#/components/schemas/PipelineSettings'
- $ref: '#/components/schemas/OSStats'
example:
os:
name: "Mac OS X"
arch: "aarch64"
version: "15.3.1"
available_processors: 12
x-metaTags:
- content: Logstash
name: product_name
/_node/pipelines:
get:
summary: Get settings for pipelines
description: |
Get information and settings for all pipelines.
operationId: nodeInfoPipelines
tags:
- node info
parameters:
- $ref: "#/components/parameters/pretty"
responses:
'200':
description: Indicates a successful call
content:
application/json:
schema:
allOf:
# - $ref: '#/components/schemas/Common'
# - $ref: '#/components/schemas/PipelineSettings'
- type: object
properties:
pipelines:
type: object
additionalProperties:
$ref: '#/components/schemas/NodeInfoPipeline'
example:
pipelines:
aggregation-pipeline:
workers: 1
batch_size: 125
batch_delay: 50
dead_letter_queue_enabled: false
ingestion-pipeline:
workers: 8
batch_size: 125
batch_delay: 5
dead_letter_queue_enabled: false
x-metaTags:
- content: Logstash
name: product_name
/_node/pipelines/{pipeline_name}:
get:
summary: Get settings for a pipeline
description: Get information and settings for all pipelines.
operationId: nodeInfoPipeline
tags:
- node info
parameters:
- name: pipeline_name
in: path
required: true
schema:
type: string
description: The name of the pipeline to retrieve information for.
- $ref: "#/components/parameters/pretty"
responses:
'200':
description: Indicates a successful call
content:
application/json:
schema:
allOf:
# - $ref: '#/components/schemas/Common'
# - $ref: '#/components/schemas/PipelineSettings'
- type: object
properties:
pipelines:
type: object
additionalProperties:
$ref: '#/components/schemas/NodeInfoPipeline'
example:
pipelines:
aggregation-pipeline:
workers: 1
batch_size: 125
batch_delay: 50
dead_letter_queue_enabled: false
x-metaTags:
- content: Logstash
name: product_name
/_node/plugins:
get:
summary: Get plugin info
description: >
Get information about all Logstash plugins that are currently installed.
This API returns the same output you get by running the `bin/logstash-plugin list --verbose` command.
operationId: nodePlugins
tags:
- plugin info
parameters:
- $ref: "#/components/parameters/pretty"
responses:
'200':
description: Indicates a successful call
content:
application/json:
schema:
allOf:
# - $ref: '#/components/schemas/Common'
# - $ref: '#/components/schemas/PipelineSettings'
- type: object
properties:
total:
type: integer
plugins:
type: array
items:
type: object
properties:
name:
type: string
version:
type: string
examples:
nodePluginsExample1:
value:
total: 4
plugins:
- name: logstash-codec-cef
version: 6.2.8
- name: logstash-codec-collectd
version: 3.0.3
- name: logstash-codec-dots
version: 3.0.2
- name: logstash-coded-edn
version: 3.0.2
x-metaTags:
- content: Logstash
name: product_name
/_node/stats:
get:
summary: Get node statistics
description: Get node statistics including information about the JVM, process, events, flow, and queue.
operationId: nodeStats
tags:
- node stats
parameters:
- $ref: "#/components/parameters/pretty"
responses:
"200":
description: A JSON object containing pipelines statistics.
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/Common"
- $ref: '#/components/schemas/PipelineSettings'
- $ref: '#/components/schemas/JVMStats'
- $ref: '#/components/schemas/ProcessStats'
- $ref: '#/components/schemas/EventsStats'
- $ref: '#/components/schemas/NodeStatsFlow'
- $ref: "#/components/schemas/PipelinesStats"
- $ref: '#/components/schemas/ReloadStats'
- $ref: '#/components/schemas/OSStats'
- $ref: '#/components/schemas/QueueStats'
example:
host: Mac
version: 9.1.0
http_address: 127.0.0.1:9600
id: 46e32c2e-b41f-45b7-84c1-1642457f3eba
name: Mac
ephemeral_id: 1752e2fe-7710-44d0-a2f8-a3005b6273c8
snapshot:
status: green
pipeline:
workers: 12
batch_size: 125
batch_delay: 50
jvm:
threads:
count: 47
peak_count: 47
mem:
heap_used_percent: 20
heap_committed_in_bytes: 1073741824
heap_max_in_bytes: 1073741822
heap_used_in_bytes: 222298112
non_heap_used_in_bytes: 170675352
non_heap_committed_in_bytes: 176553984
pools:
survivor:
max_in_bytes: -1
peak_used_in_bytes: 42991616
peak_max_in_bytes: -1
committed_in_bytes: 26214400
used_in_bytes: 26214400
old:
max_in_bytes: 1073741824
peak_used_in_bytes: 96468992
peak_max_in_bytes: 1073741824
committed_in_bytes: 848297984
used_in_bytes: 96468992
young:
max_in_bytes: -1
peak_used_in_bytes: 329252864
peak_max_in_bytes: -1
committed_in_bytes: 199229440
used_in_bytes: 99614720
gc:
collectors:
old:
collection_time_in_millis: 0
collection_count: 0
young:
collection_time_in_millis: 49
collection_count: 7
uptime_in_millis: 14712
process:
open_file_descriptors: 87
peak_open_file_descriptors: 87
max_file_descriptors: 10240
mem:
total_virtual_in_bytes: 425113862144
cpu:
total_in_millis: 20823
percent: 0
load_average:
1m: 4.07177734375
events:
in: 1
filtered: 1
out: 1
duration_in_millis: 6
queue_push_duration_in_millis: 0
flow:
input_throughput:
current: 0.0776
lifetime: 0.0776
filter_throughput:
current: 0.07759
lifetime: 0.07759
output_throughput:
current: 0.07759
lifetime: 0.07759
queue_backpressure:
current: 0
lifetime: 0
worker_concurrency:
current: 0.0004656
lifetime: 0.0004656
pipelines:
heartbeat-ruby-stdout:
events:
queue_push_duration_in_millis: 0
filtered: 1
out: 1
duration_in_millis: 6
in: 1
flow:
worker_concurrency:
current: 0.0004779
lifetime: 0.0004779
filter_throughput:
current: 0.07963
lifetime: 0.07963
worker_utilization:
current: 0.003982
lifetime: 0.003982
queue_backpressure:
current: 0
lifetime: 0
output_throughput:
current: 0.07963
lifetime: 0.07963
input_throughput:
current: 0.07962
lifetime: 0.07962
plugins:
inputs:
- id: c9ca46e359d73146590ca8af40092342afa922f3cbf07adc4b5009e346cb19f7
flow:
throughput:
current: 0.07963
lifetime: 0.07963
name: heartbeat
events:
queue_push_duration_in_millis: 0
out: 1
codecs:
- id: be3a3aba-ee75-4978-af58-d22b856d0e35
name: rubydebug
- id: plain_22e7b41b-756a-4b52-b03c-a30b31bb6266
name: plain
decode:
out: 0
duration_in_millis: 0
writes_in: 0
encode:
duration_in_millis: 0
writes_in: 0
filters:
- id: 585fa932a4fd506055ead07ee5ebcb3033c27c82ba90cbee73d6ac7e9357333a
flow:
worker_utilization:
current: 0.0006636
lifetime: 0.0006636
worker_millis_per_event:
current: 1
lifetime: 1
name: ruby
events:
out: 1
in: 1
duration_in_millis: 1
outputs:
- id: c4f801c8f170b4cb0679f704413773acd5f291929f42302d0a56361400c3741b
flow:
worker_utilization:
current: 0.001991
lifetime: 0.001991
worker_millis_per_event:
current: 3
lifetime: 3
name: stdout
events:
out: 1
in: 1
duration_in_millis: 3
reloads:
last_failure_timestamp:
successes: 0
last_success_timestamp:
last_error:
failures: 0
queue:
type: memory
events_count: 0
queue_size_in_bytes: 0
max_queue_size_in_bytes: 0
pipeline:
workers: 12
batch_size: 125
batch_delay: 50
hash: c11e0502ebf98956dffa371775fd1cb719f85f819ee166b770b3e982da1c999d
ephemeral_id: cd90b521-c192-437e-a49e-62fabebde7e2
reloads:
successes: 0
failures: 0
os: { }
queue:
events_count: 0
x-metaTags:
- content: Logstash
name: product_name
/_node/stats/events:
get:
summary: Get events statistics
description: Get statistics related to event processing.
operationId: nodeStatsEvents
tags:
- node stats
parameters:
- $ref: "#/components/parameters/pretty"
responses:
"200":
description: A JSON object containing events statistics.
content:
application/json:
schema:
allOf:
# - $ref: "#/components/schemas/Common"
# - $ref: '#/components/schemas/PipelineSettings'
- $ref: "#/components/schemas/EventsStats"
example:
events:
duration_in_millis: 1109
in: 56
filtered: 56
out: 56
queue_push_duration_in_millis: 2
x-metaTags:
- content: Logstash
name: product_name
/_node/stats/flow:
get:
summary: Get flow statistics
description: Get throughput and backpressure details.
operationId: nodeStatsFlow
tags:
- node stats
parameters:
- $ref: "#/components/parameters/pretty"
responses:
"200":
description: |
Flow rates provide visibility into how a Logstash instance or an individual pipeline is currently performing relative to itself over time. This allows us to attach meaning to the cumulative-value metrics that are also presented by this API, and to determine whether an instance or pipeline is behaving better or worse than it has in the past.
The following flow rates are available for the logstash process as a whole and for each of its pipelines individually. In addition, pipelines may have [additional flow rates](https://www.elastic.co/guide/en/logstash/current/node-stats-api.html#pipeline-flow-rates) depending on their configuration.
content:
application/json:
schema:
allOf:
# - $ref: "#/components/schemas/Common"
# - $ref: '#/components/schemas/PipelineSettings'
- $ref: "#/components/schemas/NodeStatsFlow"
example:
flow:
input_throughput:
current: 0.07381
last_1_minute: 0.01572
last_5_minutes: 0.01618
last_15_minutes: 0.0173
lifetime: 0.01701
filter_throughput:
current: 0.07379
last_1_minute: 0.01572
last_5_minutes: 0.01618
last_15_minutes: 0.0173
lifetime: 0.01701
output_throughput:
current: 0.07379
last_1_minute: 0.01572
last_5_minutes: 0.01618
last_15_minutes: 0.0173
lifetime: 0.01701
queue_backpressure:
current: 0.00007379
last_1_minute: 0.00001572
last_5_minutes: 0.00004532
last_15_minutes: 0.00005407
lifetime: 0.00006464
worker_concurrency:
current: 0.0001476
last_1_minute: 0.0001257
last_5_minutes: 0.000246
last_15_minutes: 0.0002941
lifetime: 0.000242
x-metaTags:
- content: Logstash
name: product_name
/_node/stats/geoip_download_manager:
get:
summary: Get geoip databases statistics
description: Get license checks and download status of [Geoip filter plugin](https://www.elastic.co/guide/en/logstash/current/plugins-filters-geoip.html).
operationId: nodeStatsGeoIPDownloadManager
tags:
- node stats
parameters:
- $ref: "#/components/parameters/pretty"
responses:
"200":
description: A JSON object containing geoip database license and download status.
content:
application/json:
schema:
type: object
properties:
geoip_download_manager:
type: object
properties:
database:
type: object
properties:
ASN:
$ref: "#/components/schemas/GeoIPDBLicenseStats"
CITY:
$ref: "#/components/schemas/GeoIPDBLicenseStats"
download_stats:
type: object
properties:
successes:
description: "The number of successful checks and downloads"
type: integer
failures:
description: "The number of failed check or downloads"
type: integer
last_checked_at:
type: string
format: date-time
status:
description: "The last download status."
type: string
enum: [ "succeeded", "failed", "updating" ]
x-metaTags:
- content: Logstash
name: product_name
/_node/stats/jvm:
get:
summary: Get JVM statistics
description: Get threads count, garbage collators(GC) and memory details.
operationId: nodeStatsJVM
tags:
- node stats
parameters:
- $ref: "#/components/parameters/pretty"
responses:
"200":
description: A JSON object containing jvm statistics.
content:
application/json:
schema:
allOf:
# - $ref: "#/components/schemas/Common"
# - $ref: '#/components/schemas/PipelineSettings'
- $ref: "#/components/schemas/JVMStats"
example:
jvm:
threads:
count: 117
peak_count: 119
mem:
heap_used_percent: 4
heap_committed_in_bytes: 245366784
heap_max_in_bytes: 4294967294
heap_used_in_bytes: 206685392
non_heap_used_in_bytes: 175223280
non_heap_committed_in_bytes: 196739072
pools:
young:
committed_in_bytes: 92274688
max_in_bytes: -1
used_in_bytes: 69206016
peak_max_in_bytes: -1
peak_used_in_bytes: 171966464
old:
committed_in_bytes: 146800640
max_in_bytes: 4294967296
used_in_bytes: 131187920
peak_max_in_bytes: 4294967296
peak_used_in_bytes: 135186368
survivor:
committed_in_bytes: 6291456
max_in_bytes: -1
used_in_bytes: 6291456
peak_max_in_bytes: -1
peak_used_in_bytes: 23068672
gc:
collectors:
young:
collection_count: 37
collection_time_in_millis: 192
old:
collection_count: 0
collection_time_in_millis: 0
uptime_in_millis: 2512572
x-metaTags:
- content: Logstash
name: product_name
/_node/stats/os:
get:
summary: Get Cgroup statistics
description: Get a more accurate view of CPU statistics from control groups (Cgroup) if available.
operationId: nodeStatsOS
tags:
- node stats
parameters:
- $ref: "#/components/parameters/pretty"
responses:
"200":
description: A JSON object containing OS statistics.
content:
application/json:
schema:
type: object
properties:
os:
type: object
properties:
cgroup:
type: object
properties:
cpuacct:
type: object
properties:
control_group:
type: string
usage_nanos:
type: integer
format: int64
cpu:
type: object
properties:
control_group:
type: string
cfs_period_micros:
type: integer
format: int64
cfs_quota_micros:
type: integer
format: int64
stat:
type: object
properties:
number_of_elapsed_periods:
type: integer
format: int64
number_of_times_throttled:
type: integer
format: int64
time_throttled_nanos:
type: integer
format: int64
example:
os:
cgroup:
cpuacct:
control_group: "/elastic1"
usage_nanos: 378477588075
cpu:
control_group: "/elastic1"
cfs_period_micros: 1000000
cfs_quota_micros: 800000
stat:
number_of_elapsed_periods: 4157
number_of_times_throttled: 460
time_throttled_nanos: 581617440755
x-metaTags:
- content: Logstash
name: product_name
/_node/stats/pipelines:
get:
summary: Get statistics for pipelines
description: Get pipeline performance metrics and plugin details.
operationId: nodeStatsPipelines
tags:
- node stats
parameters:
- $ref: "#/components/parameters/pretty"
responses:
"200":
description: |
A JSON object containing pipelines statistics.
- the number of events that were input, filtered, or output by each pipeline
- the current and lifetime [flow rates](https://www.elastic.co/guide/en/logstash/current/node-stats-api.html#flow-stats for each pipeline
- stats for each configured filter or output stage
- info about config reload successes and failures (when [config reload](https://www.elastic.co/guide/en/logstash/current/reloading-config.html) is enabled)
- info about the persistent queue (when [persistent queues](https://www.elastic.co/guide/en/logstash/current/persistent-queues.html) are enabled)
- metrics related to processed batch sizes. Includes the size in bytes and the number of events of batches processed in this pipeline. (when setting [pipeline.batch.metrics.sampling_mode](https://www.elastic.co/docs/reference/logstash/logstash-settings-file.html) is not `disabled`).
content:
application/json:
schema:
allOf:
# - $ref: "#/components/schemas/Common"
# - $ref: '#/components/schemas/PipelineSettings'
- $ref: "#/components/schemas/PipelinesStats"
example:
pipelines:
beats-es:
batch:
event_count:
current: 78
average:
lifetime: 115
last_1_minute: 120
last_5_minutes: 110
last_15_minutes: 112
p50:
last_1_minute: 125
last_5_minutes: 105
last_15_minutes: 108
p90:
last_1_minute: 125
last_5_minutes: 112
last_15_minutes: 116
byte_size:
current: 32767
average:
lifetime: 14820
last_1_minute: 15234
last_5_minutes: 14012
last_15_minutes: 14567
p50:
lifetime: 14815
last_1_minute: 15240
last_5_minutes: 14030
last_15_minutes: 14600
p90:
lifetime: 14825
last_1_minute: 15300
last_5_minutes: 14050
last_15_minutes: 14630
max:
lifetime: 14830
last_1_minute: 16000
last_5_minutes: 14080
last_15_minutes: 14670
events:
duration_in_millis: 365495
in: 216610
filtered: 216485
out: 216485
queue_push_duration_in_millis: 342466
flow:
input_throughput:
current: 603.1
lifetime: 575.4
filter_throughput:
current: 604.2
lifetime: 575.1
output_throughput:
current: 604.8
lifetime: 575.1
queue_backpressure:
current: 0.214
lifetime: 0.937
worker_concurrency:
current: 0.941
lifetime: 0.9709
worker_utilization:
current: 93.092
lifetime: 92.187
plugins:
inputs:
- id: 35131f351e2dc5ed13ee04265a8a5a1f95292165-1
events:
out: 216485
queue_push_duration_in_millis: 342466
flow:
throughput:
current: 603.1
lifetime: 590.7
name: beats
filters:
- id: 35131f351e2dc5ed13ee04265a8a5a1f95292165-2
events:
duration_in_millis: 55969
in: 216485
out: 216485
failures: 216485
patterns_per_field:
message: 1
flow:
worker_utilization:
current: 16.71
lifetime: 15.27
worker_millis_per_event:
current: 2829
lifetime: 0.2585
name: grok
- id: 35131f351e2dc5ed13ee04265a8a5a1f95292165-3
events:
duration_in_millis: 3326
in: 216485
out: 216485
flow:
worker_utilization:
current: 1.042
lifetime: 0.9076
worker_millis_per_event: