IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Logstash Reference [5.1] ›Codec plugins
« cloudtrail compress_spooler »

collectdedit

  • Version: 3.0.2
  • Released on: 2016-07-14
  • Changelog
  • Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

encoding utf-8

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

collectd {
  }

Available configuration options:

Setting Input type Required Default value

authfile

string

No

enable_metric

boolean

No

true

id

string

No

nan_handling

string, one of ["change_value", "warn", "drop"]

No

"change_value"

nan_tag

string

No

"_collectdNaN"

nan_value

number

No

0

prune_intervals

boolean

No

true

security_level

string, one of ["None", "Sign", "Encrypt"]

No

"None"

typesdb

array

No

Detailsedit

 

authfileedit

  • Value type is string
  • There is no default value for this setting.

Path to the authentication file. This file should have the same format as the AuthFile in collectd. You only need to set this option if the security_level is set to Sign or Encrypt

enable_metricedit

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

idedit

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

nan_handlingedit

  • Value can be any of: change_value, warn, drop
  • Default value is "change_value"

What to do when a value in the event is NaN (Not a Number)

  • change_value (default): Change the NaN to the value of the nan_value option and add nan_tag as a tag
  • warn: Change the NaN to the value of the nan_value option, print a warning to the log and add nan_tag as a tag
  • drop: Drop the event containing the NaN (this only drops the single event, not the whole packet)

nan_tagedit

  • Value type is string
  • Default value is "_collectdNaN"

The tag to add to the event if a NaN value was found Set this to an empty string ('') if you don’t want to tag

nan_valueedit

  • Value type is number
  • Default value is 0

Only relevant when nan_handeling is set to change_value Change NaN to this configured value

prune_intervalsedit

  • Value type is boolean
  • Default value is true

Prune interval records. Defaults to true.

security_leveledit

  • Value can be any of: None, Sign, Encrypt
  • Default value is "None"

Security Level. Default is None. This setting mirrors the setting from the collectd Network plugin

typesdbedit

  • Value type is array
  • There is no default value for this setting.

File path(s) to collectd types.db to use. The last matching pattern wins if you have identical pattern names in multiple files. If no types.db is provided the included types.db will be used (currently 5.4.0).

« cloudtrail compress_spooler »