EDPort Collector Inputs

Overview

This input type allows you to specify a set of ports and protocols for the agent to listen on for incoming traffic.

Review Sample Configuration 

Review the following sample configuration: 

 ed_ports:
    - labels: "error-counts-per-node"
      port: 4545
      protocol: http
      schema: FlattenedObservation
    - labels: "errorcheck"
      port: 9000
      protocol: tcp
      read_size: 10000
      read_timeout: 30s
      filters:
      - source-detection-k8s
      - source-detection-custom
    - labels: "ed-port-with-auto-detect-line-pattern"
      port: 5656
      protocol: tcp
      auto_detect_line_pattern: true
    - labels: "ed-port-with-given-line-pattern"
      port: 9091
      protocol: http
      line_pattern: '^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}'
      late_arrival_handling:
        rule_metrics:
          ignore_after: 10m
        patterns:
          ignore_after: 3h
          report_with_original_timestamp: true
    - labels: "ed-port-with-network-interface"
      port: 4545
      protocol: tcp
      listen: 127.0.0,1
    - labels: "ed-port-tcp-with-tls"
      port: 4545
      protocol: tcp
      tls:
        crt_file: /certs/server-cert.pem
        key_file: /certs/server-key.pem
        ca_file: /certs/ca.pem
    - labels: "ed-port-https-with-tls"
      protocol: https
      listen: localhost
      port: 443
      tls:
        crt_file: /certs/server-cert.pem
        key_file: /certs/server-key.pem
        ca_file: /certs/ca.pem
    - labels: "ed-port-with-add-ingestion-time"
      port: 4545
      protocol: tcp
      add_ingestion_time: true
      skip_ingestion_time_on_failure: true 

Review Parameters

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

labels

Required

Enter a descriptive name for this input. 

When you create a workflow, you will use this label to enter your input into the workflow. 

Review the following example: 

labels: "error-counts-per-node"

port

Required

Enter the port that the agent should listen for. 

Review the following example: 

port: 4545

protocol

Required

Select (or enter):

• tcp
• http
• https

Review the following example: 

protocol: http

listen

Optional

Enter a network interface where the agent can listen for data. 

Review the following example: 

listen: localhost

read_timeout

Required

Enter a maximum time to wait and listen for data. 

This parameter only applies if you select tcp as the protocol. 

Review the following example: 

read_timeout: 30s

schema

Required

You can only enter FlattenedObservation.

Review the following example: 

schema: FlattenedObservation

read_size

Optional

Enter the number of lines to read from the incoming data. 

If you do not enter a value, then 1 will be used. 

This parameter only applies if you select tcp as the protocol. 

Review the following example: 

read_size: 10000

enable_incoming_line_anomalies

Optional

Enter true or false to generate anomaly scores. 

Review the following example: 

enable_incoming_line_anomalies: true

add_ingestion_time

Optional

Enter true or false to ingest a timestamp if the input format is in JSON.

Review the following example: 

add_ingestion_time: true

skip_ingestion_time_on_failure

Optional

Enter true or false to skip the ingestion of the timestamp when the input is broken or in an invalid format.  

Review the following example: 

skip_ingestion_time_on_failure: true

filters

Optional

Enter an existing filter to add to this input. 

To learn more, see Filters.

Review the following example: 

filters: 
   - info 

tls: disable_verify

Optional 

To disable a TLS verification of a certificate, enter disable_verify: true.

To enable a TLS verification of the certificate, you can enter disable_verify: false or you can remove this line entirely. 

Review the following example: 

tls:
  disable_verify: true

tls: ca_path

Optional 

Enter the absolute file path to the CA certificate file.

Review the following example: 

tls:
  ca_path: /var/etc/kafka

tls: ca_file

Optional 

Enter the absolute path to scan the CA certificate file.

Review the following example: 

tls:
  ca_file: /certs/ca.pem

tls: crt_path

Optional 

Enter the absolute path to the certificate file. 

Review the following example: 

tls:
  crt_file: /certs/server-cert.pem

tls: key_file

Optional 

Enter the absolute path to the private key file. 

Review the following example: 

tls:
  key_file: /certs/server-key.pem

tls: key_password

Optional 

Enter the password for the key file.

Review the following example: 

tls:
  key_password: p@ssword123

tls: client_auth_type

Optional 

Enter a client authorization type. 

You can enter:

• noclientcert
• requestclientcert
• requireanyclientcert
• verifyclientcertifgiven
• requireandverifyclientcert

The default setting is noclientcert.

Review the following example: 

tls:
  client_auth_type: noclientcert

tls: min_version

Optional 

Enter the minimum version of TLS to accept. 

Review the following example: 

tls:
  min_version: TLSv1_1

tls: max_version

Optional

Enter the maximum version of TLS to accept. 

Review the following example: 

tls:
  max_version: TLSv1_3