Docs
test1test2
6.5
6.5
  • ElastiFlow Documentation
  • Unified Flow Collector
    • General Configuration
    • Changelog
    • Maxmind GeoIP2 and GeoLite2
    • RiskIQ PassiveTotal
    • Network Interfaces
    • User-Defined Metadata
    • Docker
    • Linux
    • Unified Flow Collector Introduction
    • System Requirements
    • Supported IEs
    • AWS VPC Flow Log IEs
    • IPFIX IEs
    • Netflow IEs
    • sFlow IEs
  • Unified SNMP Collector
    • Device Groups
    • Changelog
    • Devices
    • Downloading Definitions
    • Enumerations
    • Objects
    • Object Groups
    • User-Defined Metadata
    • Docker
    • Network Interfaces
    • United SNMP Collector Introduction
    • Linux
    • Scheduling Rediscovery
  • Monitoring ElastiFlow
    • Liveness & Readiness
    • Metrics
    • Prometheus & Grafana
  • Configuration Reference
    • YAML Configuration Files
    • Configuration Reference Overview
    • Common
      • API
      • Licensing
      • Overview
      • Logging
      • HTTP output
      • Elasticsearch output
      • Kafka output
      • Monitor output
      • OpenSearch output
      • Splunk output
      • stdout output
      • Processor
    • Unified Flow Collector
      • Overview
      • Community/Conversation IDs
      • EF_PROCESSOR_ENRICH_TOTALS_IF_NO_DELTAS
      • Overview
      • RiskIQ PassiveTotal
      • Maxmind
      • User-Defined Metadata
      • Overview
      • Overview
      • User-Defined Metadata
      • Overview
      • Benchmark Input
      • Netflow/IPFIX/sFlow (UDP)
      • Licensing
      • Decoder/Processor
      • Sample Rate
      • Configuration Changes
    • Unified SNMP Collector
      • User-Defined Metadata
      • Overview
      • Licensing
      • SNMP Poller
      • EF_PROCESSOR_SNMP_ENUM_DEFINITIONS_DIRECTORY_PATH
  • API Reference
    • API Reference Overview
    • SNMP Operations
  • Data Platforms
    • Elastic
      • Basic Cluster
      • Advanced Cluster
      • Single Server
      • Multi-Tier Cluster
      • Single "Lab" Server
      • Elasticsearch
      • ElastiFlow vs. Filebeat and Logstash
      • RHEL/CentOS
      • Ubuntu/Debian
      • Kibana
      • ML
        • Network Security
        • Machine Learning
        • Availability
          • Network Availability
          • DHCP
          • LDAP
          • DNS
          • NTP
          • RADIUS
          • TCP Sessions
        • Network Security Activity
          • Rare Autonomous System
          • Network Activity
          • Rare Conversation
          • Rare Geolocation
        • Network Security Brute Force
          • Brute Force CLI Access
          • Brute Force Remote Desktop Access
          • Brute Force Attacks
        • Network Security DDoS
          • Denial-of-Service
          • ICMP Flood Attack
          • SYN Flood Attack
          • TCP DDoS Attack
          • UDP Amplification Attack
        • Network Security Recon
          • ICMP Scan
          • Reconnaissance
          • Port Scan
        • Performance
          • Unusual ASN Traffic Volume
          • Unusual Network Interface Traffic Volume
          • Network Performance
    • Opensearch
      • Dashboards
      • Auth Sig V4
    • Splunk
      • Default Search Macro
      • Configuring Data Input & Index
      • Splunk App Installation
    • Output Configuration
  • Additional Guides
    • Catalyst (sFlow)
    • FortiGate
    • hsflowd
    • Configuring Flow Sampling on Juniper Routers
    • Junos OS (sFlow)
    • MikroTik RouterOS
    • OpenWRT (softflowd)
    • Ubiquiti EdgeRouter
    • SonicWall
    • Junos OS
    • Extending SNMP Device Support
    • Flow Device Support Overview
    • SNMP Device Support Overview
    • Generating A Support Bundle
  • FAQ
    • Flows stopped showing up in Kibana (Disk(s) Full)
    • Common reasons why you have discrepancies between ElastiFlow data & reality
    • What Are Snapshots?
    • Importing the wrong dashboards (No data)
  • Knowledge Base
    • Config
      • Elasticsearch Authentication Failure
      • CA Certificate Path Incorrect
      • license/error Invalid Segments
    • Flow
      • Bidirectional Flow Support
      • Configure the UDP Input
      • Flow Records Not Received
      • Netflow v9/IPFIX Template Not Receieved
      • Unsupported sFlow Structures
    • General
      • License Has Expired
      • License Agreement Not Accepted
    • Install
      • .deb Upgrade Fails File Overwrite
    • Operation
      • Flow Collector Queues 90% Full
      • Dashboard Updates
      • Change elastiflow-* Index Name?
  • Elastic Stack Deployment
  • Download Links
