--- title: Telegraf Documentation description: Telegraf plugin for collecting metrics from Logstash url: https://docs.influxdata.com/telegraf/v1/input-plugins/logstash/ estimated_tokens: 2930 product: Telegraf version: v1 --- - Telegraf v1.12.0+ # Logstash Input Plugin This plugin gathers metrics from a [Logstash](https://www.elastic.co/logstash) endpoint using the [Monitoring API](https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html). This plugin supports Logstash 5+. **Introduced in:** Telegraf v1.12.0 **Tags:** server **OS support:** all ## Global configuration options Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details. ## Configuration ```toml # Read metrics exposed by Logstash [[inputs.logstash]] ## The URL of the exposed Logstash API endpoint. url = "http://127.0.0.1:9600" ## Use Logstash 5 single pipeline API, set to true when monitoring ## Logstash 5. # single_pipeline = false ## Enable optional collection components. Can contain ## "pipelines", "process", and "jvm". # collect = ["pipelines", "process", "jvm"] ## Timeout for HTTP requests. # timeout = "5s" ## Optional HTTP Basic Auth credentials. # username = "username" # password = "pa$$word" ## Optional TLS Config. # tls_ca = "/etc/telegraf/ca.pem" # tls_cert = "/etc/telegraf/cert.pem" # tls_key = "/etc/telegraf/key.pem" ## Use TLS but skip chain & host verification. # insecure_skip_verify = false ## If 'use_system_proxy' is set to true, Telegraf will check env vars such as ## HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or their lowercase counterparts). ## If 'use_system_proxy' is set to false (default) and 'http_proxy_url' is ## provided, Telegraf will use the specified URL as HTTP proxy. # use_system_proxy = false # http_proxy_url = "http://localhost:8888" ## Optional HTTP headers. # [inputs.logstash.headers] # "X-Special-Header" = "Special-Value" ``` ## Metrics Additional plugin stats may be collected (because logstash doesn’t consistently expose all stats) - logstash\_jvm - tags: - node\_id - node\_name - node\_host - node\_version - fields: - threads\_peak\_count - mem\_pools\_survivor\_peak\_max\_in\_bytes - mem\_pools\_survivor\_max\_in\_bytes - mem\_pools\_old\_peak\_used\_in\_bytes - mem\_pools\_young\_used\_in\_bytes - mem\_non\_heap\_committed\_in\_bytes - threads\_count - mem\_pools\_old\_committed\_in\_bytes - mem\_pools\_young\_peak\_max\_in\_bytes - mem\_heap\_used\_percent - gc\_collectors\_young\_collection\_time\_in\_millis - mem\_pools\_survivor\_peak\_used\_in\_bytes - mem\_pools\_young\_committed\_in\_bytes - gc\_collectors\_old\_collection\_time\_in\_millis - gc\_collectors\_old\_collection\_count - mem\_pools\_survivor\_used\_in\_bytes - mem\_pools\_old\_used\_in\_bytes - mem\_pools\_young\_max\_in\_bytes - mem\_heap\_max\_in\_bytes - mem\_non\_heap\_used\_in\_bytes - mem\_pools\_survivor\_committed\_in\_bytes - mem\_pools\_old\_max\_in\_bytes - mem\_heap\_committed\_in\_bytes - mem\_pools\_old\_peak\_max\_in\_bytes - mem\_pools\_young\_peak\_used\_in\_bytes - mem\_heap\_used\_in\_bytes - gc\_collectors\_young\_collection\_count - uptime\_in\_millis - logstash\_process - tags: - node\_id - node\_name - source - node\_version - fields: - open\_file\_descriptors - cpu\_load\_average\_1m - cpu\_load\_average\_5m - cpu\_load\_average\_15m - cpu\_total\_in\_millis - cpu\_percent - peak\_open\_file\_descriptors - max\_file\_descriptors - mem\_total\_virtual\_in\_bytes - mem\_total\_virtual\_in\_bytes - logstash\_events - tags: - node\_id - node\_name - source - node\_version - pipeline (for Logstash 6+) - fields: - queue\_push\_duration\_in\_millis - duration\_in\_millis - in - filtered - out - logstash\_plugins - tags: - node\_id - node\_name - source - node\_version - pipeline (for Logstash 6+) - plugin\_id - plugin\_name - plugin\_type - fields: - queue\_push\_duration\_in\_millis (for input plugins only) - duration\_in\_millis - in - out - failures(if exists) - bulk\_requests\_failures (for Logstash 7+) - bulk\_requests\_with\_errors (for Logstash 7+) - documents\_successes (for logstash 7+) - documents\_retryable\_failures (for logstash 7+) - logstash\_queue - tags: - node\_id - node\_name - source - node\_version - pipeline (for Logstash 6+) - queue\_type - fields: - events - free\_space\_in\_bytes - max\_queue\_size\_in\_bytes - max\_unread\_events - page\_capacity\_in\_bytes - queue\_size\_in\_bytes ## Example Output ```text logstash_jvm,node_id=3da53ed0-a946-4a33-9cdb-33013f2273f6,node_name=debian-stretch-logstash6.virt,node_version=6.8.1,source=debian-stretch-logstash6.virt gc_collectors_old_collection_count=2,gc_collectors_old_collection_time_in_millis=100,gc_collectors_young_collection_count=26,gc_collectors_young_collection_time_in_millis=1028,mem_heap_committed_in_bytes=1056309248,mem_heap_max_in_bytes=1056309248,mem_heap_used_in_bytes=207216328,mem_heap_used_percent=19,mem_non_heap_committed_in_bytes=160878592,mem_non_heap_used_in_bytes=140838184,mem_pools_old_committed_in_bytes=899284992,mem_pools_old_max_in_bytes=899284992,mem_pools_old_peak_max_in_bytes=899284992,mem_pools_old_peak_used_in_bytes=189468088,mem_pools_old_used_in_bytes=189468088,mem_pools_survivor_committed_in_bytes=17432576,mem_pools_survivor_max_in_bytes=17432576,mem_pools_survivor_peak_max_in_bytes=17432576,mem_pools_survivor_peak_used_in_bytes=17432576,mem_pools_survivor_used_in_bytes=12572640,mem_pools_young_committed_in_bytes=139591680,mem_pools_young_max_in_bytes=139591680,mem_pools_young_peak_max_in_bytes=139591680,mem_pools_young_peak_used_in_bytes=139591680,mem_pools_young_used_in_bytes=5175600,threads_count=20,threads_peak_count=24,uptime_in_millis=739089 1566425244000000000 logstash_process,node_id=3da53ed0-a946-4a33-9cdb-33013f2273f6,node_name=debian-stretch-logstash6.virt,node_version=6.8.1,source=debian-stretch-logstash6.virt cpu_load_average_15m=0.03,cpu_load_average_1m=0.01,cpu_load_average_5m=0.04,cpu_percent=0,cpu_total_in_millis=83230,max_file_descriptors=16384,mem_total_virtual_in_bytes=3689132032,open_file_descriptors=118,peak_open_file_descriptors=118 1566425244000000000 logstash_events,node_id=3da53ed0-a946-4a33-9cdb-33013f2273f6,node_name=debian-stretch-logstash6.virt,node_version=6.8.1,pipeline=main,source=debian-stretch-logstash6.virt duration_in_millis=0,filtered=0,in=0,out=0,queue_push_duration_in_millis=0 1566425244000000000 logstash_plugins,node_id=3da53ed0-a946-4a33-9cdb-33013f2273f6,node_name=debian-stretch-logstash6.virt,node_version=6.8.1,pipeline=main,plugin_id=2807cb8610ba7854efa9159814fcf44c3dda762b43bd088403b30d42c88e69ab,plugin_name=beats,plugin_type=input,source=debian-stretch-logstash6.virt out=0,queue_push_duration_in_millis=0 1566425244000000000 logstash_plugins,node_id=3da53ed0-a946-4a33-9cdb-33013f2273f6,node_name=debian-stretch-logstash6.virt,node_version=6.8.1,pipeline=main,plugin_id=7a6c973366186a695727c73935634a00bccd52fceedf30d0746983fce572d50c,plugin_name=file,plugin_type=output,source=debian-stretch-logstash6.virt duration_in_millis=0,in=0,out=0 1566425244000000000 logstash_queue,node_id=3da53ed0-a946-4a33-9cdb-33013f2273f6,node_name=debian-stretch-logstash6.virt,node_version=6.8.1,pipeline=main,queue_type=memory,source=debian-stretch-logstash6.virt events=0 1566425244000000000 ``` #### Related - [Configure plugins](/telegraf/v1/configure_plugins/) - [Logstash Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/logstash/README.md)