Edge Delta Local Storage Output

Send items to a Local Storage destination.

Overview

The Local Storage Output Node sends items to local storage. These items are raw archive bytes that are buffered with the archive buffer processor.

Example Configuration

nodes:
  - name: my_local
  type: localstorage_output
  mounted_path: "/var/archive_logs/my-local"
  compression: zstd
  ncoding: parquet
  use_native_compression: true
  path_prefix:
    order:
    - Year
    - Month
    - Day
    - Hour
    - 2 Minute
    - tag
    - host
    format: parquet/%s/%s/%s/%s/%s/%s/%s/

Required Parameters

name

A descriptive name for the node. This is the name that will appear in Visual Pipelines and you can reference this node in the yaml using the name. It must be unique across all nodes. It is a yaml list element so it begins with a - and a space followed by the string. It is a required parameter for all nodes.

nodes:
  - name: <node name>
    type: <node type>

type: localstorage_output

The type parameter specifies the type of node being configured. It is specified as a string from a closed list of node types. It is a required parameter.

nodes:
  - name: <node name>
    type: <node type>

mounted_path

The mounted_path parameter is the path in which to save archive files. It is specified as a string and is required.

nodes:
  - name: my_local
    type: localstorage_output
    mounted_path: "/var/archive_logs/my-local"

Optional Parameters

archiver_enabled

The archiver_enabled parameter configures whether archiver agents will be used for sending archive bytes. It is specified as a Boolean with the default of false and it is optional.

nodes:
  - name: <node name>
    type: ibm_object_storage_output
    endpoint: <IBM Object Storage endpoint>
    bucket: <target bucket>
    access_key: <access key>
    secret_key: <key secret>
    archiver_enabled: true

buffer_max_bytesize

The buffer_max_bytesize parameter configures the maximum byte size for total unsuccessful items. If the limit is reached, the remaining items are discarded until the buffer space becomes available. It is specified as a datasize.Size, has a default of 0 indicating no size limit, and it is optional.

nodes:
  - name: my_local
    type: localstorage_output
    mounted_path: "/var/archive_logs/my-local"
    buffer_max_bytesize: 2048

buffer_path

The buffer_path parameter configures the path to store unsuccessful items. Unsuccessful items are stored there to be retried back (exactly once delivery). It is specified as a string and it is optional.

nodes:
  - name: my_local
    type: localstorage_output
    mounted_path: "/var/archive_logs/my-local"
    buffer_path: <path to unsuccessful items folder>

buffer_ttl

The buffer_ttl parameter configures the time-to-Live for unsuccessful items, which indicates when to discard them. It is specified as a duration, has a default of 10m, and it is optional.

nodes:
  - name: my_local
    type: localstorage_output
    mounted_path: "/var/archive_logs/my-local"
    buffer_ttl: 20m

compression

The compression parameter specifies the compression format. It can be gzip, zstd, snappy or uncompressed. It is specified as a string, has a default of gzip, and it is optional.

nodes:
  - name: my_local
    type: localstorage_output
    mounted_path: "/var/archive_logs/my-local"
    compression: gzip | zstd | snappy | uncompressed

encoding

The encoding parameter specifies the encoding format. It can be json or parquet. It is specified as a string, has a default of json, and it is optional.

nodes:
  - name: my_local
    type: localstorage_output
    mounted_path: "/var/archive_logs/my-local"
    encoding: json | parquet

path_prefix

The path_prefix parameter configures the path prefix using order and format child parameters. It is optional.

The order child parameter lists the formatting items that will define the path prefix:

  • You can refer to Year, Month, Day, <any number that can divide 60> Minute, Hour, tag, host, OtherTags.<item related tags> and LogFields.<log related tags>.
  • For ECS, ecs_cluster, ecs_container_name, ecs_task_family and ecs_task_version are available.
  • For K8s, k8s_namespace, k8s_controller_kind, k8s_controller_logical_name, k8s_pod_name, k8s_container_name and k8s_container_image are available.
  • For Docker, docker_container_name and docker_image_name are available

The format child parameter specifies a format string that has %s as placeholders per each order item.

nodes:
  - name: my_local
  type: localstorage_output
  mounted_path: "/var/archive_logs/my-local"
  path_prefix:
      order:
      - Year
      - Month
      - Day
      - Hour
      - 2 Minute
      - tag
      - host
    format: ver=parquet/year=%s/month=%s/day=%s/hour=%s/min=%s/tag=%s/host=%s/

use_native_compression

The archiver_enabled parameter configures whether archiver agents will be used for sending archive bytes. It is specified as a Boolean with the default of false and it is optional.

nodes:
  - name: my_local
    type: localstorage_output
    mounted_path: "/var/archive_logs/my-local"
    archiver_enabled: true