Powered by GitBook
On this page
  • EF_PROCESSOR_ENRICH_APP_ID_ENABLE
  • EF_PROCESSOR_ENRICH_APP_ID_PATH
  • EF_PROCESSOR_ENRICH_APP_ID_TTL
  • EF_PROCESSOR_ENRICH_APP_IPPORT_ENABLE
  • EF_PROCESSOR_ENRICH_APP_IPPORT_PATH
  • EF_PROCESSOR_ENRICH_APP_IPPORT_TTL
  • EF_PROCESSOR_ENRICH_APP_IPPORT_PRIVATE
  • EF_PROCESSOR_ENRICH_APP_IPPORT_PUBLIC
  • EF_PROCESSOR_ENRICH_APP_REFRESH_RATE
  1. Configuration Reference
  2. Unified Flow Collector

Overview

The ElastiFlow Unified Flow Collector will cache application attributes learned from option data. It also allows users to define application attributes by any combination of IP/CIDR/IP range and port/port range.

EF_PROCESSOR_ENRICH_APP_ID_ENABLE

  • Valid Values

    • true, false

  • Default

    • false

EF_PROCESSOR_ENRICH_APP_ID_PATH

If vendor-defined AppID to application attribute mappings is enabled (EF_PROCESSOR_ENRICH_APP_ID_ENABLE is true) this setting specifies the path to the file.

  • Default

    • /etc/elastiflow/app/appid.yml

EF_PROCESSOR_ENRICH_APP_ID_TTL

The length of time the application attributes will be cached after they are initially fetched.

:::note Changes to the underlying files will not be picked up, even after the files have been re-loaded at the refresh interval, until the AppID has expired from the cache. :::

  • Default

    • 7200

EF_PROCESSOR_ENRICH_APP_IPPORT_ENABLE

While various flow record sources send the mapping of application IDs to applications names as option data. In cases where no application identity technology is available, applications can be statically specified by IP address and port number.

  • Valid Values

    • true, false

  • Default

    • false

EF_PROCESSOR_ENRICH_APP_IPPORT_PATH

If user-defined IP/port to application mappings is enabled (EF_PROCESSOR_ENRICH_APP_IPPORT_ENABLE is true) this setting specifies the path to this file.

An example of the format of this file is:

192.168.1.0/24:
  8090:
    name: "Synergy-cidr-port"
    category: "category-cidr-port"
    subcategory: "subcategory-cidr-port"
    metadata:
      ".location": "austin-cidr-port"
      "business.unit": "finance-cidr-port"
      "dev.unit": "dev-cidr-port"
      "app.count": 27

192.168.1.1-192.168.1.20:
  8090:
    name: "Synergy-iprange-port"
    category: "category-iprange-port"
    subcategory: "subcategory-iprange-port"
    metadata:
      .location: "austin-iprange-port"

  8090-9000:
    name: "Synergy-iprange-portrange"
    category: "category-iprange-portrange"
    subcategory: "subcategory-iprange-portrange"
    metadata:
      .location: "austin-iprange-portrange"
      business.unit: "finance-iprange-portrange"
      qa.unit: "qa-iprange-portrange"
      finace.unit: "finance-iprange-portrange"

192.168.1.1:
  8090:
    name: "Synergy-ip-port"
    category: "category-ip-port"
    subcategory: "subcategory-ip-port"
    metadata:
      .location: "austin-ip-port"
      business.unit: "finance-ip-port"
  • Default

    • /etc/elastiflow/app/ipport.yml

EF_PROCESSOR_ENRICH_APP_IPPORT_TTL

The length of time the application attributes will be cached after they are initially fetched.

:::note Changes to the underlying files will not be picked up, even after the files have been re-loaded at the refresh interval, until the IP/Port has expired from the cache. :::

  • Default

    • 7200

EF_PROCESSOR_ENRICH_APP_IPPORT_PRIVATE

If user-defined application attributes are enabled (EF_PROCESSOR_ENRICH_APP_IPPORT_ENABLE is true) this option specifies whether application names will be checked for private IP addresses.

  • Valid Values

    • true, false

  • Default

    • true

EF_PROCESSOR_ENRICH_APP_IPPORT_PUBLIC

If user-defined application attributes are enabled (EF_PROCESSOR_ENRICH_APP_IPPORT_ENABLE is true) this option specifies whether application names will be checked for public IP addresses.

  • Valid Values

    • true, false

  • Default

    • false

EF_PROCESSOR_ENRICH_APP_REFRESH_RATE

The files defined for application attribute enrichment can be loaded automatically to refresh values without restarting the collector. This value specifies the refresh interval, in minutes, that the file will be reloaded. The value of 0 disables refreshing of the values.

  • Default

    • 15

PreviousUnified Flow CollectorNextCommunity/Conversation IDs