DigitalOcean Spaces Archiving Output and Integration

George Alpizar
George Alpizar
  • Updated

Overview

This output type sends logs to a DigitalOcean Spaces endpoint.

Note

In the Edge Delta App, when you create an integration or an individual output, similar parameters will display. As a result, this document applies to both outputs and integrations.


Review Parameters

Review the following parameters that you can configure in the Edge Delta App:

YAML Description
name

Enter a descriptive name for the output or integration.

For outputs, this name will be used to map this destination to a workflow.

This parameter is required. 

Review the following example:

name: my-digitalocean-spaces
integration_name

This parameter only appears when you create an individual output.

This parameter refers to the organization-level integration created in the Integrations page. If you enter this name, then the rest of the fields will be automatically populated.

If you need to add multiple instances of the same integration into the config, then you can add a custom name to each instance via the name field. In this situation, the name should be used to refer to the specific instance of the destination in the workflows.

This parameter is optional. 

Review the following example:

integration_name: orgs-aws-s3
type

Enter dos.

This parameter is required. 

Review the following example:

type: dos
endpoint

Enter the DigitalOcean Spaces endpoint.

This parameter is required. 

Review the following example:

endpoint: nyc3.digitaloceanspaces.com
bucket

Enter the target DOS bucket to send the archived logs.

This parameter is required. 

Review the following example:

bucket: ed-test-bucket-dos
access_key

Enter the access key that has permissions to upload files to the specified bucket.

This parameter is required. 

Review the following example:

access_key: my_access_key_123
secret_key

Enter the secret key associated with the specified access key.

This parameter is required. 

Review the following example:

secret_key: my_secret_key_123
compress

Enter a compression type for archiving purposes. 

You can enter gzip, zstd, snappy, or uncompressed

This parameter is optional. 

Review the following example: 

compress: gzip
encoding

Enter an encoding type for archiving purposes. 

You can enter json or parquet

This parameter is optional. 

Review the following example: 

encoding: parquet 
use_native_compression

Enter true or false to compress parquet-encoded data.

This option will not compress metadata. 

This option can be useful with big data cloud applications, such as AWS Athena and Google BigQuery.

Note

To use this parameter, you must set the encoding parameter to parquet

This parameter is optional.

Review the following example: 

use_native_compression: true
buffer_ttl

Enter a length of time to retry failed streaming data.

After this length of time is reached, the failed streaming data will no longer be tried.

This parameter is optional. 

Review the following example: 

buffer_ttl: 2h
buffer_path

Enter a folder path to temporarily store failed streaming data.

The failed streaming data will be retried until the data reaches its destinations or until the Buffer TTL value is reached.

If you enter a path that does not exist, then the agent will create directories, as needed.

This parameter is optional.

Review the following example:

buffer_path: /var/log/edgedelta/pushbuffer/
buffer_max_bytesize

Enter the maximum size of failed streaming data that you want to retry.

If the failed streaming data is larger than this size, then the failed streaming data will not be retried.

This parameter is optional.

Review the following example:

buffer_max_bytesize: 100MB

Review Sample Configuration

The following example displays an output without the name of the organization-level integration:

    - name: my-digitalocean-spaces
      type: dos
      endpoint: nyc3.digitaloceanspaces.com
      bucket: ed-test-bucket-dos
      access_key: my_access_key_123
      secret_key: my_secret_key_123

 

Share this document