- 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_network_direction
- 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
- detect_mime_type
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- rate_limit
- registered_domain
- rename
- script
- timestamp
- translate_sid
- truncate_fields
- urldecode
- decode_xml
- 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
- Cyberark module
- Cylance module
- Elasticsearch module
- Envoyproxy Module
- F5 module
- Fortinet module
- Google Cloud module
- Google Workspace 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
- MySQL Enterprise module
- nats module
- NetFlow module
- Netscout module
- Nginx module
- Office 365 module
- Okta module
- Oracle module
- Osquery module
- Palo Alto Networks module
- pensando module
- PostgreSQL module
- Proofpoint module
- RabbitMQ module
- Radware module
- Redis module
- Santa module
- Snort module
- Snyk module
- Sonicwall module
- Sophos module
- Squid module
- Suricata module
- System module
- Threat Intel module
- Tomcat module
- Traefik module
- Zeek (Bro) Module
- Zoom module
- Zscaler module
- Exported fields
- ActiveMQ fields
- Apache fields
- Auditd fields
- AWS fields
- aws-cloudwatch 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
- Cyber-Ark fields
- CylanceProtect fields
- Docker fields
- ECS fields
- Elasticsearch fields
- Envoyproxy fields
- Big-IP Access Policy Manager fields
- Fortinet fields
- Google Cloud Platform (GCP) fields
- google_workspace 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
- MySQL Enterprise fields
- NATS fields
- NetFlow fields
- Arbor Peakflow SP fields
- Nginx fields
- Office 365 fields
- Okta fields
- Oracle fields
- Osquery fields
- panw fields
- Pensando fields
- PostgreSQL fields
- Process fields
- Proofpoint Email Security fields
- RabbitMQ fields
- Radware DefensePro fields
- Redis fields
- s3 fields
- Google Santa fields
- Snort/Sourcefire fields
- Snyk fields
- Sonicwall-FW fields
- sophos fields
- Squid fields
- Suricata fields
- System fields
- threatintel fields
- Apache Tomcat fields
- Traefik fields
- Zeek fields
- Zoom 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
Palo Alto Networks module
editPalo Alto Networks module
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
This is a module for Palo Alto Networks PAN-OS firewall monitoring logs received over Syslog or read from a file. It currently supports messages of Traffic and Threat types.
Read the quick start to learn how to configure and run modules.
Compatibility
editThis module has been tested with logs generated by devices running PAN-OS versions 7.1 to 9.0 but limited compatibility is expected for earlier versions.
The ingest-geoip Elasticsearch plugin is required to run this module.
Configure the module
editYou can further refine the behavior of the panw
module by specifying
variable settings in the
modules.d/panw.yml
file, or overriding settings at the command line.
The module is by default configured to run via syslog on port 9001. However it can also be configured to read logs from a file. See the following example.
- module: panw panos: enabled: true var.paths: ["/var/log/pan-os.log"] var.input: "file"
Variable settings
editEach fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the panw
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, panw.panos.var.paths
instead of panos.var.paths
.
panos
fileset settings
editExample config:
panos: var.syslog_host: 0.0.0.0 var.syslog_port: 514
-
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.syslog_host
-
The interface to listen to UDP based syslog traffic. Defaults to
localhost
. Set to0.0.0.0
to bind to all available interfaces. -
var.syslog_port
-
The UDP port to listen for syslog traffic. Defaults to
9001
Ports below 1024 require Filebeat to run as root.
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.
ECS field mappings
editThese are the PAN-OS to ECS field mappings as well as those fields still not
in ECS that are added under the panw.panos
prefix:
Table 5. Traffic log mappings
PAN-OS Field | ECS Field | Non-standard field |
---|---|---|
Receive Time |
event.created |
|
Serial Number |
observer.serial_number |
|
Type |
event.category |
|
Subtype |
event.action |
|
Generated Time |
|
|
Source IP |
client.ip source.ip |
|
Destination IP |
server.ip destination.ip |
|
NAT Source IP |
panw.panos.source.nat.ip |
|
NAT Destination IP |
panw.panos.destination.nat.ip |
|
Rule Name |
panw.panos.ruleset |
|
Source User |
client.user.name source.user.name |
|
Destination User |
server.user.name destination.user.name |
|
Application |
network.application |
|
Source Zone |
panw.panos.source.zone |
|
Destination Zone |
panw.panos.destination.zone |
|
Ingress Interface |
panw.panos.source.interface |
|
Egress Interface |
panw.panos.destination.interface |
|
Session ID |
panw.panos.flow_id |
|
Source Port |
client.port source.port |
|
Destination Port |
destination.port server.port |
|
NAT Source Port |
panw.panos.source.nat.port |
|
NAT Destination Port |
panw.panos.destination.nat.port |
|
Flags |
labels |
|
Protocol |
network.transport |
|
Action |
event.outcome |
|
Bytes |
network.bytes |
|
Bytes Sent |
client.bytes destination.bytes |
|
Bytes Received |
server.bytes source.bytes |
|
Packets |
network.packets |
|
Start Time |
event.start |
|
Elapsed Time |
event.duration |
|
Category |
panw.panos.url.category |
|
Sequence Number |
panw.panos.sequence_number |
|
Packets Sent |
server.packets destination.packets |
|
Packets Received |
client.packets source.packets |
|
Device Name |
observer.hostname |
Table 6. Threat logs mappings
PAN-OS Field | ECS Field | Non-standard field |
---|---|---|
Receive Time |
event.created |
|
Serial Number |
observer.serial_number |
|
Type |
event.category |
|
Subtype |
event.action |
|
Generated Time |
|
|
Source IP |
client.ip source.ip |
|
Destination IP |
server.ip destination.ip |
|
NAT Source IP |
panw.panos.source.nat.ip |
|
NAT Destination IP |
panw.panos.destination.nat.ip |
|
Rule Name |
panw.panos.ruleset |
|
Source User |
client.user.name source.user.name |
|
Destination User |
server.user.name destination.user.name |
|
Application |
network.application |
|
Source Zone |
panw.panos.source.zone |
|
Destination Zone |
panw.panos.destination.zone |
|
Ingress Interface |
panw.panos.source.interface |
|
Egress Interface |
panw.panos.destination.interface |
|
Session ID |
panw.panos.flow_id |
|
Source Port |
client.port source.port |
|
Destination Port |
destination.port server.port |
|
NAT Source Port |
panw.panos.source.nat.port |
|
NAT Destination Port |
panw.panos.destination.nat.port |
|
Flags |
labels |
|
Protocol |
network.transport |
|
Action |
event.outcome |
|
Miscellaneous |
url.original |
panw.panos.threat.resource |
Threat ID |
panw.panos.threat.id |
|
Category |
panw.panos.url.category |
|
Severity |
log.level |
|
Direction |
network.direction |
|
Source Location |
source.geo.name |
|
Destination Location |
destination.geo.name |
|
PCAP_id |
panw.panos.network.pcap_id |
|
Filedigest |
panw.panos.file.hash |
|
User Agent |
user_agent.original |
|
File Type |
file.type |
|
X-Forwarded-For |
network.forwarded_ip |
|
Referer |
http.request.referer |
|
Sender |
source.user.email |
|
Subject |
panw.panos.subject |
|
Recipient |
destination.user.email |
|
Device Name |
observer.hostname |
Example dashboard
editThis module comes with two sample dashboards:


Fields
editFor a description of each field in the module, see the exported fields section.
On this page