EDPort Streaming Output and Integration

George Alpizar
George Alpizar
  • Updated

Overview

The EDPort output will stream analytics and insights to your EDPort environment.

Review Sample Configuration

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

    - name: edport-with-endpoint
      type: edport
      endpoint: "http://localhost:4545/v0/collect"
    - name: edport-with-endpoint-and-schema
      type: edport
      endpoint: "http://localhost:4545/v0/collect"
      schema: FlattenedObservation
    - name: edport-with-tcp
      type: edport
      host: "log-repo-host"
      port: 23131
      pool_size: 1
    - name: edport-with-tcp-and-schema
      type: edport
      host: "log-repo-host"
      port: 23131
      schema: FlattenedObservation

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: edport-with-endpoint

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-edport

type

Required

Enter edport.

Review the following example: 

type: edport

endpoint

Optional 

Enter the EDPort endpoint. 

You must enter an endpoint to support HTTP/S stream.

Review the following example: 

endpoint: "http://localhost:4545/v0/collect"

host 

Optional 

Enter the EDPort host. 

You must enter a host to support TCP stream. 

Review the following example: 

host: "log-repo-host"

port

Optional 

Enter the EDPort port. 

You must enter a port to support TCP stream. 

Review the following example: 

port: 23131

schema

Optional 

Enter the format type for the streaming data, such as json. 

Review the following example: 

schema: FlattenedObservation

features

Optional 

This parameter defines which data types to stream to the destination.

To learn more, review the Review Feature Types section in Stream Outputs and Integrations Overview.

Review the following example: 

features: log

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