Collectd codec plugin
- Plugin version: v3.1.0
- Released on: 2021-08-04
- Changelog
For other versions, see theVersioned plugin docs.
For questions about the plugin, open a topic in theDiscuss forums. For bugs or feature requests, open an issue inGithub. For the list of Elastic supported plugins, please consult theElastic Support Matrix.
Read events from the collectd binary protocol over the network via udp. Seehttps://collectd.org/wiki/index.php/Binary_protocol
Configuration in your Logstash configuration file can be as simple as:
input { udp { port => 25826 buffer_size => 1452 codec => collectd { } }}
A samplecollectd.conf
to send to Logstash might be:
Hostname "host.example.com"LoadPlugin interfaceLoadPlugin loadLoadPlugin memoryLoadPlugin network<Plugin interface> Interface "eth0" IgnoreSelected false</Plugin><Plugin network> Server "10.0.0.1" "25826"</Plugin>
Be sure to replace10.0.0.1
with the IP of your Logstash instance.
Setting | Input type | Required |
---|---|---|
authfile | string | No |
nan_handling | string, one of["change_value", "warn", "drop"] | No |
nan_tag | string | No |
nan_value | number | No |
prune_intervals | boolean | No |
security_level | string, one of["None", "Sign", "Encrypt"] | No |
target | string | No |
typesdb | array | No |
- Value type isstring
- There is no default value for this setting.
Path to the authentication file. This file should have the same format as theAuthFile in collectd. You only need to set this option if thesecurity_level
is set toSign
orEncrypt
- Value can be any of:
change_value
,warn
,drop
- Default value is
"change_value"
What to do when a value in the event isNaN
(Not a Number)
- change_value (default): Change the
NaN
to the value of the nan_value option and addnan_tag
as a tag - warn: Change the
NaN
to the value of the nan_value option, print a warning to the log and addnan_tag
as a tag - drop: Drop the event containing the
NaN
(this only drops the single event, not the whole packet)
- Value type isstring
- Default value is
"_collectdNaN"
The tag to add to the event if aNaN
value was found Set this to an empty string ('') if you don’t want to tag
- Value type isnumber
- Default value is
0
Only relevant whennan_handeling
is set tochange_value
Change NaN to this configured value
- Value type isboolean
- Default value is
true
Prune interval records. Defaults totrue
.
- Value can be any of:
None
,Sign
,Encrypt
- Default value is
"None"
Security Level. Default isNone
. This setting mirrors the setting from the collectdNetwork plugin
- Value type isstring
- There is no default value for this setting.
Define the target field for placing the decoded values. If this setting is not set, data will be stored at the root (top level) of the event.
For example, if you want data to be put under thedocument
field:
input { udp { port => 12345 codec => collectd { target => "[document]" } }}
- Value type isarray
- There is no default value for this setting.
File path(s) to collectdtypes.db
to use. The last matching pattern wins if you have identical pattern names in multiple files. If no types.db is provided the includedtypes.db
will be used (currently 5.4.0).