Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 2.56 KB

README.md

File metadata and controls

77 lines (58 loc) · 2.56 KB

Fluentd output plugin for Site24x7

With Site24x7 plugin for Fluentd, you can parse and send logs directly from Fluentd, without having to use a separate log shipper.

Installation

To add the plugin to your fluentd agent, use the following command:

$ gem install fluent-plugin-site24x7

If you have installed the td-agent instead

$ /usr/sbin/td-agent-gem install fluent-plugin-site24x7

Usage

Configure the output plugin

To match events and send them to Site24x7, add the following code to your configuration file.

# Match events tagged with "site24x7.**" and send them to Site24x7
<match site24x7.**>

  @type site24x7
  @id site24x7_agent
  log_type_config <your_log_type_config>

  # Optional parameters
  max_retry '3'
  retry_interval '2'
  http_idle_timeout '5'
  http_read_timeout '30'
  
  # Optional http proxy
  http_proxy 'http://user:passs@mproxy.host:proxy.port'

  <buffer>
          @type memory
          flush_thread_count 4
          flush_interval 3s
          chunk_limit_size 5m
          chunk_limit_records 500
  </buffer>

</match>

After restarting FluentD, any events tagged with site24x7 are shipped to Site24x7 platform.

Parameters

As fluent-plugin-site24x7 is an output_buffer, you can set all the output_buffer properties like it's described in the fluentd documentation.

Property Description Default Value
log_type_config log_type_config of your configured log type in site24x7 nil
max_retry Number of times to resend failed uploads. Set to -1 for unlimited retries -1
retry_interval Time interval to sleep initially between retries, exponential step-off 2 seconds
maxretry_interval Maximum interval to wait between sending retries 60 seconds
retry_timeout Time after which the data is going to be dropped 24 hours
http_idle_timeout Timeout (in seconds) for which http persistent connection will stay open without traffic 5 seconds
http_read_timeout Timeout (in seconds) when the socket connects until the connection breaks 30 secods
http_proxy Your proxy uri nil

Release Notes

  • 0.1.7 - Sending stop signal to Fluentd for unrecoverable errors
  • 0.1.6 - chunk unique id added for each upload and unlimited retry support
  • 0.1.5 - Retry handled for empty upload-id
  • 0.1.4 - Multi-line log, masking, hasing and derived fields support added
  • 0.1.3 - JSON log parsing issue fixed
  • 0.1.2 - Timezone parsing issue fixed
  • 0.1.1 - Minor changes
  • 0.1.0 - Initial Release