index.asciidoc

QingStor

../../../logstash/docs/include/plugin_header.asciidoc

Description

This input plugin enables Logstash to receive events from the QingCloud QingStor service.

The following example shows how to configure Logstash with a minimal configuration options to fetch files from QingStor and to output into a stdout:

input {
  qingstor {
    access_key_id => 'your_access_key_id'           #required
    secret_access_key => 'your_secret_access_key'   #required
    bucket => 'bucket_name'                         #required
  }
}

output {
    stdout { codec => rubydebug }
}

QingStor Input Configuration Options

This plugin supports the following configuration options plus the [plugins-inputs-common-options] described later.

Setting	Input type	Required
access_key_id	string	Yes
secret_access_key	string	Yes
host	string	No
port	number	No
bucket	string	Yes
region	string	No
prefix	string	No
tmpdir	string	No
delete_remote_files	boolean	No
backup_local_dir	string: a valid filesystem path	No
backup_bucket	string	No
backup_region	string	No
backup_prefix	string	No
sincedb_path	string: a valid filesystem path	No
interval	number	No

Also see [plugins-inputs-common-options] for a list of options supported by all input plugins.

 

access_key_id

• This is a required setting.

• Value type is string

• There is no default value for this setting.

The key id to access your QingStor.

secret_access_key

• This is a required setting.

• Value type is string

• There is no default value for this setting.

The key to access your QingStor.

host

• Value type is string

• Default value is nil

The QingStor service IP address if you want to redirect.

port

• Value type is number

• Default value is 443.

The QingStor service IP address port which coordinate with host.

bucket

• This is a required setting.

• Value type is string

• There is no default value for this setting.

The name of the qingstor bucket.

region

• Value type is string

• There is no default value for this setting.

The region of the qingstor bucket.

prefix

• Value type is string

• Default value is nil.

The prefix to filter the files.

tmpdir

• Value type is string

• Default value is /tmp/qingstor2logstash in Linux System.

Set the directory where logstash store the tmp files before sending it to logstash, default directory in linux is /tmp/qingstor2logstash.

delete_remote_files

• Value type is boolean

• Default value is false

Whether delete remote files after downloading to the local disks.

backup_local_dir

• Value type is path

• Default value is nil

If this set to a valid path, the file will be backup under a local path.

Please make sure you can access to this dir.

backup_bucket

• Value type is string

• Default value is nil.

The backup bucket name of QingStor.

backup_region

• Value type is string

• Default value is pek3a.

The backup bucket region in QingStor.

backup_prefix

• Value type is string

• Default value is "".

The backup file prefix in QingStor.

sincedb_path

• Value type is path

• Default value is nil

The sincedb path to record the last download time.

This path will be generate automatically when running if no specified.

interval

• Value type is number

• Default value is 10

Set how frequently messages should be sent.

The default, 10, means send a message every 10 seconds.

../../../logstash/docs/include/input.asciidoc