- 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
Cyberark PAS module
editCyberark PAS 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 receiving CyberArk Privileged Account Security (PAS) logs over Syslog or a file.
The ingest-geoip Elasticsearch plugin is required to run this module.
Read the quick start to learn how to configure and run modules.
Configure the module
editYou can further refine the behavior of the cyberarkpas
module by specifying
variable settings in the
modules.d/cyberarkpas.yml
file, or overriding settings at the command line.
You must enable at least one fileset in the module. Filesets are disabled by default.
audit
fileset settings
editThe audit
fileset receives Vault Audit logs for User and Safe activities over the syslog protocol.
Vault configuration
editFollow the steps under Security Information and Event Management (SIEM) Applications documentation to setup the integration:
-
Copy the elastic-json-v1.0.xsl XSL Translator file to
the
Server\Syslog
folder. -
Sample syslog configuration for
DBPARM.ini
:
[SYSLOG] UseLegacySyslogFormat=No SyslogTranslatorFile=Syslog\elastic-json-v1.0.xsl SyslogServerIP=<INSERT FILEBEAT IP HERE> SyslogServerPort=<INSERT FILEBEAT PORT HERE> SyslogServerProtocol=TCP
For proper timestamping of events, it’s recommended to use the newer RFC5424 Syslog format
(UseLegacySyslogFormat=No
). To avoid event loss, use TCP
or TLS
protocols instead of UDP
.
Filebeat configuration
editEdit the cyberarkpas.yml
configuration. The following sample configuration will accept TCP
protocol connections from all interfaces:
- module: cyberarkpas audit: enabled: true # Set which input to use between tcp (default), udp, or file. # var.input: tcp var.syslog_host: 0.0.0.0 var.syslog_port: 9301 # With tcp input, set the optional tls configuration: #var.ssl: # enabled: true # certificate: /path/to/cert.pem # key: /path/to/privatekey.pem # key_passphrase: 'password for my key' # Uncoment to keep the original syslog event under event.original. # var.preserve_original_event: true # Set paths for the log files when file input is used. # var.paths:
For encrypted communications, follow the
CyberArk documentation
to configure encrypted protocol in the Vault server and use tcp
input with var.ssl
settings in Filebeat:
- module: cyberarkpas audit: enabled: true # Set which input to use between tcp (default), udp, or file. # var.input: tcp var.syslog_host: 0.0.0.0 var.syslog_port: 9301 # With tcp input, set the optional tls configuration: var.ssl: enabled: true certificate: /path/to/cert.pem key: /path/to/privatekey.pem key_passphrase: 'password for my key' # Uncoment to keep the original syslog event under event.original. # var.preserve_original_event: true # Set paths for the log files when file input is used. # var.paths:
Configuration options
editVariable settings
editEach fileset has separate variable settings for configuring the behavior of the
module. If you don’t specify variable settings, the cyberarkpas
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, cyberarkpas.audit.var.paths
instead of audit.var.paths
.
-
var.input
-
The input to use. One of
tcp
(default),udp
orfile
. -
var.syslog_host
-
The address to listen to UDP or TCP based syslog traffic. Defaults to
localhost
. Set to0.0.0.0
to bind to all available interfaces. -
var.syslog_port
-
The port to listen for syslog traffic. Defaults to
9301
.
Ports below 1024 require Filebeat to run as root.
-
var.ssl
-
Configuration options for SSL parameters to use when acting as a server for
TLS
protocol. See SSL server configuration options. for a description of the available sub-options. -
var.preserve_original_event
-
Set to
true
to store the original syslog message under theevent.original
field. Defaults tofalse
. -
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.
This setting is only applicable when file
input is configured.
Example dashboard
editThis module comes with a sample dashboard:

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