fluent-plugin-measure_time

Fluentd plugin to measure elapsed time to process messages

Installation

Use RubyGems:

gem install fluent-plugin-measure_time

Configuration

This plugin is doing something tricky, which extends arbitrary plugins so that it can use <measure_time></measure_time> directive to measure elapsed times.

Example:

<source>
  type measure_time
  # This makes available the `masure_time` directive for all plugins
</source>

<source>
  type forward
  port 24224
  <measure_time>
    tag measure_time
    hook on_message
  </measure_time>
</source>

<match measure_time>
  type stdout
</match>

This example hooks the on_message method of in_forward plugin, and measures how long it takes for processing. Output becomes as below:

measure_time: {"time":0.000849735,"class":"Fluent::ForwardInput","hook":"on_message","object_id":83935080}

where time denotes the measured elapsed time, and class, hook, and object_id denotes the hooked class, the hooked method, and the object id of the plugin instance.

Example: interval

With interval option, this plugin compute statistics of measured elapsed times in each interval

<source>
  type measure_time
</source>

<source>
  type forward
  port 24224
  <measure_time>
    tag measure_time
    interval 60
    hook on_message
  </measure_time>
</source>

<match measure_time>
  type stdout
</match>

Output becomes as below:

measure_time: {"max":1.011,"avg":0.002","num":10,"class":"Fluent::ForwardInput","hook":"on_message","object_id":83935080}

where max and avg are the maximum and average elapsed times, and num is the number of being called in each interval.

Parameters

tag

The output tag name. Default is measure_time
hook (required)

Specify the method to measure time.
interval

The time interval to emit measurement results. Default is nil which do not compute statistics and emit the time in each measurement.

ChangeLog

See CHANGELOG.md for details.

Contributing