logstash

package
v1.21.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 15, 2021 License: MIT Imports: 13 Imported by: 1

README

Logstash Input Plugin

This plugin reads metrics exposed by Logstash Monitoring API.

Logstash 5 and later is supported.

Configuration

[[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

  ## 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
      • 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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type JVMStats 

type JVMStats struct {
	ID      string      `json:"id"`
	JVM     interface{} `json:"jvm"`
	Name    string      `json:"name"`
	Host    string      `json:"host"`
	Version string      `json:"version"`
}

type Logstash 

type Logstash struct {
	URL string `toml:"url"`

	SinglePipeline bool     `toml:"single_pipeline"`
	Collect        []string `toml:"collect"`

	Username string            `toml:"username"`
	Password string            `toml:"password"`
	Headers  map[string]string `toml:"headers"`
	Timeout  config.Duration   `toml:"timeout"`
	tls.ClientConfig
	// contains filtered or unexported fields
}

func NewLogstash 

func NewLogstash() *Logstash

NewLogstash create an instance of the plugin with default settings

func (*Logstash) Description 

func (logstash *Logstash) Description() string

Description returns short info about plugin

func (*Logstash) Gather 

func (logstash *Logstash) Gather(accumulator telegraf.Accumulator) error

Gather ask this plugin to start gathering metrics

func (*Logstash) Init 

func (logstash *Logstash) Init() error

func (*Logstash) SampleConfig 

func (logstash *Logstash) SampleConfig() string

SampleConfig returns details how to configure plugin

type Pipeline 

type Pipeline struct {
	Events  interface{}     `json:"events"`
	Plugins PipelinePlugins `json:"plugins"`
	Reloads interface{}     `json:"reloads"`
	Queue   PipelineQueue   `json:"queue"`
}

type PipelinePlugins 

type PipelinePlugins struct {
	Inputs  []Plugin `json:"inputs"`
	Filters []Plugin `json:"filters"`
	Outputs []Plugin `json:"outputs"`
}

type PipelineQueue 

type PipelineQueue struct {
	Events              float64     `json:"events"`
	EventsCount         *float64    `json:"events_count"`
	Type                string      `json:"type"`
	Capacity            interface{} `json:"capacity"`
	Data                interface{} `json:"data"`
	QueueSizeInBytes    *float64    `json:"queue_size_in_bytes"`
	MaxQueueSizeInBytes *float64    `json:"max_queue_size_in_bytes"`
}

type PipelineStats 

type PipelineStats struct {
	ID       string   `json:"id"`
	Pipeline Pipeline `json:"pipeline"`
	Name     string   `json:"name"`
	Host     string   `json:"host"`
	Version  string   `json:"version"`
}

type PipelinesStats 

type PipelinesStats struct {
	ID        string              `json:"id"`
	Pipelines map[string]Pipeline `json:"pipelines"`
	Name      string              `json:"name"`
	Host      string              `json:"host"`
	Version   string              `json:"version"`
}

type Plugin 

type Plugin struct {
	ID           string                 `json:"id"`
	Events       interface{}            `json:"events"`
	Name         string                 `json:"name"`
	BulkRequests map[string]interface{} `json:"bulk_requests"`
	Documents    map[string]interface{} `json:"documents"`
}

type ProcessStats 

type ProcessStats struct {
	ID      string      `json:"id"`
	Process interface{} `json:"process"`
	Name    string      `json:"name"`
	Host    string      `json:"host"`
	Version string      `json:"version"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.