Sign inSign up

elastiflow/snmp-collector

By elastiflow

Updated about 1 month ago

Image
0

10K+

elastiflow/snmp-collector repository overview

The ElastiFlow Unified SNMP Collector is more than a simple SNMP poller. It has been designed to meet the requirements of the most demanding production environments. You can download the latest SNMP definitions from our snmp repository on GitHub.

services:
  # nosemgrep: yaml.docker-compose.security.writable-filesystem-service.writable-filesystem-service, yaml.docker-compose.security.no-new-privileges.no-new-privileges
  snmp-collector:
    image: elastiflow/snmp-collector:7.26.3
    container_name: snmp-collector
    restart: 'unless-stopped'
    network_mode: 'host'
    volumes:
      - /etc/elastiflow:/etc/elastiflow
      - /usr/share/elastiflow/snmpcoll:/usr/share/elastiflow/snmpcoll
    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: /var/log/elastiflow/snmpcoll/snmpcoll.log
      #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_SNMP_DEFAULTS_DIRECTORY_PATH: /etc/elastiflow/snmp/defaults
      #EF_INPUT_SNMP_DEVICE_DEFINITIONS_DIRECTORY_PATH: /etc/elastiflow/snmp/devices
      #EF_INPUT_SNMP_DEVICE_DEFINITIONS_SECURE_STORE_CREATE: "false"
      #EF_INPUT_SNMP_DEVICE_DEFINITIONS_SECURE_STORE_ENABLE: "false"
      #EF_INPUT_SNMP_DEVICE_DEFINITIONS_SECURE_STORE_PASSWORD: ""
      #EF_INPUT_SNMP_DEVICE_DEFINITIONS_SECURE_STORE_PRIVATE_KEY_FILE_PATH: /etc/elastiflow/snmp/.age/key.age
      #EF_INPUT_SNMP_DEVICE_DEFINITIONS_SECURE_STORE_PUBLIC_KEY: ""
      #EF_INPUT_SNMP_DEVICE_DEFINITIONS_SECURE_STORE_PUBLIC_KEY_FILE_PATH: /etc/elastiflow/snmp/.age/public-age-keys.txt
      #EF_INPUT_SNMP_DEVICE_DEFINITIONS_SECURE_STORE_TYPE: sops
      #EF_INPUT_SNMP_DEVICE_GROUP_DEFINITIONS_DIRECTORY_PATH: /etc/elastiflow/snmp/device_groups
      #EF_INPUT_SNMP_ENABLE: "true"
      #EF_INPUT_SNMP_OBJECT_DEFINITIONS_DIRECTORY_PATH: /etc/elastiflow/snmp/objects
      #EF_INPUT_SNMP_OBJECT_GROUP_DEFINITIONS_DIRECTORY_PATH: /etc/elastiflow/snmp/object_groups
      #EF_INPUT_SNMP_PERSIST_DIRECTORY_PATH: /usr/share/elastiflow/snmpcoll
      #EF_INPUT_SNMP_PERSIST_ENABLE: "true"
      #EF_INPUT_SNMP_POLLER_ERROR_HANDLING: partial
      #EF_INPUT_SNMP_POLLER_WORKER_POOL_SIZE: 0
      
      #EF_PROCESSOR_DROP_FIELDS: ""
      #EF_PROCESSOR_DURATION_PRECISION: ms
      #EF_PROCESSOR_ENRICH_ASN_PREF: lookup
      EF_PROCESSOR_ENRICH_IPADDR_DNS_ENABLE: "false"
      #EF_PROCESSOR_ENRICH_IPADDR_DNS_INCLEXCL_PATH: ""
      #EF_PROCESSOR_ENRICH_IPADDR_DNS_INCLEXCL_REFRESH_RATE: 15
      EF_PROCESSOR_ENRICH_IPADDR_DNS_NAMESERVER_IP: ""
      EF_PROCESSOR_ENRICH_IPADDR_DNS_NAMESERVER_TIMEOUT: 3000
      #EF_PROCESSOR_ENRICH_IPADDR_DNS_RESOLVE_PRIVATE: "true"
      #EF_PROCESSOR_ENRICH_IPADDR_DNS_RESOLVE_PUBLIC: "true"
      #EF_PROCESSOR_ENRICH_IPADDR_DNS_USERDEF_PATH: ""
      #EF_PROCESSOR_ENRICH_IPADDR_DNS_USERDEF_REFRESH_RATE: 15
      EF_PROCESSOR_ENRICH_IPADDR_MAXMIND_ASN_ENABLE: "false"
      #EF_PROCESSOR_ENRICH_IPADDR_MAXMIND_ASN_PATH: /etc/elastiflow/maxmind/GeoLite2-ASN.mmdb
      EF_PROCESSOR_ENRICH_IPADDR_MAXMIND_GEOIP_ENABLE: "false"
      #EF_PROCESSOR_ENRICH_IPADDR_MAXMIND_GEOIP_INCLEXCL_PATH: ""
      #EF_PROCESSOR_ENRICH_IPADDR_MAXMIND_GEOIP_INCLEXCL_REFRESH_RATE: 15
      #EF_PROCESSOR_ENRICH_IPADDR_MAXMIND_GEOIP_LANG: en
      #EF_PROCESSOR_ENRICH_IPADDR_MAXMIND_GEOIP_PATH: /etc/elastiflow/maxmind/GeoLite2-City.mmdb
      #EF_PROCESSOR_ENRICH_IPADDR_MAXMIND_GEOIP_VALUES: city,country,country_code,location,timezone
      #EF_PROCESSOR_ENRICH_IPADDR_METADATA_API_ENABLE: "false"
      EF_PROCESSOR_ENRICH_IPADDR_METADATA_ENABLE: "false"
      #EF_PROCESSOR_ENRICH_IPADDR_METADATA_REFRESH_RATE: 15
      #EF_PROCESSOR_ENRICH_IPADDR_METADATA_USERDEF_PATH: ""
      #EF_PROCESSOR_ENRICH_IPADDR_TTL: 7200
      EF_PROCESSOR_ENRICH_NETIF_METADATA_ENABLE: "false"
      #EF_PROCESSOR_ENRICH_NETIF_METADATA_REFRESH_RATE: 15
      #EF_PROCESSOR_ENRICH_NETIF_METADATA_USERDEF_PATH: ""
      EF_PROCESSOR_ENRICH_NETIF_SNMP_COMMUNITIES: public
      EF_PROCESSOR_ENRICH_NETIF_SNMP_ENABLE: "false"
      #EF_PROCESSOR_ENRICH_NETIF_SNMP_PORT: 161
      #EF_PROCESSOR_ENRICH_NETIF_SNMP_RETRIES: 1
      #EF_PROCESSOR_ENRICH_NETIF_SNMP_TIMEOUT: 2
      #EF_PROCESSOR_ENRICH_NETIF_SNMP_V3_AUTHENTICATION_PASSPHRASE: ""
      #EF_PROCESSOR_ENRICH_NETIF_SNMP_V3_AUTHENTICATION_PROTOCOL: noauth
      #EF_PROCESSOR_ENRICH_NETIF_SNMP_V3_PRIVACY_PASSPHRASE: ""
      #EF_PROCESSOR_ENRICH_NETIF_SNMP_V3_PRIVACY_PROTOCOL: nopriv
      #EF_PROCESSOR_ENRICH_NETIF_SNMP_V3_USERNAME: ""
      #EF_PROCESSOR_ENRICH_NETIF_SNMP_VERSION: 2
      #EF_PROCESSOR_ENRICH_NETIF_TTL: 7200
      #EF_PROCESSOR_KEEP_CPU_TICKS: "true"
      #EF_PROCESSOR_PERCENT_NORM: 100
      #EF_PROCESSOR_POOL_SIZE: 0
      #EF_PROCESSOR_SNMP_ENUM_DEFINITIONS_DIRECTORY_PATH: /etc/elastiflow/snmp/enums
      #EF_PROCESSOR_SNMP_ENUM_ENABLE: "true"
      #EF_PROCESSOR_TIMESTAMP_PRECISION: ms
      #EF_PROCESSOR_TRANSLATE_KEEP_IDS: default
      
      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:187a699b8

Size

84.1 MB

Last updated

about 1 month ago

docker pull elastiflow/snmp-collector:7.26.3