Alibaba Cloud
Aliyun OSS plugin for Fluentd
Overview
Fluent OSS output plugin buffers event logs in local files and uploads them to OSS periodically in background threads.
This plugin splits events by using the timestamp of event logs. For example, a log ‘2019-04-09 message Hello’ is reached, and then another log ‘2019-04-10 message World’ is reached in this order, the former is stored in “20190409.gz” file, and latter in “20190410.gz” file.
Fluent OSS input plugin reads data from OSS periodically.
This plugin uses MNS on the same region of the OSS bucket. We must setup MNS and OSS event notification before using this plugin.
This document shows how to setup MNS and OSS event notification.
This plugin will poll events from MNS queue and extract object keys from these events, and then will read those objects from OSS. For details, see https://github.com/aliyun/fluent-plugin-oss.
Configuration
Output Config
access_key_id (*secret.Secret, required)
Your access key id Secret
access_key_secret (*secret.Secret, required)
Your access secret key Secret
auto_create_bucket (bool, optional)
desc ‘Create OSS bucket if it does not exists
Default: false
bucket (string, required)
Your bucket name
buffer (*Buffer, optional)
check_bucket (bool, optional)
Check bucket if exists or not
Default: true
check_object (bool, optional)
Check object before creation
Default: true
download_crc_enable (bool, optional)
Download crc enabled
Default: true
endpoint (string, required)
OSS endpoint to connect to’
format (*Format, optional)
hex_random_length (int, optional)
The length of %{hex_random} placeholder(4-16)
Default: 4
index_format (string, optional)
sprintf format for %{index}
Default: %d
key_format (string, optional)
The format of OSS object keys
Default: %{path}/%{time_slice}_%{index}_%{thread_id}.%{file_extension}
open_timeout (int, optional)
Timeout for open connections
Default: 10
oss_sdk_log_dir (string, optional)
OSS SDK log directory
Default: /var/log/td-agent
overwrite (bool, optional)
Overwrite already existing path
Default: false
path (string, optional)
Path prefix of the files on OSS
Default: fluent/logs
read_timeout (int, optional)
Timeout for read response
Default: 120
slow_flush_log_threshold (string, optional)
The threshold for chunk flush performance check. Parameter type is float, not time, default: 20.0 (seconds) If chunk flush takes longer time than this threshold, Fluentd logs a warning message and increases the fluentd_output_status_slow_flush_count metric.
store_as (string, optional)
Archive format on OSS: gzip, json, text, lzo, lzma2
Default: gzip
upload_crc_enable (bool, optional)
Upload crc enabled
Default: true
warn_for_delay (string, optional)
Given a threshold to treat events as delay, output warning logs if delayed events were put into OSS