Defined Type: rsyslog::rule::remote

Defined in:
manifests/rule/remote.pp

Overview

Adds a rule to send messages to a remote system

In general, the order will be:

  • Data Source Rules

  • Console Rules

  • Drop Rules

  • Remote Rules

  • Other/Miscellaneous Rules

  • Local Rules

If you wish to use TLS for forward RSyslog messages, you MUST configure it via rsyslog::config. Current EL versions of RSyslog 7 do not properly support individual TLS settings via rulesets.


WARNING

If possible, this module will take pains to prevent adding a target that is equivalent to the current system to prevent syslog loops.

Unfortunately, there is no foolproof method for getting this correct 100% of the time so please take care when setting your destination targets.

WARNING


  • This must be set if $content is left empty

Examples:

Send All local0 Messages to 1.2.3.4 via TCP

rsyslog::rule::remote { 'send_local0_away':
  rule        => "prifilt('local0.*')",
  log_servers => ['1.2.3.4']
}

Parameters:

  • name (String)

    The filename that you will be dropping into place

  • rule (Optional[String]) (defaults to: undef)

    The Rsyslog EXPRESSION to filter on

    • This should only be the matching part of the expression, the remaining parameters take care of ensuring that the material is properly routed.

    • NOTE: Do NOT include the leading if/then

      • Correct: "rule => "prifilt('.')"

      • Incorrect: rule => "if prifilt('.') then"

  • stop_processing (Boolean) (defaults to: false)

    Do not forward logs to any further rulesets after processing this ruleset

  • template (Optional[String]) (defaults to: undef)

    The template that should be used to format the content

  • dest (Simplib::Netlist) (defaults to: [])

    If filled, logs matching $rule will be sent to all hosts in this Array.

    • WARNING: If using this, do NOT add a destination to your rule

  • dest_type (Enum['tcp','udp','relp']) (defaults to: 'tcp')

    The destination type for all entries in $dest

    • At this time, if you wish to have different types per destination, you will need to craft your own ruleset and leave $dest empty.

  • failover_log_servers (Simplib::Netlist) (defaults to: [])

    The listed systems will be used as failover servers for all logs matching this rule

    • Uses $dest_type above

  • tcp_framing (Enum['traditional','octet-counted']) (defaults to: 'traditional')
  • zip_level (Integer[0,9]) (defaults to: 0)
  • max_error_messages (Integer[0]) (defaults to: 5)
  • compression_mode (Enum['none','single','stream:always']) (defaults to: 'none')
  • compression_stream_flush_on_tx_end (Boolean) (defaults to: true)
  • rebind_interval (Optional[Integer[0]]) (defaults to: undef)
  • action_resume_interval (Integer[0]) (defaults to: 30)
  • action_resume_retry_count (Integer[-1]) (defaults to: -)
  • stream_driver (Optional[String]) (defaults to: undef)

    This is overridden by the rsyslog::config::default_net_stream_driver

    • EL versions of Rsyslog 7 do not support this properly in rulesets but it may be specified

  • stream_driver_mode (Integer[0]) (defaults to: 1)

    This is overridden by the rsyslog::config::action_send_stream_driver_mode

    • EL versions of Rsyslog 7 do not support this properly in rulesets but it may be specified

  • stream_driver_auth_mode (String) (defaults to: 'x509/name')

    This is overridden by the rsyslog::config::action_send_stream_driver_auth_mode

    • EL versions of Rsyslog 7 partially support this in rulesets and it may have some effect

  • stream_driver_permitted_peers (String) (defaults to: "*.${::domain}")

    This is overridden by the rsyslog::config::action_send_stream_driver_permitted_peers

    • EL versions of Rsyslog 7 partially support this in rulesets and it may have some effect

  • resend_last_msg_on_reconnect (Boolean) (defaults to: true)
  • udp_send_to_all (Boolean) (defaults to: false)
  • queue_filename (Optional[String]) (defaults to: undef)
  • queue_spool_directory (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • queue_size (Optional[Integer[0]]) (defaults to: undef)
  • queue_dequeue_batch_size (Integer[0]) (defaults to: 16)
  • queue_max_disk_space (Optional[Integer[0]]) (defaults to: undef)
  • queue_high_watermark (Optional[Integer[0]]) (defaults to: undef)
  • queue_low_watermark (Integer[0]) (defaults to: 2000)
  • queue_full_delay_mark (Optional[Integer[0]]) (defaults to: undef)
  • queue_light_delay_mark (Optional[Integer[0]]) (defaults to: undef)
  • queue_discard_mark (Integer[0]) (defaults to: 9750)
  • queue_discard_severity (Integer[0]) (defaults to: 8)
  • queue_checkpoint_interval (Optional[Integer[0]]) (defaults to: undef)
  • queue_sync_queue_files (Boolean) (defaults to: false)
  • queue_type (Enum['LinkedList','FixedArray','Direct','Disk']) (defaults to: 'LinkedList')
  • queue_worker_threads (Integer[0]) (defaults to: 1)
  • queue_timeout_shutdown (Integer[0]) (defaults to: 0)
  • queue_timeout_action_completion (Integer[0]) (defaults to: 1000)
  • queue_timeout_enqueue (Integer[0]) (defaults to: 2000)
  • queue_timeout_worker_thread_shutdown (Integer[0]) (defaults to: 60000)
  • queue_worker_thread_minimum_messages (Integer[0]) (defaults to: 100)
  • queue_max_file_size (String) (defaults to: '1m')
  • queue_save_on_shutdown (Boolean) (defaults to: true)
  • queue_dequeue_slowdown (Integer[0]) (defaults to: 0)
  • queue_dequeue_time_begin (Optional[Integer[0]]) (defaults to: undef)
  • queue_dequeue_time_end (Optional[Integer[0]]) (defaults to: undef)
  • content (Optional[String]) (defaults to: undef)

    the *entire content of the rsyslog::rule

    • If you do not specify this, $rule is a required variable

    • If you do specify this, $rule will be ignored

See Also:



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
230
231
232
233
234
235
236
237
238
# File 'manifests/rule/remote.pp', line 148

define rsyslog::rule::remote (
  Optional[String]                                 $rule                                 = undef,
  Boolean                                          $stop_processing                      = false,
  Optional[String]                                 $template                             = undef,
  Simplib::Netlist                                 $dest                                 = [],
  Enum['tcp','udp','relp']                         $dest_type                            = 'tcp',
  Simplib::Netlist                                 $failover_log_servers                 = [],
  Enum['traditional','octet-counted']              $tcp_framing                          = 'traditional',
  Integer[0,9]                                     $zip_level                            = 0,
  Integer[0]                                       $max_error_messages                   = 5,
  Enum['none','single','stream:always']            $compression_mode                     = 'none',
  Boolean                                          $compression_stream_flush_on_tx_end   = true,
  Optional[Integer[0]]                             $rebind_interval                      = undef,
  Integer[0]                                       $action_resume_interval               = 30,
  Integer[-1]                                      $action_resume_retry_count            = -1,
  Optional[String]                                 $stream_driver                        = undef,
  Integer[0]                                       $stream_driver_mode                   = 1,
  String                                           $stream_driver_auth_mode              = 'x509/name',
  String                                           $stream_driver_permitted_peers        = "*.${::domain}",
  Boolean                                          $resend_last_msg_on_reconnect         = true,
  Boolean                                          $udp_send_to_all                      = false,
  Optional[String]                                 $queue_filename                       = undef,
  Optional[Stdlib::Absolutepath]                   $queue_spool_directory                = undef,
  Optional[Integer[0]]                             $queue_size                           = undef,
  Integer[0]                                       $queue_dequeue_batch_size             = 16,
  Optional[Integer[0]]                             $queue_max_disk_space                 = undef,
  Optional[Integer[0]]                             $queue_high_watermark                 = undef,
  Integer[0]                                       $queue_low_watermark                  = 2000,
  Optional[Integer[0]]                             $queue_full_delay_mark                = undef,
  Optional[Integer[0]]                             $queue_light_delay_mark               = undef,
  Integer[0]                                       $queue_discard_mark                   = 9750,
  Integer[0]                                       $queue_discard_severity               = 8,
  Optional[Integer[0]]                             $queue_checkpoint_interval            = undef,
  Boolean                                          $queue_sync_queue_files               = false,
  Enum['LinkedList','FixedArray','Direct','Disk']  $queue_type                           = 'LinkedList',
  Integer[0]                                       $queue_worker_threads                 = 1,
  Integer[0]                                       $queue_timeout_shutdown               = 0,
  Integer[0]                                       $queue_timeout_action_completion      = 1000,
  Integer[0]                                       $queue_timeout_enqueue                = 2000,
  Integer[0]                                       $queue_timeout_worker_thread_shutdown = 60000,
  Integer[0]                                       $queue_worker_thread_minimum_messages = 100,
  String                                           $queue_max_file_size                  = '1m',
  Boolean                                          $queue_save_on_shutdown               = true,
  Integer[0]                                       $queue_dequeue_slowdown               = 0,
  Optional[Integer[0]]                             $queue_dequeue_time_begin             = undef,
  Optional[Integer[0]]                             $queue_dequeue_time_end               = undef,
  Optional[String]                                 $content                              = undef
) {
  include '::rsyslog'

  $_safe_name = regsubst($name,'/','__')

  unless ($rule or $content) {
    fail('You must specify "$rule" if you are not specifying "$content"')
  }

  if $content {
    $_content = $content
  }
  else {
    if empty($dest) {
      $_dest = $::rsyslog::log_servers
    }
    else {
      $_dest = $dest
    }

    if empty($_dest) { fail('You must pass a destination array for $dest') }

    if $queue_spool_directory {
      $_queue_spool_directory = $queue_spool_directory
    }
    else {
      $_queue_spool_directory = $::rsyslog::queue_spool_directory
    }

    $_use_tls = ( $::rsyslog::enable_tls_logging and $dest_type != 'udp' )

    if empty($failover_log_servers) {
      $_failover_servers = $::rsyslog::failover_log_servers
    }
    else {
      $_failover_servers = $failover_log_servers
    }
    $_content = template("${module_name}/rule/remote.erb")
  }

  rsyslog::rule { "10_simp_remote/${_safe_name}.conf":
    content => $_content
  }
}