/ 
Log-Log4perl-Appender-Chunk-0.013
River stage zero No dependents
/ Log::Log4perl::Appender::Chunk::Store::S3

NAME

Log::Log4perl::Appender::Chunk::Store::S3 - Store chunks in an S3 bucket

SYNOPSIS

Example:

# Built-in store class S3
log4perl.appender.Chunk.store_class=S3
# S3 Mandatory options
log4perl.appender.Chunk.store_args.bucket_name=MyLogChunks
log4perl.appender.Chunk.store_args.aws_access_key_id=YourAWSAccessKey
log4perl.appender.Chunk.store_args.aws_secret_access_key=YourAWS

See Log::Log4perl::Appender::Chunk's synopsis for a more complete example.

OPTIONS

bucket_name

Mandatory. Name of the Amazon S3 bucket to store the log chunks.

location_constraint

Optional. If your current Net::Amazon::S3 supports it, you can use that to set the location constraint of the vivified bucket. See Net::Amazon::S3#add_bucket for more info on supported constraints.

Note that if you specify a location constraint, you will have to follow Amazon's recommendation about naming your bucket. See http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html for restriction about bucket names. In Particular, if you are outside the US, you will not be able to have upper case characters in your bucket name.

host

Optional. If the bucket you are using is not in the USA, and depending on the version of Net::Amazon::S3 you have, you might want to set that to a different host, according to http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

See <Net::Amazon::S3#new>

aws_access_key_id

Mandatory. Your S3 access key ID. See Net::Amazon::S3

asw_secret_acccess_key

Mandatory. Your S3 Secret access key. See Net::Amazon::S3

retry

Optional. See Net::Amazon::S3

Defaults to true (1).

with_forking

Optional. Causes this to (double) fork before actually storing stuff to S3, so your processes are not slowed down by slow transfers to S3. On highly loaded machines, this could actually be slower than not forking at all. So set this to false (0) on higly loaded machines.

Defaults to true (1).

acl_short

Optional. Shortcut to commonly used ACL rules. Valid values are: private public-read public-read-write authenticated-read.

See https://metacpan.org/source/PFIG/Net-Amazon-S3-0.59/lib/Net/Amazon/S3/Client/Object.pm

Defaults to undef, meaning your Amazon Bucket's default will be applied. That's probably the most desirable behaviour.

expires_in_days

Optional. Amount of days in the future stored chunks should expire. No value means never.

Defaults to undef.

vivify_bucket

Optional. If true, this writer will attempt to vivify a non existing bucket name if possible.

Defaults to false.

Optional. If true, this writer will log (at DEBUG level) the authenticated links to the stored chunks in other log appenders.

Use with care as this could lead to confidential information leakage.

Defaults to false.

METHODS

clone

Returns a fresh copy of myself based on the same settings. Mainly used internaly.

Usage:

my $clone = $this->clone();

store

See superclass Log::Log4perl::Appender::Chunk::Store