IBM Object Storage Archiving Output and Integration

George Alpizar
George Alpizar
  • Updated

Overview

This output type sends logs to an IBM Object Storage 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 Sample Configuration 

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

    - name: my-ibm-object-storage
      type: ibmos
      endpoint: s3-api.us-geo.objectstorage.softlayer.net
      bucket: ed-test-bucket-ibm
      access_key: my_access_key_123
      secret_key: my_secret_key_123

Review Parameters

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


name

Required 

Enter a descriptive name for the output or integration.

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

Review the following example: 

name: my-ibm-object-storage

integration_name

Optional

This parameter refers to the organization-level integration created in the Integrations page. 

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 parameter. In this situation, the name should be used to refer to the specific instance of the destination in the workflows.

Review the following example: 

integration_name: orgs-ibmos

type

Required

Enter ibmos.

Review the following example: 

type: ibmos

endpoint

Required 

Enter the IBM Object Storage endpoint.

Review the following example: 

endpoint: s3-api.us-geo.objectstorage.softlayer.net

bucket

Required 

Enter the desired IBM Object Storage bucket to send the archived logs.

Review the following example: 

bucket: ed-test-bucket-ibm

access_key

Required 

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

Review the following example: 

access_key: my_access_key_123

secret_key

Required

Enter the secret key associated with the specified access key.

Review the following example: 

secret_key: my_secret_key_123

compress

Optional 

Enter a compression type for archiving purposes. 

You can enter gzip, zstd, snappy, or uncompressed

Review the following example: 

compress: gzip

encoding

Optional 

Enter an encoding type for archiving purposes. 

You can enter json or parquet

Review the following example: 

encoding: parquet 

use_native_compression

Optional 

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

Review the following example: 

use_native_compression: true

buffer_ttl

Optional 

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.

Review the following example: 

buffer_ttl: 2h

buffer_path

Optional 

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.

Review the following example:

buffer_path: /var/log/edgedelta/pushbuffer/

buffer_max_bytesize

Optional 

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.

Review the following example:

buffer_max_bytesize: 100MB

 


 

Share this document