forked from influxdata/docs-v2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtelegraf_plugins.yml
2735 lines (2361 loc) · 106 KB
/
telegraf_plugins.yml
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
############## %%%%%% %% %% %%%%% %% %% %%%%%% %%%% ##############
############## %% %%% %% %% %% %% %% %% %% ##############
############## %% %% %%% %%%%% %% %% %% %%%% ##############
############## %% %% %% %% %% %% %% %% ##############
############## %%%%%% %% %% %% %%%% %% %%%% ##############
input:
- name: AMQP Consumer
id: amqp_consumer
description: |
The AMQP Consumer input plugin provides a consumer for use with AMQP 0-9-1,
a prominent implementation of this protocol
being RabbitMQ.
introduced: 1.3.0
tags: [linux, macos, windows, messaging]
- name: ActiveMQ
id: activemq
description: |
The ActiveMQ input plugin gathers queues, topics, and subscriber metrics
using the ActiveMQ Console API.
introduced: 1.8.0
tags: [linux, macos, windows, messaging]
- name: Aerospike
id: aerospike
description: |
The Aerospike input plugin queries Aerospike servers and gets node statistics
and statistics for all configured namespaces.
introduced: 0.2.0
tags: [linux, macos, windows, data-stores]
- name: Alibaba CloudMonitor Service (Aliyun)
id: aliyuncms
description: |
This plugin pulls metric statistics from Aliyun CMS.
introduced: 1.19.0
tags: [cloud]
- name: Amazon CloudWatch Alarms
id: awsalarms
description: |
The Amazon CloudWatch Alarms input plugin pulls alarm statistics from Amazon CloudWatch.
introduced: 1.16.0
link: https://github.com/vipinvkmenon/awsalarms
tags: [linux, macos, windows, cloud, external]
external: true
- name: Amazon CloudWatch Statistics
id: cloudwatch
description: |
The Amazon CloudWatch Statistics input plugin pulls metric statistics from Amazon CloudWatch.
introduced: 0.12.1
tags: [linux, macos, windows, cloud]
- name: Amazon ECS
id: ecs
description: |
Amazon ECS input plugin (AWS Fargate compatible) uses the Amazon ECS v2 metadata and stats API endpoints to gather stats on running containers in a task.
The Telegraf container and the workload that Telegraf is inspecting must be run in the same task. This is similar to (and reuses pieces of) the
Docker input plugin, with some ECS-specific modifications for AWS metadata and stats formats.
introduced: 1.11.0
tags: [linux, macos, windows, cloud, containers]
- name: Amazon Kinesis Consumer
id: kinesis_consumer
description: |
The Amazon Kinesis Consumer input plugin reads from a Kinesis data stream and creates
metrics using one of the supported [input data formats](/{{< latest "telegraf" >}}/data_formats/input).
introduced: 1.10.0
tags: [linux, macos, windows, cloud, messaging]
external: true
- name: Apache Aurora
id: aurora
description: |
The Aurora input plugin gathers metrics from [Apache Aurora](https://aurora.apache.org/) schedulers.
For monitoring recommendations, see [Monitoring your Aurora cluster](https://aurora.apache.org/documentation/latest/operations/monitoring/).
introduced: 1.7.0
tags: [linux, macos, windows, applications, containers]
- name: Apache HTTP Server
id: apache
description: |
The Apache HTTP Server input plugin collects server performance information
using the `mod_status` module of the Apache HTTP Server.
Typically, the `mod_status` module is configured to expose a page at the
`/server-status?auto` location of the Apache server.
The [ExtendedStatus](https://httpd.apache.org/docs/2.4/mod/core.html#extendedstatus)
option must be enabled in order to collect all available fields.
For information about how to configure your server reference, see the
[module documentation](https://httpd.apache.org/docs/2.4/mod/mod_status.html#enable).
introduced: 1.8.0
tags: [linux, macos, windows, servers, web]
- name: Apache Kafka Consumer
id: kafka_consumer
description: |
The Apache Kafka Consumer input plugin polls a specified Kafka topic and adds messages to InfluxDB.
Messages are expected in the line protocol format.
[Consumer Group](http://godoc.org/github.com/wvanbergen/kafka/consumergroup)
is used to talk to the Kafka cluster so multiple instances of Telegraf can read
from the same topic in parallel.
introduced: 0.2.3
tags: [linux, macos, windows, messaging]
- name: Apache Mesos
id: mesos
description: |
The Apache Mesos input plugin gathers metrics from Mesos. For more information, please check the
[Mesos Observability Metrics](http://mesos.apache.org/documentation/latest/monitoring/) page.
introduced: 0.10.3
tags: [linux, macos, windows, containers]
- name: Apache Solr
id: solr
description: |
The Apache Solr input plugin collects stats using the MBean Request Handler.
introduced: 1.5.0
tags: [linux, macos, windows, data-stores]
- name: Apache Tomcat
id: tomcat
description: |
The Apache Tomcat input plugin collects statistics available from the Apache
Tomcat manager status page (`http://<host>/manager/status/all?XML=true`).
Using `XML=true` returns XML data.
See the [Apache Tomcat documentation](https://tomcat.apache.org/tomcat-9.0-doc/manager-howto.html#Server_Status)
for details on these statistics.
introduced: 1.4.0
tags: [linux, macos, windows, servers, web]
- name: Apache Zipkin
id: zipkin
description: |
The Apache Zipkin input plugin implements the Zipkin HTTP server to gather trace
and timing data needed to troubleshoot latency problems in microservice architectures.
> This plugin is experimental. Its data schema may be subject to change based on
> its main usage cases and the evolution of the OpenTracing standard.
introduced: 1.4.0
tags: [linux, macos, windows, networking]
- name: Apache Zookeeper
id: zookeeper
description: |
The Apache Zookeeper input plugin collects variables output from the `mntr`
command [Zookeeper Admin](https://zookeeper.apache.org/doc/current/zookeeperAdmin.html).
introduced: 0.2.0
tags: [linux, macos, windows, build-deploy]
- name: Apcupsd
id: apcupsd
description: |
The Apcupsd input plugin reads data from an apcupsd daemon over its NIS network protocol.
introduced: 1.12.0
tags: [linux, macos, windows, systems]
- name: Arista LANZ Consumer
id: lanz
description: |
The Arista LANZ Consumer input plugin provides a consumer for use with Arista Networks’ Latency Analyzer (LANZ).
Metrics are read from a stream of data via TCP through port 50001 on the switch's management IP. Data is in Protobuffers format.
For more information, see [Arista LANZ](https://www.arista.com/en/um-eos/eos-latency-analyzer-lanz).
introduced: 1.14.0
tags: [linux, macos, windows, networking]
- name: Azure Storage Queue
id: azure_storage_queue
description: |
The Azure Storage Queue plugin gathers sizes of Azure Storage Queues.
introduced: 1.13.0
tags: [linux, macos, windows, systems, cloud]
- name: Bcache
id: bcache
description: |
The Bcache input plugin gets bcache statistics from the `stats_total` directory and `dirty_data` file.
introduced: 0.2.0
tags: [linux, macos, windows, systems]
- name: Beat
id: beat
description: |
The Beat input plugin collects metrics from the given Elastic Beat instances.
introduced: 1.18.0
tags: [linux, macos, windows, applications]
- name: Beanstalkd
id: beanstalkd
description: |
The Beanstalkd input plugin collects server stats as well as tube stats
(reported by `stats` and `stats-tube` commands respectively).
introduced: 1.8.0
tags: [linux, macos, windows, messaging]
- name: Big Blue Button
id: bigbluebutton
description: |
The BigBlueButton Input Plugin gathers metrics from a BigBlueButton server.
introduced: 1.19.0
tags: [external]
external: true
- name: BIND 9 Nameserver Statistics
id: bind
description: |
plugin decodes the JSON or XML statistics provided by BIND 9 nameservers.
introduced: 1.11.0
tags: [linux, macos, windows, netoworking]
- name: Bond
id: bond
description: |
The Bond input plugin collects network bond interface status, bond's slaves
interfaces status and failures count of bond's slaves interfaces.
The plugin collects these metrics from `/proc/net/bonding/*` files.
introduced: 1.5.0
tags: [linux, macos, windows, networking]
- name: Burrow
id: burrow
description: |
The Burrow input plugin collects Apache Kafka topic, consumer, and partition
status using the [Burrow](https://github.com/linkedin/Burrow)
[HTTP Endpoint](https://github.com/linkedin/Burrow/wiki/HTTP-Endpoint).
introduced: 1.7.0
tags: [linux, macos, windows, messaging]
- name: Cassandra
id: cassandra
description: |
*Deprecated in Telegraf 1.7.0 in favor of the [jolokia2](#jolokia2_agent) input plugin.
See [example Jolokia2/Cassandra configurations](https://github.com/influxdata/telegraf/blob/master/plugins/inputs/jolokia2/examples/cassandra.conf).*
The Cassandra input plugin collects Cassandra 3 / JVM metrics exposed as MBean
attributes through the jolokia REST endpoint.
All metrics are collected for each server configured.
introduced: 0.12.1
deprecated: 1.6.4
tags: [linux, macos, windows, data-stores]
- name: Ceph Storage
id: ceph
description: |
The Ceph Storage input plugin collects performance metrics from the MON and OSD nodes in a Ceph storage cluster.
introduced: 0.13.1
tags: [linux, macos, windows, data-stores]
- name: CGroup
id: cgroup
description: |
The CGroup input plugin captures specific statistics per cgroup.
introduced: 1.0.0
tags: [linux, macos, windows, systems]
- name: Chrony
id: chrony
description: |
The Chrony input plugin gets standard chrony metrics, requires chronyc executable.
introduced: 0.13.1
tags: [linux, macos, windows, networking, systems]
- name: Cisco GNMI Telemetry
id: cisco_telemetry_gnmi
description: |
> The `inputs.cisco_telementry_gnmi` plugin was renamed to `inputs.gmni`
in **Telegraf 1.15.0** to better reflect its general support for gNMI devices.
See the [gNMI plugin](#gnmi).
Cisco GNMI Telemetry input plugin consumes telemetry data similar to the GNMI specification.
This GRPC-based protocol can utilize TLS for authentication and encryption.
This plugin has been developed to support GNMI telemetry as produced by Cisco IOS XR (64-bit) version 6.5.1 and later.
introduced: 1.11.0
deprecated: 1.14.5
link: https://github.com/influxdata/telegraf/tree/release-1.14/plugins/inputs/cisco_telemetry_gnmi
tags: [linux, macos, windows, applications]
- name: Cisco Model-driven Telemetry (MDT)
id: cisco_telemetry_mdt
description: |
Cisco model-driven telemetry (MDT) is an input plugin that consumes telemetry data from Cisco IOS XR, IOS XE and NX-OS platforms.
It supports TCP & GRPC dialout transports. GRPC-based transport can utilize TLS for authentication and encryption.
Telemetry data is expected to be GPB-KV (self-describing-gpb) encoded.
introduced: 1.11.0
tags: [linux, macos, windows, applications]
- name: ClickHouse
id: clickhouse
description: |
The ClickHouse input plugin gathers statistics from a [ClickHouse](https://github.com/ClickHouse/ClickHouse) server, an open source
column-oriented database management system that lets you generate analytical data reports in real time.
introduced: 1.14.0
tags: [linux, macos, windows, servers, systems]
- name: Conntrack
id: conntrack
description: |
The Conntrack input plugin collects stats from Netfilter's conntrack-tools.
The conntrack-tools provide a mechanism for tracking various aspects of
network connections as they are processed by netfilter.
At runtime, conntrack exposes many of those connection statistics within `/proc/sys/net`.
Depending on your kernel version, these files can be found in either `/proc/sys/net/ipv4/netfilter`
or `/proc/sys/net/netfilter` and will be prefixed with either `ip_` or `nf_`.
This plugin reads the files specified in its configuration and publishes each one as a field,
with the prefix normalized to `ip_`.
introduced: 1.0.0
tags: [linux, macos, windows, networking]
- name: Consul
id: consul
description: |
The Consul input plugin will collect statistics about all health checks registered in the Consul.
It uses Consul API to query the data.
It will not report the telemetry but Consul can report those stats already using StatsD protocol, if needed.
introduced: 1.0.0
tags: [linux, macos, windows, build-deploy, containers]
- name: Couchbase
id: couchbase
description: |
The Couchbase input plugin reads per-node and per-bucket metrics from Couchbase.
introduced: 0.12.0
tags: [linux, macos, windows, data-stores]
- name: CouchDB
id: couchdb
description: |
The CouchDB input plugin gathers metrics of CouchDB using `_stats` endpoint.
introduced: 0.10.3
tags: [linux, macos, windows, data-stores]
- name: CPU
id: cpu
description: |
The CPU input plugin gathers metrics about cpu usage.
introduced: 0.1.5
tags: [linux, macos, windows, systems]
- name: CS:GO
id: csgo
description: |
The CSGO input plugin gahers metrics from Counter-Strike: Global Offensive servers.
introduced: 1.18.0
tags: [linux, macos, windows, web, servers]
- name: Disk
id: disk
description: |
The Disk input plugin gathers metrics about disk usage by mount point.
introduced: 0.1.1
tags: [linux, macos, windows, systems]
- name: DiskIO
id: diskio
description: |
The DiskIO input plugin gathers metrics about disk IO by device.
introduced: 0.10.0
tags: [linux, macos, windows, systems]
- name: Directory Monitoring
id: directory_monitor
description: |
The Directory Monitoring input plugin monitors a single directory and takes in each file placed in the directory. The plugin gathers all files in the directory at a configurable interval, and parses the ones that haven't been picked up yet.
introduced: 1.18.0
tags: [linux, macos, windows, systems]
- name: Disque
id: disque
description: |
The Disque input plugin gathers metrics from one or more [Disque](https://github.com/antirez/disque) servers.
introduced: 0.10.0
tags: [linux, macos, windows, messaging]
- name: DMCache
id: dmcache
description: |
The DMCache input plugin provides a native collection for dmsetup-based statistics for dm-cache.
introduced: 1.3.0
tags: [linux, macos, windows, systems]
- name: DNS Query
id: dns_query
description: |
The DNS Query input plugin gathers DNS query times in milliseconds -
like [Dig](https://en.wikipedia.org/wiki/Dig_(command)).
introduced: 1.4.0
tags: [linux, macos, windows, networking]
- name: dnsmasq
id: dnsmasq
description: |
This plugin gathers dnsmasq statistics on the DNS side.
introduced: 1.19.0
tags: [external]
external: true
- name: Docker
id: docker
description: |
The Docker input plugin uses the Docker Engine API to gather metrics on running Docker containers.
The Docker plugin uses the [Official Docker Client](https://github.com/moby/moby/tree/master/client)
to gather stats from the [Engine API](https://docs.docker.com/engine/api/v1.20/) library documentation.
introduced: 0.1.9
tags: [linux, macos, windows, build-deploy, containers]
- name: Docker Log
id: docker_log
description: |
The Docker Log input plugin uses the Docker Engine API to collect logs from running Docker containers.
The plugin uses the [Official Docker Client](https://github.com/moby/moby/tree/master/client)
to gather logs from the [Engine API](https://docs.docker.com/engine/api/v1.24/).
> This plugin works only for containers with the local or `json-file` or `journald` logging driver.
introduced: 1.12.0
tags: [linux, macos, windows, build-deploy, containers, logging]
- name: Dovecot
id: dovecot
description: |
The Dovecot input plugin uses the dovecot Stats protocol to gather metrics on configured domains.
For more information, see the [Dovecot documentation](http://wiki2.dovecot.org/Statistics).
introduced: 0.10.3
tags: [linux, macos, windows, applications, web]
- name: 389 Directory Server Input Plugin
id: ds389
description: |
This plugin gathers metrics from 389 Directory Servers' cn=Monitor backend.
introduced: 1.19.0
tags: [external]
external: true
- name: Elasticsearch
id: elasticsearch
description: |
The Elasticsearch input plugin queries endpoints to obtain [node](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html)
and optionally [cluster-health](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html)
or [cluster-stats](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html) metrics.
introduced: 0.1.5
tags: [linux, macos, windows, data-stores]
- name: Elasticsearch Query
id: elasticsearch_query
description: |
This elasticsearch query plugin queries endpoints to obtain metrics from data stored in an Elasticsearch cluster.
introduced: 1.20.0
tags: [linux, macos, windows, data-stores]
- name: Ethtool
id: ethtool
description: |
The Ethtool plugin gathers ethernet device statistics.
The network device and driver determine what fields are gathered.
introduced: 1.13.0
tags: [linux, macos, windows, networking, servers]
- name: Event Hub Consumer
id: eventhub_consumer
description: |
The Event Hub Consumer input plugin provides a consumer for use with Azure Event Hubs and Azure IoT Hub.
introduced: 1.14.0
tags: [linux, macos, windows, iot]
- name: Exec
id: exec
description: |
The Exec input plugin parses supported [Telegraf input data formats](/{{< latest "telegraf" >}}/data_formats/input/)
(line protocol, JSON, Graphite, Value, Nagios, Collectd, and Dropwizard) into metrics.
Each Telegraf metric includes the measurement name, tags, fields, and timestamp.
introduced: 0.1.5
tags: [linux, macos, windows]
- name: Execd
id: execd
description: |
The Execd input plugin runs an external program as a daemon. Programs must output metrics in an accepted
[Telegraf input data format](/{{< latest "telegraf" >}}/data_formats/input/)
on its standard output. Configure `signal` to send a signal to the daemon running on each collection interval.
The program output on standard error is mirrored to the Telegraf log.
introduced: 1.14.0
tags: [linux, macos, windows]
- name: Fail2ban
id: fail2ban
description: |
The Fail2ban input plugin gathers the count of failed and banned IP addresses
using [fail2ban](https://www.fail2ban.org/).
introduced: 1.4.0
tags: [linux, macos, windows, networking, security]
- name: Fibaro
id: fibaro
description: |
The Fibaro input plugin makes HTTP calls to the Fibaro controller API to gather values of hooked devices.
Those values could be true (`1`) or false (`0`) for switches, percentage for dimmers, temperature, etc.
introduced: 1.7.0
tags: [linux, macos, windows, iot]
- name: File
id: file
description: |
The File input plugin updates a list of files every interval and parses
the contents using the selected input data format.
Files will always be read in their entirety. If you wish to tail or follow a file,
then use the [Tail input plugin](#tail).
> To parse metrics from multiple files that are formatted in one of the supported
> [input data formats](/{{< latest "telegraf" >}}/data_formats/input),
> use the [Multifile input plugin](#multifile).
introduced: 1.8.0
tags: [linux, macos, windows, systems]
- name: Filecount
id: filecount
description: |
The Filecount input plugin reports the number and total size of files in directories that match certain criteria.
introduced: 1.8.0
tags: [linux, macos, windows, systems]
- name: Filestat
id: filestat
description: |
The Filestat input plugin gathers metrics about file existence, size, and other stats.
introduced: 0.13.0
tags: [linux, macos, windows, systems]
- name: Fireboard
id: fireboard
description: |
The Fireboard input plugin gathers real time temperature data from Fireboard thermometers.
To use this input plugin, sign up to use the [Fireboard REST API](https://docs.fireboard.io/reference/restapi.html).
introduced: 1.12.0
tags: [linux, macos, windows, cloud, Io]
- name: Fluentd
id: fluentd
description: |
The Fluentd input plugin gathers Fluentd server metrics from plugin endpoint provided by in_monitor plugin.
This plugin understands data provided by `/api/plugin.json` resource (`/api/config.json` is not covered).
introduced: 1.4.0
tags: [linux, macos, windows, servers]
- name: GitHub
id: github
description: |
Gathers repository information from GitHub-hosted repositories.
introduced: 1.11.0
tags: [linux, macos, windows, applications]
- name: gNMI
id: gnmi
description: |
The gNMI plugin consumes telemetry data based on the
[gNMI](https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md) `Subscribe` method.
The plugin supports TLS for authentication and encryption.
This input plugin is vendor-agnostic and is supported on any platform that supports the gNMI spec.
**For Cisco devices:**
The gNMI plugin is optimized to support gNMI telemetry as produced by
Cisco IOS XR (64-bit) version 6.5.1, Cisco NX-OS 9.3 and Cisco IOS XE 16.12 and later.
introduced: 1.15.0
tags: [linux, macos, windows, applications]
- name: Google Cloud PubSub
id: cloud_pubsub
description: |
The Google Cloud PubSub input plugin ingests metrics from
[Google Cloud PubSub](https://cloud.google.com/pubsub) and creates metrics
using one of the supported [input data formats](https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md).
introduced: 1.10.0
tags: [linux, macos, windows, cloud, messaging]
- name: Google Cloud PubSub Push
id: cloud_pubsub_push
description: |
The Google Cloud PubSub Push (`cloud_pubsub_push`) input plugin listens for
messages sent using HTTP POST requests from Google Cloud PubSub.
The plugin expects messages in Google's Pub/Sub JSON Format ONLY.
The intent of the plugin is to allow Telegraf to serve as an endpoint of the
Google Pub/Sub 'Push' service. Google's PubSub service will only send over
HTTPS/TLS so this plugin must be behind a valid proxy or must be configured to use TLS.
introduced: 1.10.0
tags: [linux, macos, windows, cloud, messaging]
- name: Graylog
id: graylog
description: |
The Graylog input plugin can collect data from remote Graylog service URLs. This plugin currently supports two
types of endpoints:
- multiple (e.g., `http://[graylog-server-ip]:12900/system/metrics/multiple`)
- namespace (e.g., `http://[graylog-server-ip]:12900/system/metrics/namespace/{namespace}`)
introduced: 1.0.0
tags: [linux, macos, windows, logging]
- name: HAproxy
id: haproxy
description: |
The HAproxy input plugin gathers metrics directly from any running HAproxy instance.
It can do so by using CSV generated by HAproxy status page or from admin sockets.
introduced: 0.1.5
tags: [linux, macos, windows, networking, web]
- name: Hddtemp
id: hddtemp
description: |
The Hddtemp input plugin reads data from `hddtemp` daemons.
introduced: 1.0.0
tags: [linux, macos, windows, systems]
- name: HTTP
id: http
description: |
The HTTP input plugin collects metrics from one or more HTTP (or HTTPS) endpoints.
The endpoint should have metrics formatted in one of the [supported input data formats](/{{< latest "telegraf" >}}/data_formats/input/).
Each data format has its own unique set of configuration options which can be added to the input configuration.
introduced: 1.6.0
tags: [linux, macos, windows, servers, web]
- name: HTTP JSON
id: httpjson
description: |
*Deprecated in Telegraf 1.6.0. Use the [HTTP input plugin](#http).*
The HTTP JSON input plugin collects data from HTTP URLs which respond with JSON.
It flattens the JSON and finds all numeric values, treating them as floats.
introduced: 0.1.6
deprecated: 1.5.3
tags: [linux, macos, windows, servers, web]
- name: HTTP Listener
id: http_listener
description: |
The `http_listener` input plugin was renamed to [`influxdb_listener`](#influxdb_listener).
The new name better describes the intended use of the plugin as a InfluxDB relay.
For general purpose transfer of metrics in any format via HTTP, use [`http_listener_v2`](#http_listener_v2)instead.
link: https://github.com/influxdata/telegraf/blob/release-1.8/plugins/inputs/http_listener/README.md
introduced: 1.1.0
deprecated: 1.8.3
tags: [linux, macos, windows, servers, web]
- name: HTTP Listener v2
id: http_listener_v2
description: |
The HTTP Listener v2 input plugin listens for metrics sent via HTTP.
Metrics may be sent in any supported [Telegraf input data format](/{{< latest "telegraf" >}}/data_formats/input/influx).
Note the plugin previously known as `http_listener` has been renamed `influxdb_listener`.
To use Telegraf as a proxy/relay for InfluxDB, we recommend using [`influxdb_listener`](/{{< latest "telegraf" >}}/plugins/#influxdb_listener).
introduced: 1.9.0
tags: [linux, macos, windows, servers, web]
- name: HTTP Response
id: http_response
description: |
The HTTP Response input plugin gathers metrics for HTTP responses.
The measurements and fields include `response_time`, `http_response_code`,
and `result_type`. Tags for measurements include `server` and `method`.
introduced: 0.12.1
tags: [linux, macos, windows, servers, web]
- name: Icinga 2
id: icinga2
description: |
The Icinga 2 input plugin gather status on running services and hosts using
the [Icinga 2 API](https://docs.icinga.com/icinga2/latest/doc/module/icinga2/chapter/icinga2-api).
introduced: 1.8.0
tags: [linux, macos, windows, networking, servers, systems]
- name: InfiniBand
id: infiniband
description: |
The InfiniBand input plugin gathers statistics for all InfiniBand devices and ports on the system.
Counters are stored in `/sys/class/infiniband/<dev>/port/<port>/counters/`.
introduced: 1.14.0
tags: [linux, systems]
- name: InfluxDB v1.x
id: influxdb
description: |
The InfluxDB v1.x input plugin gathers metrics from the exposed InfluxDB v1.x `/debug/vars` endpoint.
Using Telegraf to extract these metrics to create a "monitor of monitors" is a
best practice and allows you to reduce the overhead associated with capturing
and storing these metrics locally within the `_internal` database for production deployments.
[Read more about this approach here](https://www.influxdata.com/blog/influxdb-debugvars-endpoint/).
introduced: 0.2.5
tags: [linux, macos, windows, data-stores]
- name: InfluxDB v2
id: influxdb
description: |
InfluxDB 2.x exposes its metrics using the Prometheus Exposition Format — there is no InfluxDB v2 input
plugin.
To collect data on an InfluxDB 2.x instance running on localhost, the configuration for the
Prometheus input plugin would be:
<div class="keep-url"></div>
```toml
[[inputs.prometheus]]
## An array of urls to scrape metrics from.
urls = ["http://localhost:8086/metrics"]
```
introduced: 1.8.0
tags: [linux, macos, windows, data-stores]
- name: InfluxDB Listener
id: influxdb_listener
description: |
The InfluxDB Listener input plugin listens for requests sent
according to the [InfluxDB HTTP API](/influxdb/v1.8/guides/write_data/).
The intent of the plugin is to allow Telegraf to serve as a proxy, or router,
for the HTTP `/write` endpoint of the InfluxDB HTTP API.
> This plugin was previously known as `http_listener`.
> To send general metrics via HTTP, use the [HTTP Listener v2 input plugin](#http_listener_v2) instead.
>
> This plugin is compatible with **InfluxDB 1.x** only.
The `/write` endpoint supports the `precision` query parameter and can be
set to `ns`, `u`, `ms`, `s`, `m`, `h`. Other parameters are ignored and
defer to the output plugins configuration.
When chaining Telegraf instances using this plugin, `CREATE DATABASE` requests
receive a `200 OK` response with message body `{"results":[]}` but they are not
relayed. The output configuration of the Telegraf instance which ultimately
submits data to InfluxDB determines the destination database.
introduced: 1.9.0
tags: [linux, macos, windows, data-stores]
- name: InfluxDB v2 Listener
id: influxdb_v2_listener
description: |
The InfluxDB v2 Listener input plugin listens for requests sent
according to the [InfluxDB HTTP API](/{{< latest "influxdb" >}}/reference/api/).
The intent of the plugin is to allow Telegraf to serve as a proxy, or router,
for the HTTP `/api/v2/write` endpoint of the InfluxDB HTTP API.
The `/api/v2/write` endpoint supports the `precision` query parameter and
can be set to `ns`, `u`, `ms`, or `s`. Other parameters are ignored and
defer to the output plugins configuration.
introduced: 1.16.0
tags: [linux, macos, windows, data-stores]
- name: Intel Powerstat
id: intel_powerstat
description: |
The Intel Powerstat input plugin collects information provided by the monitoring features of Intel Powerstat.
introduced: 1.17.0
tags: [linux]
- name: Intel Data Plane Development Kit (DPDK)
id: dpdk
description: |
The DPDK plugin collects metrics exposed by applications built with Data Plane Development Kit, an extensive set of open source libraries designed for accelerating packet processing workloads.
introduced: 1.19.0
tags: [networking]
- name: Intel RDT
id: intel_rdt
description: |
The Intel RDT input plugin collects information provided by the monitoring features of Intel Resource Director Technology (RDT).
introduced: 1.16.0
tags: [linux, macos, windows, systems]
- name: Internet Speed Monitor
id: internet_speed
description: |
The Internet Speed Monitor plugin collects data about the internet speed on the system.
introduced: 1.20.0
tags: [linux, macos, windows, systems, iot, networking]
- name: Interrupts
id: interrupts
description: |
The Interrupts input plugin gathers metrics about IRQs, including `interrupts`
(from `/proc/interrupts`) and `soft_interrupts` (from `/proc/softirqs`).
introduced: 1.3.0
tags: [linux, macos, windows, systems]
- name: IPMI Sensor
id: ipmi_sensor
description: |
The IPMI Sensor input plugin queries the local machine or remote host
sensor statistics using the `ipmitool` utility.
introduced: 0.12.0
tags: [linux, macos, windows, iot]
- name: Ipset
id: ipset
description: |
The Ipset input plugin gathers packets and bytes counters from Linux `ipset`.
It uses the output of the command `ipset save`. Ipsets created without the `counters` option are ignored.
introduced: 1.6.0
tags: [linux, macos, windows, networking, security, systems]
- name: IPtables
id: iptables
description: |
The IPtables input plugin gathers packets and bytes counters for rules within
a set of table and chain from the Linux iptables firewall.
introduced: 1.1.0
tags: [linux, macos, windows, systems]
- name: IPVS
id: ipvs
description: |
The IPVS input plugin uses the Linux kernel netlink socket interface to
gather metrics about IPVS virtual and real servers.
introduced: 1.9.0
tags: [linux, macos, windows, systems]
- name: Jenkins
id: jenkins
description: |
The Jenkins input plugin gathers information about the nodes and jobs running
in a jenkins instance.
This plugin does not require a plugin on Jenkins and it makes use of Jenkins
API to retrieve all the information needed.
introduced: 1.9.0
tags: [linux, macos, windows, build-deploy]
- name: Jolokia
id: jolokia
description: |
*Deprecated in Telegraf 1.5.0. Use the [Jolokia2 input plugin](#jolokia2_agent).*
introduced: 0.2.1
deprecated: 1.4.5
tags: [linux, macos, windows, networking]
- name: Jolokia2 Agent
id: jolokia2_agent
description: |
The Jolokia2 Agent input plugin reads JMX metrics from one or more
[Jolokia](https://jolokia.org/) agent REST endpoints using the
[JSON-over-HTTP protocol](https://jolokia.org/reference/html/protocol.html).
link: https://github.com/influxdata/telegraf/blob/master/plugins/inputs/jolokia2/README.md
introduced: 1.5.0
tags: [linux, macos, windows, networking]
- name: Jolokia2 Proxy
id: jolokia2_proxy
description: |
The Jolokia2 Proxy input plugin reads JMX metrics from one or more targets by
interacting with a [Jolokia](https://jolokia.org/) proxy REST endpoint using the
[Jolokia](https://jolokia.org/) [JSON-over-HTTP protocol](https://jolokia.org/reference/html/protocol.html).
link: https://github.com/influxdata/telegraf/blob/master/plugins/inputs/jolokia2/README.md
introduced: 1.5.0
tags: [linux, macos, windows, networking]
- name: JTI OpenConfig Telemetry
id: jti_openconfig_telemetry
description: |
The JTI OpenConfig Telemetry input plugin reads Juniper Networks implementation
of OpenConfig telemetry data from listed sensors using the Junos Telemetry Interface.
Refer to [openconfig.net](http://openconfig.net/) for more details about OpenConfig
and [Junos Telemetry Interface (JTI)](https://www.juniper.net/documentation/en_US/junos/topics/concept/junos-telemetry-interface-oveview.html).
introduced: 1.7.0
tags: [linux, macos, windows, iot]
- name: Kapacitor
id: kapacitor
description: |
The Kapacitor input plugin will collect metrics from the given Kapacitor instances.
introduced: 1.3.0
tags: [linux, macos, windows, applications]
- name: Kernel
id: kernel
description: |
The Kernel input plugin gathers kernel statistics from `/proc/stat`.
introduced: 0.11.0
tags: [linux, macos, windows, systems]
- name: Kernel VMStat
id: kernel_vmstat
description: |
The Kernel VMStat input plugin gathers kernel statistics from `/proc/vmstat`.
introduced: 1.0.0
tags: [linux, macos, windows, systems]
- name: Kibana
id: kibana
description: |
The Kibana input plugin queries the Kibana status API to obtain the health
status of Kibana and some useful metrics.
introduced: 1.8.0
tags: [linux, macos, windows, applications]
- name: KNX
id: knx_listener
description: |
The KNX input plugin that listens for messages on the KNX (Konnex) home-automation bus.
introduced: 1.19.0
tags: [iot]
- name: Kubernetes
id: kubernetes
description: |
> The Kubernetes input plugin is experimental and may cause high cardinality
> issues with moderate to large Kubernetes deployments.
The Kubernetes input plugin talks to the kubelet API using the `/stats/summary`
endpoint to gather metrics about the running pods and containers for a single host.
It is assumed that this plugin is running as part of a daemonset within a
Kubernetes installation. This means that Telegraf is running on every node within the cluster.
Therefore, you should configure this plugin to talk to its locally running kubelet.
introduced: 1.1.0
tags: [linux, macos, windows, build-deploy, containers]
- name: Kubernetes Inventory
id: kube_inventory
description: |
The Kubernetes Inventory input plugin generates metrics derived from the state
of the following Kubernetes resources:
- daemonsets
- deployments
- nodes
- persistentvolumes
- persistentvolumeclaims
- pods (containers)
- statefulsets
introduced: 1.10.0
tags: [linux, macos, windows, build-deploy, containers]
- name: ldap_org
id: ldap_org
description: |
This plugin monitors the number of entries inside LDAP trees.
introduced: 1.19.0
tags: [external]
external: true
- name: LeoFS
id: leofs
description: |
The LeoFS input plugin gathers metrics of LeoGateway, LeoManager, and LeoStorage using SNMP.
See [System monitoring](https://leo-project.net/leofs/docs/admin/system_admin/monitoring/)
in the [LeoFS documentation](https://leo-project.net/leofs/docs/) for more information.
introduced: 0.1.5
tags: [linux, macos, windows, systems, data-stores]
- name: Linux Sysctl FS
id: linux_sysctl_fs
description: |
The Linux Sysctl FS input plugin provides Linux system level file (`sysctl fs`) metrics.
The documentation on these fields can be found [here](https://www.kernel.org/doc/Documentation/sysctl/fs.txt).
introduced: 1.3.0
tags: [linux, macos, windows, systems]
- name: Logparser
id: logparser
description: |
The Logparser input plugin streams and parses the given log files.
Currently, it has the capability of parsing "grok" patterns
from log files, which also supports regular expression (regex) patterns.
introduced: 1.0.0
tags: [linux, macos, windows, logging]
- name: Logstash
id: logstash
description: |
The Logstash input plugin reads metrics exposed by the [Logstash Monitoring API](https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html).
The plugin supports Logstash 5 and later.
introduced: 1.12.0
tags: [linux, macos, windows, logging]
- name: Lustre2
id: lustre2
description: |
Lustre Jobstats allows for RPCs to be tagged with a value, such as a job's ID.
This allows for per job statistics.
The Lustre2 input plugin collects statistics and tags the data with the `jobid`.
introduced: 0.1.5
tags: [linux, macos, windows, systems]
- name: Mailchimp
id: mailchimp
description: |
The Mailchimp input plugin gathers metrics from the `/3.0/reports` MailChimp API.
introduced: 0.2.4
tags: [linux, macos, windows, cloud, web]
- name: MarkLogic
id: marklogic
description: |
The MarkLogic input plugin gathers health status metrics from one or more MarkLogic hosts.
introduced: 1.12.0
tags: [linux, macos, windows, data-stores]
- name: Mcrouter
id: mcrouter
description: |