- Filebeat Reference: other versions:
- Filebeat overview
- Quick start: installation and configuration
- Set up and run
- Upgrade
- How Filebeat works
- Configure
- Inputs
- Modules
- General settings
- Project paths
- Config file loading
- Output
- Kerberos
- SSL
- Index lifecycle management (ILM)
- Elasticsearch index template
- Kibana endpoint
- Kibana dashboards
- Processors
- Define processors
- add_cloud_metadata
- add_cloudfoundry_metadata
- add_docker_metadata
- add_fields
- add_host_metadata
- add_id
- add_kubernetes_metadata
- add_labels
- add_locale
- add_observer_metadata
- add_process_metadata
- add_tags
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_cef
- decode_csv_fields
- decode_json_fields
- decompress_gzip_field
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- registered_domain
- rename
- script
- timestamp
- translate_sid
- truncate_fields
- urldecode
- Autodiscover
- Internal queue
- Load balancing
- Logging
- HTTP endpoint
- Regular expression support
- Instrumentation
- filebeat.reference.yml
- How to guides
- Override configuration settings
- Load the Elasticsearch index template
- Change the index name
- Load Kibana dashboards
- Load ingest pipelines
- Enrich events with geoIP information
- Deduplicate data
- Parse data by using ingest node
- Use environment variables in the configuration
- Avoid YAML formatting problems
- Beats central management
- Modules
- Modules overview
- ActiveMQ module
- Apache module
- Auditd module
- AWS module
- Azure module
- Barracuda module
- Bluecoat module
- CEF module
- Check Point module
- Cisco module
- CoreDNS module
- Crowdstrike module
- Cylance module
- Elasticsearch module
- Envoyproxy Module
- F5 module
- Fortinet module
- Google Cloud module
- GSuite module
- haproxy module
- IBM MQ module
- Icinga module
- IIS module
- Imperva module
- Infoblox module
- Iptables module
- Juniper module
- Kafka module
- Kibana module
- Logstash module
- Microsoft module
- MISP module
- MongoDB module
- MSSQL module
- MySQL module
- nats module
- NetFlow module
- Netscout module
- Nginx module
- Office 365 module
- Okta module
- Osquery module
- Palo Alto Networks module
- PostgreSQL module
- RabbitMQ module
- Radware module
- Redis module
- Santa module
- Sonicwall module
- Sophos module
- Squid module
- Suricata module
- System module
- Tomcat module
- Traefik module
- Zeek (Bro) Module
- Zscaler module
- Exported fields
- ActiveMQ fields
- Apache fields
- Auditd fields
- AWS fields
- awscloudwatch fields
- Azure fields
- Barracuda Web Application Firewall fields
- Beat fields
- Blue Coat Director fields
- Decode CEF processor fields fields
- CEF fields
- Checkpoint fields
- Cisco fields
- Cloud provider metadata fields
- Coredns fields
- Crowdstrike fields
- CylanceProtect fields
- Docker fields
- ECS fields
- Elasticsearch fields
- Envoyproxy fields
- Big-IP Access Policy Manager fields
- Fortinet fields
- Google Cloud fields
- gsuite fields
- HAProxy fields
- Host fields
- ibmmq fields
- Icinga fields
- IIS fields
- Imperva SecureSphere fields
- Infoblox NIOS fields
- iptables fields
- Jolokia Discovery autodiscover provider fields
- Juniper JUNOS fields
- Kafka fields
- kibana fields
- Kubernetes fields
- Log file content fields
- logstash fields
- Microsoft fields
- MISP fields
- mongodb fields
- mssql fields
- MySQL fields
- NATS fields
- NetFlow fields
- Arbor Peakflow SP fields
- Nginx fields
- Office 365 fields
- Okta fields
- Osquery fields
- panw fields
- PostgreSQL fields
- Process fields
- RabbitMQ fields
- Radware DefensePro fields
- Redis fields
- s3 fields
- Google Santa fields
- Sonicwall-FW fields
- sophos fields
- Squid fields
- Suricata fields
- System fields
- Apache Tomcat fields
- Traefik fields
- Zeek fields
- Zscaler NSS fields
- Monitor
- Secure
- Troubleshoot
- Get help
- Debug
- Common problems
- Can’t read log files from network volumes
- Filebeat isn’t collecting lines from a file
- Too many open file handlers
- Registry file is too large
- Inode reuse causes Filebeat to skip lines
- Log rotation results in lost or duplicate events
- Open file handlers cause issues with Windows file rotation
- Filebeat is using too much CPU
- Dashboard in Kibana is breaking up data fields incorrectly
- Fields are not indexed or usable in Kibana visualizations
- Filebeat isn’t shipping the last line of a file
- Filebeat keeps open file handlers of deleted files for a long time
- Filebeat uses too much bandwidth
- Error loading config file
- Found unexpected or unknown characters
- Logstash connection doesn’t work
- Publishing to Logstash fails with "connection reset by peer" message
- @metadata is missing in Logstash
- Not sure whether to use Logstash or Beats
- SSL client fails to connect to Logstash
- Monitoring UI shows fewer Beats than expected
- Dashboard could not locate the index-pattern
- Contribute to Beats
Sophos module
editSophos module
editThis is a module for Sophos Products, currently it supports XG SFOS logs sent in the syslog format.
To configure a remote syslog destination, please reference the SophosXG/SFOS Documentation.
The syslog format choosen should be Default
.
Read the quick start to learn how to configure and run modules.
Compatibility
editThis module has been tested against SFOS version 17.5.x and 18.0.x. Versions above this are expected to work but have not been tested.
Configure the module
editYou can further refine the behavior of the sophos
module by specifying
variable settings in the
modules.d/sophos.yml
file, or overriding settings at the command line.
Variable settings
editEach fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the sophos
module uses
the defaults.
For advanced use cases, you can also override input settings. See Override input settings.
When you specify a setting at the command line, remember to prefix the
setting with the module name, for example, sophos.xg.var.paths
instead of xg.var.paths
.
xg
fileset settings
editThe Sophos XG firewalls do not include hostname in either the syslog header or body, and the only unique identifier for each firewall is the related serial number.
Below you will see an example configuration file, that sets the default hostname (if no serial number is included in the config file), and example on how to map serial numbers to a hostname
- module: sophos xg: enabled: true var.input: udp var.syslog_host: 0.0.0.0 var.syslog_port: 9005 var.default_host_name: firewall.localgroup.local var.known_devices: "1234567890123457": "a.host.local" "1234234590678557": "b.host.local"
-
var.paths
-
An array of glob-based paths that specify where to look for the log files. All
patterns supported by Go Glob
are also supported here. For example, you can use wildcards to fetch all files
from a predefined level of subdirectories:
/path/to/log/*/*.log
. This fetches all.log
files from the subfolders of/path/to/log
. It does not fetch log files from the/path/to/log
folder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system. -
var.input
-
The input to use, can be either the value
tcp
,udp
orfile
. -
var.syslog_host
- The interface to listen to all syslog traffic. Defaults to localhost. Set to 0.0.0.0 to bind to all available interfaces.
-
var.syslog_port
- The port to listen for syslog traffic. Defaults to 9005.
-
var.host_name
-
Host name / Observer name, since SophosXG does not provide this in the syslog file.
Default to
firewall.localgroup.local
SophosXG ECS fields
editThis is a list of SophosXG fields that are mapped to ECS.
SophosXG Fields | ECS Fields | |
---|---|---|
application |
network.protocol |
|
classification |
rule.category |
|
device_id |
observer.serial_number |
|
domainname |
url.domain |
|
dst_host |
destination.address |
|
dst_int |
observer.egress.interface.name |
|
dstzonetype |
observer.egress.zone |
|
dst_ip |
destination.ip |
|
destinationip |
destination.ip |
|
dst_mac |
destination.mac |
|
dstname |
destination.address |
|
dst_port |
destination.port |
|
dst_domainname |
url.domain |
|
duration |
event.duration |
|
filename |
file.name |
|
filetype |
file.extension |
|
file_size |
file.size |
|
file_path |
file.directory |
|
fw_rule_id |
rule.id |
|
from_email_address |
source.user.email |
|
httpstatus |
http.response.status_code |
|
in_interface |
observer.ingress.interface.name |
|
log_id |
event.code |
|
log_subtype |
event.action |
|
message |
message |
|
method |
http.request.method |
|
policy_type |
rule.ruleset |
|
protocol |
network.transport |
|
recv_bytes |
destination.bytes |
|
recv_pkts |
destination.packets |
|
referer |
http.request.referrer |
|
sent_bytes |
source.bytes |
|
sent_pkts |
source.packets |
|
sha1sum |
file.hash.sha1 |
|
srczonetype |
observer.ingress.zone |
|
src_ip |
source.ip |
|
src_domainname |
url.domain |
|
sourceip |
source.ip |
|
src_mac |
source.mac |
|
src_port |
source.port |
|
status_code |
http.response.status_code |
|
time_zone |
event.timezone |
|
to_email_address |
destination.user.email |
|
tran_dst_ip |
destination.nat.ip |
|
tran_dst_port |
destination.nat.port |
|
tran_src_ip |
source.nat.ip |
|
tran_src_port |
source.nat.port |
|
url |
url.original |
|
user_agent |
user_agent.original |
|
useragent |
user_agent.original |
|
user_gp |
source.user.group |
|
user_name |
source.user.name |
|
ws_protocol |
http.version |
Fields
editFor a description of each field in the module, see the exported fields section.
On this page