Defined Type: logstash::filter::csv

Defined in:
manifests/filter/csv.pp

Overview

Define: logstash::filter::csv

CSV filter. Takes an event field containing CSV data, parses it, and
stores it as individual fields (can optionally specify the names).

Parameters

add_field

If this filter is successful, add any arbitrary fields to this event. Example: filter { csv { add_field => [ “sample”, “Hello world, from %@source” ] } } On success, the csv plugin will then add field ‘sample’ with the value above and the %@source piece replaced with that value from the event. Value type is hash Default value: {} This variable is optional

add_tag

If this filter is successful, add arbitrary tags to the event. Tags can be dynamic and include parts of the event using the %field syntax. Example: filter { csv { add_tag => [ “foo_%somefield” ] } } If the event has field “somefield” == “hello” this filter, on success, would add a tag “foo_hello” Value type is array Default value: [] This variable is optional

columns

Define a list of column names (in the order they appear in the CSV, as if it were a header line). If this is not specified or there are not enough columns specified, the default column name is “columnX” (where X is the field number, starting from 1). This deprecates the ‘fields’ variable. Optional. Value type is array Default value: [] This variable is optional

exclude_tags

Only handle events without any of these tags. Note this check is additional to type and tags. Value type is array Default value: [] This variable is optional

remove_tag

If this filter is successful, remove arbitrary tags from the event. Tags can be dynamic and include parts of the event using the %field syntax. Example: filter { csv { remove_tag => [ “foo_%somefield” ] } } If the event has field “somefield” == “hello” this filter, on success, would remove the tag “foo_hello” if it is present Value type is array Default value: [] This variable is optional

separator

Define the column separator value. If this is not specified the default is a comma ‘,’ Optional. Value type is string Default value: “,” This variable is optional

source

The CSV data in the value of the source field will be expanded into a datastructure. This deprecates the regexp [A-Za-z0-9_-] variable. Value type is string Default value: None This variable is optional

tags

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional. Value type is array Default value: [] This variable is optional

target

Define target for placing the data Defaults to @fields Optional Value type is string Default value: “@fields” This variable is optional

type

The type to act on. If a type is given, then this filter will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional. Value type is string Default value: “” This variable is optional

order

The order variable decides in which sequence the filters are loaded. Value type is number Default value: 10 This variable is optional

instances

Array of instance names to which this define is. Value type is array Default value: [ ‘array’ ] This variable is optional

Extra information

This define is created based on LogStash version 1.1.12
Extra information about this filter can be found at:
http://logstash.net/docs/1.1.12/filters/csv

Need help? http://logstash.net/docs/1.1.12/learn

Authors

Parameters:

  • add_field (Any) (defaults to: '')
  • add_tag (Any) (defaults to: '')
  • columns (Any) (defaults to: '')
  • exclude_tags (Any) (defaults to: '')
  • remove_tag (Any) (defaults to: '')
  • separator (Any) (defaults to: '')
  • source (Any) (defaults to: '')
  • tags (Any) (defaults to: '')
  • target (Any) (defaults to: '')
  • type (Any) (defaults to: '')
  • order (Any) (defaults to: 10)
  • instances (Any) (defaults to: [ 'agent' ]) 


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
 
# File 'manifests/filter/csv.pp', line 116

define logstash::filter::csv (
  $add_field    = '',
  $add_tag      = '',
  $columns      = '',
  $exclude_tags = '',
  $remove_tag   = '',
  $separator    = '',
  $source       = '',
  $tags         = '',
  $target       = '',
  $type         = '',
  $order        = 10,
  $instances    = [ 'agent' ]
) {

  require logstash::params

  File {
    owner => $logstash::logstash_user,
    group => $logstash::logstash_group
  }

  if $logstash::multi_instance == true {

    $confdirstart = prefix($instances, "${logstash::configdir}/")
    $conffiles    = suffix($confdirstart, "/config/filter_${order}_csv_${name}")
    $services     = prefix($instances, 'logstash-')
    $filesdir     = "${logstash::configdir}/files/filter/csv/${name}"

  } else {

    $conffiles = "${logstash::configdir}/conf.d/filter_${order}_csv_${name}"
    $services  = 'logstash'
    $filesdir  = "${logstash::configdir}/files/filter/csv/${name}"

  }

  #### Validate parameters

  validate_array($instances)

  if ($tags != '') {
    validate_array($tags)
    $arr_tags = join($tags, '\', \'')
    $opt_tags = "  tags => ['${arr_tags}']\n"
  }

  if ($add_tag != '') {
    validate_array($add_tag)
    $arr_add_tag = join($add_tag, '\', \'')
    $opt_add_tag = "  add_tag => ['${arr_add_tag}']\n"
  }

  if ($columns != '') {
    validate_array($columns)
    $arr_columns = join($columns, '\', \'')
    $opt_columns = "  columns => ['${arr_columns}']\n"
  }

  if ($remove_tag != '') {
    validate_array($remove_tag)
    $arr_remove_tag = join($remove_tag, '\', \'')
    $opt_remove_tag = "  remove_tag => ['${arr_remove_tag}']\n"
  }

  if ($exclude_tags != '') {
    validate_array($exclude_tags)
    $arr_exclude_tags = join($exclude_tags, '\', \'')
    $opt_exclude_tags = "  exclude_tags => ['${arr_exclude_tags}']\n"
  }

  if ($add_field != '') {
    validate_hash($add_field)
    $var_add_field = $add_field
    $arr_add_field = inline_template('<%= "["+var_add_field.sort.collect { |k,v| "\"#{k}\", \"#{v}\"" }.join(", ")+"]" %>')
    $opt_add_field = "  add_field => ${arr_add_field}\n"
  }

  if ($order != '') {
    if ! is_numeric($order) {
      fail("\"${order}\" is not a valid order parameter value")
    }
  }

  if ($separator != '') {
    validate_string($separator)
    $opt_separator = "  separator => \"${separator}\"\n"
  }

  if ($target != '') {
    validate_string($target)
    $opt_target = "  target => \"${target}\"\n"
  }

  if ($type != '') {
    validate_string($type)
    $opt_type = "  type => \"${type}\"\n"
  }

  if ($source != '') {
    validate_string($source)
    $opt_source = "  source => \"${source}\"\n"
  }

  #### Write config file

  file { $conffiles:
    ensure  => present,
    content => "filter {\n csv {\n${opt_add_field}${opt_add_tag}${opt_columns}${opt_exclude_tags}${opt_remove_tag}${opt_separator}${opt_source}${opt_tags}${opt_target}${opt_type} }\n}\n",
    mode    => '0440',
    notify  => Service[$services],
    require => Class['logstash::package', 'logstash::config']
  }
}