Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 5 Current »

Parameter

Data type

Type

Value range / Format

Details

debug

bool

Discouraged

false / true

Do not include it. Enabling debug will incur additional costs.

id

int

Mandatory

Minimum length: 5
Maximum length: 5

Use a unique five digit number.

This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision.

enabled

bool

Discouraged

false / true

If it is false the collector will have no input.

base_url

str

Mandatory

 

The URL of the SQS queue created during the authorization process.

aws_access_key_id

str

Discouraged

Any

Use cross account roles instead of keys.

aws_secret_access_key

str

Discouraged

Any

Use cross account roles instead of keys.

aws_base_account_role

str

Optional

Any

This is Devo's role. Remove it to use the default set by Devo.

aws_cross_account_role

str

Encouraged

Any

This is the role created during the authorization process.

aws_external_id

str

Encouraged

Any

This is the external ID created during the authorization process. If using a cross account role, the external ID is necessary.

ack_messages

bool

Optional

false / true

This must be true in production. Disabling it will cause duplicate ingestion, incurring a cost.

direct_mode

bool

Optional

false / true

Set to false for most scenarios.

do_not_send

bool

Discouraged

false / true

Set to true to not send the log to Devo.

sqs_visibility_timeout

int

Optional

Min: 120

Max: 43200

Specifies how long the message in the queue will be invisible to the collector after it is requested. If it is not processed and deleted within the allotted time in seconds, the message will be put back and may be processed again.

Set this parameter if the collector has to download large files and process them.

Should you reduce the timeout, you will need to wait for messages with the old timeout to become visible for the new timeout to take full effect.

sqs_wait_timeout

int

Discouraged

Min: 20

Max: 20

Time the collector waits to get a message. The default, 20 seconds, is recommended.

sqs_max_messages

int

Optional

Min: 1

Max: 1

Unused.

region

str

Optional

Example:

us-east-1

The AWS region, which must be the same as the region in the SQS URL.

compressed_events

bool

Optional

false / true

gzip decompression support. Select false unless the S3 objects are compressed with gzip.

The error ‘utf-8' codec can't decode byte 0xa9 in position 36561456: invalid start byte may indicate the events need to be decompressed.

encoding

str

Optional

 

Options from most used to least used.

  • No labels