- Filebeat Reference: other versions:
- Filebeat overview
- Quick start: installation and configuration
- Set up and run
- Upgrade
- How Filebeat works
- Configure
- Inputs
- Multiline messages
- AWS CloudWatch
- AWS S3
- Azure Event Hub
- Azure Blob Storage
- Benchmark
- CEL
- Cloud Foundry
- CometD
- Container
- Entity Analytics
- ETW
- filestream
- GCP Pub/Sub
- Google Cloud Storage
- HTTP Endpoint
- HTTP JSON
- journald
- Kafka
- Log
- MQTT
- NetFlow
- Office 365 Management Activity API
- Redis
- Salesforce
- Stdin
- Streaming
- Syslog
- TCP
- UDP
- Unix
- winlog
- 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_network_direction
- add_nomad_metadata
- add_observer_metadata
- add_process_metadata
- add_tags
- append
- cache
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_cef
- decode_csv_fields
- decode_duration
- decode_json_fields
- decode_xml
- decode_xml_wineventlog
- decompress_gzip_field
- detect_mime_type
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- move_fields
- parse_aws_vpc_flow_log
- rate_limit
- registered_domain
- rename
- replace
- script
- syslog
- timestamp
- translate_sid
- truncate_fields
- urldecode
- Autodiscover
- Internal queue
- Logging
- HTTP endpoint
- Regular expression support
- Instrumentation
- Feature flags
- filebeat.reference.yml
- Inputs
- 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 using an ingest pipeline
- Use environment variables in the configuration
- Avoid YAML formatting problems
- Migrate
log
input configurations tofilestream
- Migrating from a Deprecated Filebeat Module
- Modules
- Modules overview
- ActiveMQ module
- Apache module
- Auditd module
- AWS module
- AWS Fargate module
- Azure module
- CEF module
- Check Point module
- Cisco module
- CoreDNS module
- CrowdStrike module
- Cyberark PAS module
- Elasticsearch module
- Envoyproxy Module
- Fortinet module
- Google Cloud module
- Google Workspace module
- HAproxy module
- IBM MQ module
- Icinga module
- IIS module
- Iptables module
- Juniper module
- Kafka module
- Kibana module
- Logstash module
- Microsoft module
- MISP module
- MongoDB module
- MSSQL module
- MySQL module
- MySQL Enterprise module
- NATS module
- NetFlow module
- Nginx module
- Office 365 module
- Okta module
- Oracle module
- Osquery module
- Palo Alto Networks module
- pensando module
- PostgreSQL module
- RabbitMQ module
- Redis module
- Salesforce module
- Santa module
- Snyk module
- Sophos module
- Suricata module
- System module
- Threat Intel module
- Traefik module
- Zeek (Bro) Module
- ZooKeeper module
- Zoom module
- Exported fields
- ActiveMQ fields
- Apache fields
- Auditd fields
- AWS fields
- AWS CloudWatch fields
- AWS Fargate fields
- Azure fields
- Beat fields
- Decode CEF processor fields fields
- CEF fields
- Checkpoint fields
- Cisco fields
- Cloud provider metadata fields
- Coredns fields
- Crowdstrike fields
- CyberArk PAS fields
- Docker fields
- ECS fields
- Elasticsearch fields
- Envoyproxy fields
- Fortinet fields
- Google Cloud Platform (GCP) fields
- google_workspace fields
- HAProxy fields
- Host fields
- ibmmq fields
- Icinga fields
- IIS fields
- iptables fields
- Jolokia Discovery autodiscover provider fields
- Juniper JUNOS fields
- Kafka fields
- kibana fields
- Kubernetes fields
- Log file content fields
- logstash fields
- Lumberjack fields
- Microsoft fields
- MISP fields
- mongodb fields
- mssql fields
- MySQL fields
- MySQL Enterprise fields
- NATS fields
- NetFlow fields
- Nginx fields
- Office 365 fields
- Okta fields
- Oracle fields
- Osquery fields
- panw fields
- Pensando fields
- PostgreSQL fields
- Process fields
- RabbitMQ fields
- Redis fields
- s3 fields
- Salesforce fields
- Google Santa fields
- Snyk fields
- sophos fields
- Suricata fields
- System fields
- threatintel fields
- Traefik fields
- Windows ETW fields
- Zeek fields
- ZooKeeper fields
- Zoom fields
- Monitor
- Secure
- Troubleshoot
- Get help
- Debug
- Understand logged metrics
- Common problems
- Error extracting container id while using Kubernetes metadata
- 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
- High RSS memory usage due to MADV settings
- Contribute to Beats
Fortinet module
editFortinet module
editThis is a module for Fortinet logs sent in the syslog format. It supports the following devices:
-
firewall
fileset: Supports FortiOS Firewall logs.
To configure a remote syslog destination, please reference the Fortigate/FortiOS 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 FortiOS version 6.0.x and 6.2.x. Versions above this are expected to work but have not been tested.
Configure the module
editYou can further refine the behavior of the fortinet
module by specifying
variable settings in the
modules.d/fortinet.yml
file, or overriding settings at the command line.
You must enable at least one fileset in the module. Filesets are disabled by default.
Variable settings
editEach fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the fortinet
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, fortinet.firewall.var.paths
instead of firewall.var.paths
.
firewall
fileset settings
edit- module: fortinet firewall: enabled: true var.input: udp var.syslog_host: 0.0.0.0 var.syslog_port: 9004
-
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.
Time zone support
editThis module parses logs that don’t contain time zone information. For these logs,
Filebeat reads the local time zone and uses it when parsing to convert the
timestamp to UTC. The time zone to be used for parsing is included in the event
in the event.timezone
field.
To disable this conversion, the event.timezone
field can be removed with
the drop_fields
processor.
If logs are originated from systems or applications with a different time zone to
the local one, the event.timezone
field can be overwritten with the original
time zone using the add_fields
processor.
See Processors for information about specifying processors in your config.
-
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 9004.
-
var.tags
-
A list of tags to include in events. Including
forwarded
indicates that the events did not originate on this host and causeshost.name
to not be added to events. Defaults to[fortinet-firewall, forwarded]
.
Fortinet ECS fields
editThis is a list of FortiOS fields that are mapped to ECS.
Fortinet Fields | ECS Fields | |
---|---|---|
action |
event.action |
|
agent |
user_agent.original |
|
app |
network.application |
|
appcat |
rule.category |
|
applist |
rule.ruleset |
|
catdesc |
rule.category |
|
ccertissuer |
tls.client_issuer |
|
collectedemail |
source.user.email |
|
comment |
rule.description |
|
daddr |
destination.address |
|
devid |
observer.serial_number |
|
dir |
network.direction |
|
direction |
network.direction |
|
dst_host |
destination.address |
|
dstcollectedemail |
destination.user.email |
|
dst_int |
observer.egress.interface.name |
|
dstintf |
observer.egress.interface.name |
|
dstip |
destination.ip |
|
dstmac |
destination.mac |
|
dstname |
destination.address |
|
dst_port |
destination.port |
|
dstport |
destination.port |
|
dstunauthuser |
destination.user.name |
|
dtype |
vulnerability.category |
|
duration |
event.duration |
|
errorcode |
error.code |
|
event_id |
event.id |
|
eventid |
event.id |
|
eventtime |
event.start |
|
eventtype |
event.action |
|
file |
file.name |
|
filename |
file.name |
|
filesize |
file.size |
|
filetype |
file.extension |
|
filehash |
file.hash.crc32 |
|
from |
source.user.email |
|
group |
source.user.group |
|
hostname |
url.domain |
|
infectedfilename |
file.name |
|
infectedfilesize |
file.size |
|
infectedfiletype |
file.extension |
|
ipaddr |
dns.resolved_ip |
|
level |
log.level |
|
locip |
source.ip |
|
locport |
source.port |
|
logdesc |
rule.description |
|
logid |
event.code |
|
matchfilename |
file.name |
|
matchfiletype |
file.extension |
|
msg |
message |
|
error_num |
error.code |
|
policyid |
rule.id |
|
policy_id |
rule.id |
|
policyname |
rule.name |
|
policytype |
rule.ruleset |
|
poluuid |
rule.uuid |
|
profile |
rule.ruleset |
|
proto |
network.iana_number |
|
qclass |
dns.question.class |
|
qname |
dns.question.name |
|
qtype |
dns.question.type |
|
rcvdbyte |
source.bytes |
|
rcvdpkt |
source.packets |
|
recipient |
destination.user.email |
|
ref |
event.reference |
|
remip |
destination.ip |
|
remport |
destination.port |
|
saddr |
source.address |
|
scertcname |
tls.client.server_name |
|
scertissuer |
tls.server.issuer |
|
sender |
source.user.email |
|
sentbyte |
source.bytes |
|
sentpkt |
source.packets |
|
service |
network.protocol |
|
sess_duration |
event.duration |
|
srcdomain |
source.domain |
|
srcintf |
observer.ingress.interface.name |
|
srcip |
source.ip |
|
source_mac |
source.mac |
|
srcmac |
source.mac |
|
srcport |
source.port |
|
tranip |
destination.nat.ip |
|
tranport |
destination.nat.port |
|
transip |
source.nat.ip |
|
transport |
source.nat.port |
|
tz |
event.timezone |
|
unauthuser |
source.user.name |
|
url |
url.path |
|
user |
source.user.name |
|
xid |
dns.id |
Fields
editFor a description of each field in the module, see the exported fields section.
On this page