Defined Type: logstash::output::file

Defined in:
manifests/output/file.pp

Overview

Define: logstash::output::file

File output.  Write events to files on disk. You can use fields from
the event as parts of the filename.

Parameters

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

fields

Only handle events with all of these fields. Optional. Value type is array Default value: [] This variable is optional

flush_interval

Flush interval for flushing writes to log files. 0 will flush on every meesage Value type is number Default value: 2 This variable is optional

gzip

Gzip output stream Value type is boolean Default value: false This variable is optional

max_size

The maximum size of file to write. When the file exceeds this threshold, it will be rotated to the current filename + “.1” If that file already exists, the previous .1 will shift to .2 and so forth. NOT YET SUPPORTED Value type is string Default value: None This variable is optional

message_format

The format to use when writing events to the file. This value supports any string and can include %name and other dynamic strings. If this setting is omitted, the full json representation of the event will be written as a single line. Value type is string Default value: None This variable is optional

path

The path to the file to write. Event fields can be used here, like “/var/log/logstash/%@source_host/%application” Value type is string Default value: None This variable is required

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

type

The type to act on. If a type is given, then this output 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

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 output can be found at:
http://logstash.net/docs/1.1.12/outputs/file

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

Authors

Parameters:

  • path (Any)
  • message_format (Any) (defaults to: '')
  • flush_interval (Any) (defaults to: '')
  • gzip (Any) (defaults to: '')
  • max_size (Any) (defaults to: '')
  • fields (Any) (defaults to: '')
  • exclude_tags (Any) (defaults to: '')
  • tags (Any) (defaults to: '')
  • type (Any) (defaults to: '')
  • instances (Any) (defaults to: [ 'agent' ]) 


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
 
# File 'manifests/output/file.pp', line 93

define logstash::output::file (
  $path,
  $message_format = '',
  $flush_interval = '',
  $gzip           = '',
  $max_size       = '',
  $fields         = '',
  $exclude_tags   = '',
  $tags           = '',
  $type           = '',
  $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/output_file_${name}")
    $services     = prefix($instances, 'logstash-')
    $filesdir     = "${logstash::configdir}/files/output/file/${name}"

  } else {

    $conffiles = "${logstash::configdir}/conf.d/output_file_${name}"
    $services  = 'logstash'
    $filesdir  = "${logstash::configdir}/files/output/file/${name}"

  }

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

  if ($fields != '') {
    validate_array($fields)
    $arr_fields = join($fields, '\', \'')
    $opt_fields = "  fields => ['${arr_fields}']\n"
  }

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


  validate_array($instances)

  if ($gzip != '') {
    validate_bool($gzip)
    $opt_gzip = "  gzip => ${gzip}\n"
  }

  if ($flush_interval != '') {
    if ! is_numeric($flush_interval) {
      fail("\"${flush_interval}\" is not a valid flush_interval parameter value")
    } else {
      $opt_flush_interval = "  flush_interval => ${flush_interval}\n"
    }
  }

  if ($max_size != '') {
    validate_string($max_size)
    $opt_max_size = "  max_size => \"${max_size}\"\n"
  }

  if ($path != '') {
    validate_string($path)
    $opt_path = "  path => \"${path}\"\n"
  }

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

  if ($message_format != '') {
    validate_string($message_format)
    $opt_message_format = "  message_format => \"${message_format}\"\n"
  }

  #### Write config file

  file { $conffiles:
    ensure  => present,
    content => "output {\n file {\n${opt_exclude_tags}${opt_fields}${opt_flush_interval}${opt_gzip}${opt_max_size}${opt_message_format}${opt_path}${opt_tags}${opt_type} }\n}\n",
    mode    => '0440',
    notify  => Service[$services],
    require => Class['logstash::package', 'logstash::config']
  }
}