Sign inSign up

elastiflow/trap-collector

By elastiflow

Updated about 1 month ago

ElastiFlow SNMP Trap collector

Image
0

6.1K

elastiflow/trap-collector repository overview

ElastiFlow SNMP Trap collector

NetObserv SNMP Trap is more than a simple trap listener. It has been designed to meet the requirements of the most demanding production environments, with particular attention on being turnkey, extensible, efficient, adaptive, and scalable.

Below is an example docker-compose file for running the container. For complete details on how to configure and run the container please refer to the documentation... HERE⁠

services:
  # nosemgrep: yaml.docker-compose.security.writable-filesystem-service.writable-filesystem-service, yaml.docker-compose.security.no-new-privileges.no-new-privileges
  trap-collector:
    image: elastiflow/trap-collector:7.26.3
    container_name: trap-collector
    restart: 'unless-stopped'
    network_mode: 'host'
    volumes:
      - /etc/elastiflow:/etc/elastiflow
      - /usr/share/elastiflow/trapcoll:/usr/share/elastiflow/trapcoll
    environment:
      #EF_ACCOUNT_ID: ""
      EF_LICENSE_ACCEPTED: "false"
      #EF_LICENSE_KEY: ""
      #EF_LICENSE_TELEMETRY_HOSTS: 0
      
      
      #EF_API_BASIC_AUTH_ENABLE: "false"
      #EF_API_BASIC_AUTH_PASSWORD: ""
      #EF_API_BASIC_AUTH_USERNAME: ""
      #EF_API_IP: 0.0.0.0
      #EF_API_PORT: 8080
      #EF_API_TLS_CERT_FILEPATH: ""
      #EF_API_TLS_ENABLE: "false"
      #EF_API_TLS_KEY_FILEPATH: ""
      #EF_INSTANCE_NAME: default
      
      #EF_LOGGER_DEVELOPMENT_ENABLE: "false"
      #EF_LOGGER_ENCODING: json
      #EF_LOGGER_FILE_LOG_COMPRESS: ""
      #EF_LOGGER_FILE_LOG_ENABLE: "false"
      #EF_LOGGER_FILE_LOG_FILENAME: ""
      #EF_LOGGER_FILE_LOG_MAX_AGE: 0
      #EF_LOGGER_FILE_LOG_MAX_BACKUPS: 4
      #EF_LOGGER_FILE_LOG_MAX_SIZE: 100
      #EF_LOGGER_LEVEL: info
      
      #EF_INPUT_TRAP_ENABLE: "true"
      #EF_INPUT_TRAP_LISTENER_AUTHORITATIVE_ENGINE_ID: authoritative_engine_id
      #EF_INPUT_TRAP_LISTENER_CREDENTIALS_DIRECTORY_PATH: /etc/elastiflow/snmp/traps/credentials
      #EF_INPUT_TRAP_LISTENER_CREDENTIALS_SECURE_STORE_CREATE: "false"
      #EF_INPUT_TRAP_LISTENER_CREDENTIALS_SECURE_STORE_ENABLE: "false"
      #EF_INPUT_TRAP_LISTENER_CREDENTIALS_SECURE_STORE_PASSWORD: ""
      #EF_INPUT_TRAP_LISTENER_CREDENTIALS_SECURE_STORE_PRIVATE_KEY_FILE_PATH: /etc/elastiflow/snmp/traps/.age/key.age
      #EF_INPUT_TRAP_LISTENER_CREDENTIALS_SECURE_STORE_PUBLIC_KEY: ""
      #EF_INPUT_TRAP_LISTENER_CREDENTIALS_SECURE_STORE_PUBLIC_KEY_FILE_PATH: /etc/elastiflow/snmp/traps/.age/public-age-keys.txt
      #EF_INPUT_TRAP_LISTENER_CREDENTIALS_SECURE_STORE_TYPE: standard
      #EF_INPUT_TRAP_LISTENER_DEVICE_STORE_CHANGE_DETECTION_ENABLE: "true"
      #EF_INPUT_TRAP_LISTENER_DEVICE_STORE_PATH: /var/lib/elastiflow/trapcoll/devices.yml
      #EF_INPUT_TRAP_LISTENER_DEVICE_STORE_TTL: 30
      #EF_INPUT_TRAP_LISTENER_IP: 0.0.0.0
      #EF_INPUT_TRAP_LISTENER_NORMALIZER_POOL_SIZE: 3
      #EF_INPUT_TRAP_LISTENER_PORT: 162
      #EF_INPUT_TRAP_LISTENER_TRANSPORT: udp
      
      #EF_PROCESSOR_POOL_SIZE: 0
      #EF_PROCESSOR_TRAP_DSL_ENABLE: "true"
      #EF_PROCESSOR_TRAP_DSL_ENTERPRISE_FILE_PATH: /etc/elastiflow/snmp/traps/enterprises.yml
      #EF_PROCESSOR_TRAP_DSL_ENUM_DEFINITIONS_DIRECTORY_PATH: /etc/elastiflow/snmp/enums
      #EF_PROCESSOR_TRAP_DSL_GENERIC_FILE_PATH: /etc/elastiflow/snmp/traps/generic.yml
      #EF_PROCESSOR_TRAP_DSL_RULES_DIRECTORY_PATH: /etc/elastiflow/snmp/traps/rules
      
      EF_OUTPUT_CRIBL_ADDRESSES: 127.0.0.1:10080
      #EF_OUTPUT_CRIBL_ALLOWED_RECORD_TYPES: as_path_hop,flow_option,flow,ifa_hop,telemetry,metric,log
      #EF_OUTPUT_CRIBL_BATCH_DEADLINE: 2000
      #EF_OUTPUT_CRIBL_BATCH_MAX_BYTES: 8388608
      #EF_OUTPUT_CRIBL_DROP_FIELDS: ""
      EF_OUTPUT_CRIBL_ENABLE: "false"
      #EF_OUTPUT_CRIBL_TLS_CA_CERT_FILEPATH: ""
      #EF_OUTPUT_CRIBL_TLS_ENABLE: "true"
      #EF_OUTPUT_CRIBL_TLS_SKIP_VERIFICATION: "false"
      EF_OUTPUT_CRIBL_TOKEN: ""
      
      EF_OUTPUT_GENERIC_HTTP_ADDRESSES: 127.0.0.1:8888
      #EF_OUTPUT_GENERIC_HTTP_ALLOWED_RECORD_TYPES: as_path_hop,flow_option,flow,ifa_hop,telemetry,metric,log
      #EF_OUTPUT_GENERIC_HTTP_BATCH_DEADLINE: 2000
      #EF_OUTPUT_GENERIC_HTTP_BATCH_MAX_BYTES: 8388608
      #EF_OUTPUT_GENERIC_HTTP_DROP_FIELDS: ""
      EF_OUTPUT_GENERIC_HTTP_ECS_ENABLE: "false"
      EF_OUTPUT_GENERIC_HTTP_ENABLE: "false"
      #EF_OUTPUT_GENERIC_HTTP_PASSWORD: ""
      #EF_OUTPUT_GENERIC_HTTP_TIMESTAMP_SOURCE: collect
      #EF_OUTPUT_GENERIC_HTTP_TLS_CA_CERT_FILEPATH: ""
      #EF_OUTPUT_GENERIC_HTTP_TLS_ENABLE: "false"
      #EF_OUTPUT_GENERIC_HTTP_TLS_SKIP_VERIFICATION: "false"
      #EF_OUTPUT_GENERIC_HTTP_USERNAME: ""
      
      EF_OUTPUT_ELASTICSEARCH_ADDRESSES: 127.0.0.1:9200
      #EF_OUTPUT_ELASTICSEARCH_ALLOWED_RECORD_TYPES: as_path_hop,flow_option,flow,ifa_hop,telemetry,metric,log
      #EF_OUTPUT_ELASTICSEARCH_API_KEY: ""
      #EF_OUTPUT_ELASTICSEARCH_BATCH_DEADLINE: 2000
      #EF_OUTPUT_ELASTICSEARCH_BATCH_MAX_BYTES: 8388608
      #EF_OUTPUT_ELASTICSEARCH_CLIENT_CA_CERT_FILEPATH: ""
      #EF_OUTPUT_ELASTICSEARCH_CLIENT_CERT_FILEPATH: ""
      #EF_OUTPUT_ELASTICSEARCH_CLIENT_KEY_FILEPATH: ""
      #EF_OUTPUT_ELASTICSEARCH_CLOUD_ID: ""
      #EF_OUTPUT_ELASTICSEARCH_DROP_FIELDS: ""
      EF_OUTPUT_ELASTICSEARCH_ECS_ENABLE: "false"
      EF_OUTPUT_ELASTICSEARCH_ENABLE: "false"
      #EF_OUTPUT_ELASTICSEARCH_INDEX_PERIOD: rollover
      #EF_OUTPUT_ELASTICSEARCH_INDEX_SUFFIX: ""
      #EF_OUTPUT_ELASTICSEARCH_INDEX_TEMPLATE_CODEC: best_compression
      #EF_OUTPUT_ELASTICSEARCH_INDEX_TEMPLATE_ENABLE: "true"
      #EF_OUTPUT_ELASTICSEARCH_INDEX_TEMPLATE_ILM_LIFECYCLE: elastiflow
      #EF_OUTPUT_ELASTICSEARCH_INDEX_TEMPLATE_OVERWRITE: "true"
      #EF_OUTPUT_ELASTICSEARCH_INDEX_TEMPLATE_PIPELINE_DEFAULT: _none
      #EF_OUTPUT_ELASTICSEARCH_INDEX_TEMPLATE_PIPELINE_FINAL: _none
      #EF_OUTPUT_ELASTICSEARCH_INDEX_TEMPLATE_REFRESH_INTERVAL: 20s
      EF_OUTPUT_ELASTICSEARCH_INDEX_TEMPLATE_REPLICAS: 1
      EF_OUTPUT_ELASTICSEARCH_INDEX_TEMPLATE_SHARDS: 3
      #EF_OUTPUT_ELASTICSEARCH_INDEX_TEMPLATE_SYNTHETIC_SOURCE_ENABLE: "false"
      #EF_OUTPUT_ELASTICSEARCH_MAX_RETRIES: 3
      EF_OUTPUT_ELASTICSEARCH_PASSWORD: changeme
      #EF_OUTPUT_ELASTICSEARCH_RETRY_BACKOFF: 1000
      #EF_OUTPUT_ELASTICSEARCH_RETRY_ENABLE: "true"
      #EF_OUTPUT_ELASTICSEARCH_RETRY_ON_TIMEOUT_ENABLE: "true"
      #EF_OUTPUT_ELASTICSEARCH_STORAGE_OPTIMIZATION_ENABLE: "true"
      #EF_OUTPUT_ELASTICSEARCH_TIMESTAMP_SOURCE: collect
      EF_OUTPUT_ELASTICSEARCH_TLS_CA_CERT_FILEPATH: ""
      EF_OUTPUT_ELASTICSEARCH_TLS_ENABLE: "false"
      EF_OUTPUT_ELASTICSEARCH_TLS_SKIP_VERIFICATION: "false"
      #EF_OUTPUT_ELASTICSEARCH_TSDS_ENABLE: "false"
      EF_OUTPUT_ELASTICSEARCH_USERNAME: elastic
      
      EF_OUTPUT_OPENSEARCH_ADDRESSES: 127.0.0.1:9200
      #EF_OUTPUT_OPENSEARCH_ALLOWED_RECORD_TYPES: as_path_hop,flow_option,flow,ifa_hop,telemetry,metric,log
      #EF_OUTPUT_OPENSEARCH_AWS_ACCESS_KEY: ""
      #EF_OUTPUT_OPENSEARCH_AWS_REGION: ""
      #EF_OUTPUT_OPENSEARCH_AWS_SECRET_KEY: ""
      #EF_OUTPUT_OPENSEARCH_BATCH_DEADLINE: 2000
      #EF_OUTPUT_OPENSEARCH_BATCH_MAX_BYTES: 8388608
      #EF_OUTPUT_OPENSEARCH_CLIENT_CA_CERT_FILEPATH: ""
      #EF_OUTPUT_OPENSEARCH_CLIENT_CERT_FILEPATH: ""
      #EF_OUTPUT_OPENSEARCH_CLIENT_KEY_FILEPATH: ""
      #EF_OUTPUT_OPENSEARCH_DROP_FIELDS: ""
      EF_OUTPUT_OPENSEARCH_ECS_ENABLE: "false"
      EF_OUTPUT_OPENSEARCH_ENABLE: "false"
      #EF_OUTPUT_OPENSEARCH_INDEX_PERIOD: rollover
      #EF_OUTPUT_OPENSEARCH_INDEX_SUFFIX: ""
      #EF_OUTPUT_OPENSEARCH_INDEX_TEMPLATE_CODEC: best_compression
      #EF_OUTPUT_OPENSEARCH_INDEX_TEMPLATE_ENABLE: "true"
      #EF_OUTPUT_OPENSEARCH_INDEX_TEMPLATE_ISM_POLICY: elastiflow
      #EF_OUTPUT_OPENSEARCH_INDEX_TEMPLATE_OVERWRITE: "true"
      #EF_OUTPUT_OPENSEARCH_INDEX_TEMPLATE_PIPELINE_DEFAULT: _none
      #EF_OUTPUT_OPENSEARCH_INDEX_TEMPLATE_PIPELINE_FINAL: _none
      #EF_OUTPUT_OPENSEARCH_INDEX_TEMPLATE_REFRESH_INTERVAL: 20s
      EF_OUTPUT_OPENSEARCH_INDEX_TEMPLATE_REPLICAS: 1
      EF_OUTPUT_OPENSEARCH_INDEX_TEMPLATE_SHARDS: 3
      #EF_OUTPUT_OPENSEARCH_MAX_RETRIES: 3
      EF_OUTPUT_OPENSEARCH_PASSWORD: admin
      #EF_OUTPUT_OPENSEARCH_RETRY_BACKOFF: 1000
      #EF_OUTPUT_OPENSEARCH_RETRY_ENABLE: "true"
      #EF_OUTPUT_OPENSEARCH_RETRY_ON_TIMEOUT_ENABLE: "true"
      #EF_OUTPUT_OPENSEARCH_STORAGE_OPTIMIZATION_ENABLE: "true"
      #EF_OUTPUT_OPENSEARCH_TIMESTAMP_SOURCE: collect
      EF_OUTPUT_OPENSEARCH_TLS_CA_CERT_FILEPATH: ""
      EF_OUTPUT_OPENSEARCH_TLS_ENABLE: "false"
      EF_OUTPUT_OPENSEARCH_TLS_SKIP_VERIFICATION: "false"
      EF_OUTPUT_OPENSEARCH_USERNAME: admin
      
      EF_OUTPUT_SPLUNK_HEC_ADDRESSES: 127.0.0.1:8088
      #EF_OUTPUT_SPLUNK_HEC_ALLOWED_RECORD_TYPES: as_path_hop,flow_option,flow,ifa_hop,telemetry,metric,log
      #EF_OUTPUT_SPLUNK_HEC_BATCH_DEADLINE: 2000
      #EF_OUTPUT_SPLUNK_HEC_BATCH_MAX_BYTES: 8388608
      #EF_OUTPUT_SPLUNK_HEC_CIM_ENABLE: "false"
      #EF_OUTPUT_SPLUNK_HEC_DROP_FIELDS: ""
      EF_OUTPUT_SPLUNK_HEC_ENABLE: "false"
      #EF_OUTPUT_SPLUNK_HEC_TLS_CA_CERT_FILEPATH: ""
      #EF_OUTPUT_SPLUNK_HEC_TLS_ENABLE: "true"
      #EF_OUTPUT_SPLUNK_HEC_TLS_SKIP_VERIFICATION: "false"
      EF_OUTPUT_SPLUNK_HEC_TOKEN: ""
      
      #EF_OUTPUT_KAFKA_ALLOWED_RECORD_TYPES: as_path_hop,flow_option,flow,ifa_hop,telemetry,metric
      EF_OUTPUT_KAFKA_BROKERS: 127.0.0.1:9092
      #EF_OUTPUT_KAFKA_CLIENT_ID: elastiflow-flowcoll
      #EF_OUTPUT_KAFKA_DROP_FIELDS: ""
      #EF_OUTPUT_KAFKA_ECS_ENABLE: "false"
      EF_OUTPUT_KAFKA_ENABLE: "false"
      #EF_OUTPUT_KAFKA_FLAT_RECORD_ENABLE: "true"
      #EF_OUTPUT_KAFKA_PARTITION_KEY: flow.export.ip.addr
      #EF_OUTPUT_KAFKA_PRODUCER_COMPRESSION: 3
      #EF_OUTPUT_KAFKA_PRODUCER_COMPRESSION_LEVEL: -1000
      #EF_OUTPUT_KAFKA_PRODUCER_FLUSH_BYTES: 1000000
      #EF_OUTPUT_KAFKA_PRODUCER_FLUSH_FREQUENCY: 1000
      #EF_OUTPUT_KAFKA_PRODUCER_FLUSH_MAX_MESSAGES: 0
      #EF_OUTPUT_KAFKA_PRODUCER_FLUSH_MESSAGES: 1024
      #EF_OUTPUT_KAFKA_PRODUCER_MAX_MESSAGE_BYTES: 1000000
      #EF_OUTPUT_KAFKA_PRODUCER_REQUIRED_ACKS: 1
      #EF_OUTPUT_KAFKA_PRODUCER_RETRY_BACKOFF: 100
      #EF_OUTPUT_KAFKA_PRODUCER_RETRY_MAX: 3
      #EF_OUTPUT_KAFKA_PRODUCER_TIMEOUT: 10
      #EF_OUTPUT_KAFKA_RACK_ID: ""
      #EF_OUTPUT_KAFKA_RECORD_TYPE_TOPICS_ENABLE: "false"
      EF_OUTPUT_KAFKA_SASL_ENABLE: "false"
      #EF_OUTPUT_KAFKA_SASL_PASSWORD: ""
      #EF_OUTPUT_KAFKA_SASL_USERNAME: ""
      #EF_OUTPUT_KAFKA_TIMEOUT: 30
      #EF_OUTPUT_KAFKA_TIMESTAMP_SOURCE: collect
      #EF_OUTPUT_KAFKA_TLS_CA_CERT_FILEPATH: ""
      #EF_OUTPUT_KAFKA_TLS_CERT_FILEPATH: ""
      #EF_OUTPUT_KAFKA_TLS_ENABLE: "false"
      #EF_OUTPUT_KAFKA_TLS_KEY_FILEPATH: ""
      #EF_OUTPUT_KAFKA_TLS_SKIP_VERIFICATION: "false"
      #EF_OUTPUT_KAFKA_TOPIC: elastiflow-flow-codex
      #EF_OUTPUT_KAFKA_TOPIC_VERSION: 1.0
      #EF_OUTPUT_KAFKA_VERSION: 1.0.0
      
      #EF_OUTPUT_MONITOR_ENABLE: "false"
      #EF_OUTPUT_MONITOR_INTERVAL: 300
      
      #EF_OUTPUT_STDOUT_ALLOWED_RECORD_TYPES: as_path_hop,flow_option,flow,ifa_hop,telemetry,metric,log
      #EF_OUTPUT_STDOUT_ENABLE: "false"
      #EF_OUTPUT_STDOUT_FORMAT: json_pretty

Tag summary

Content type

Image

Digest

sha256:6d21fbfea

Size

84.2 MB

Last updated

about 1 month ago

docker pull elastiflow/trap-collector:7.26.3