Fluent::Plugin::Hrforecast
fluentd output plugin for HRForecast
Overview
Fluented output plugin for sending metrics to HRForecast. This plugin code was wittern based on fluent-plugin-growthforecast
Configuration
Sample1
Tag is metrics
and message is {'field1':10, 'field2':200, 'others':3000}
.
By follow config, send 2 numbers and time specified input plugin to HRForecast.
- send 10 and time to http://hrforecast.local/api/service/section/metrics_field1
- send 200 and time to http://hrforecast.local/api/service/section/metrics_field2
<match metrics>
type hrforecast
hrfapi_url http://hrforecast.local/api/
graph_path service/section/${tag}_${key_name}
name_keys field1,field2
</match>
Sample2
Tag is metrics
and message is {'date_field':'2014/05/23', 'field_hoge':89.3}
.
By follow config, send a floating number and formatted date to HRForecast.
- send 89.3 and '2014-05-23 00:00:00' to http://hrforecast.local/api/service/metrics/hoge
<match metrics>
type hrforecast
hrfapi_url http://hrforecast.local/api/
graph_path service/${tag}/${key_name}
name_key_pattern ^field_(.*)$
enable_float_number true
datetime_key date_field
datetime_key_format %Y/%m/%d
datetime_format %Y-%m-%d %H:%M:%S
</match>
Options
- hrfapi_url (required)
URL of HRForecast API base like 'http://hrforecast.local/api/'
- graph_path (required)
Graph Path of HRForecast API endpoint include service_name, section_name and graph_name separated slash.
e.g. service/section/graph
You can customize graph_path using ${tag}
and ${key_name}
placeholders.
- name_keys (Either of this or name_key_pattern is required)
Specify field names of sending number. Separate by comma.
- name_key_pattern (Either of this or name_keys is required)
Specify field names of sending number.
- datetime_key (default: none)
Specify field names of sending datetime if you need.
- datetime_key_format (required if specified datetime_key)
Parse format for datetime of field specified datetime_key.
- datetime_format (default: %Y-%m-%d %H:%M:%S %z)
Format of datetime POST parameter.
- remove_prefix (default:none)
Remove prefix from tag if specified.
- background_post (default:false)
Post to HRForecast in background thread, without retries for failures.
- ssl (default:false)
Use SSL (https) or not.
- verify_ssl (default:false)
Do SSL verification or not.
-
timeout
-
retry (default: true)
-
keepalive (default: true)
-
enable_float_number (default: false)
-
authentication (default:none)
-
username (default:empty)
-
password (default:empty)
License
Apache License, Version 2.0