- Packetbeat Reference: other versions:
- Packetbeat overview
- Quick start: installation and configuration
- Set up and run
- Upgrade Packetbeat
- Configure
- Traffic sniffing
- Network flows
- Protocols
- Processes
- General settings
- Project paths
- 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
- community_id
- convert
- copy_fields
- decode_base64_field
- 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
- rate_limit
- registered_domain
- rename
- replace
- syslog
- translate_ldap_attribute
- translate_sid
- truncate_fields
- urldecode
- Internal queue
- Logging
- HTTP endpoint
- Instrumentation
- Feature flags
- packetbeat.reference.yml
- How to guides
- Exported fields
- AMQP fields
- Beat fields
- Cassandra fields
- Cloud provider metadata fields
- Common fields
- DHCPv4 fields
- DNS fields
- Docker fields
- ECS fields
- Flow Event fields
- Host fields
- HTTP fields
- ICMP fields
- Jolokia Discovery autodiscover provider fields
- Kubernetes fields
- Memcache fields
- MongoDb fields
- MySQL fields
- NFS fields
- PostgreSQL fields
- Process fields
- Raw fields
- Redis fields
- SIP fields
- Thrift-RPC fields
- Detailed TLS fields
- Transaction Event fields
- Measurements (Transactions) fields
- Monitor
- Secure
- Visualize Packetbeat data in Kibana
- Troubleshoot
- Get help
- Debug
- Understand logged metrics
- Record a trace
- Common problems
- Dashboard in Kibana is breaking up data fields incorrectly
- Packetbeat doesn’t see any packets when using mirror ports
- Packetbeat can’t capture traffic from Windows loopback interface
- Packetbeat is missing long running transactions
- Packetbeat isn’t capturing MySQL performance data
- Packetbeat 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
- Fields show up as nested JSON in Kibana
- Contribute to Beats
Configure APM instrumentation
editConfigure APM instrumentation
editLibbeat uses the Elastic APM Go Agent to instrument its publishing pipeline. Currently, only the Elasticsearch output is instrumented. To gain insight into the performance of Packetbeat, you can enable this instrumentation and send trace data to the APM Integration.
Example configuration with instrumentation enabled:
instrumentation: enabled: true environment: production hosts: - "http://localhost:8200" api_key: L5ER6FEvjkmlfalBealQ3f3fLqf03fazfOV
Configuration options
editYou can specify the following options in the instrumentation
section of the packetbeat.yml
config file:
enabled
editSet to true
to enable instrumentation of Packetbeat.
Defaults to false
.
environment
editSet the environment in which Packetbeat is running, for example, staging
, production
, dev
, etc.
Environments can be filtered in the APM app.
hosts
editThe APM integration host to report instrumentation data to.
Defaults to http://localhost:8200
.
api_key
editThe API Key used to secure communication with the APM Integration.
If api_key
is set then secret_token
will be ignored.
secret_token
editThe Secret token used to secure communication with the APM Integration.
profiling.cpu.enabled
editSet to true
to enable CPU profiling, where profile samples are recorded as events.
This feature is experimental.
profiling.cpu.interval
editConfigure the CPU profiling interval. Defaults to 60s
.
This feature is experimental.
profiling.cpu.duration
editConfigure the CPU profiling duration. Defaults to 10s
.
This feature is experimental.
profiling.heap.enabled
editSet to true
to enable heap profiling.
This feature is experimental.
profiling.heap.interval
editConfigure the heap profiling interval. Defaults to 60s
.
This feature is experimental.
On this page
ElasticON events are back!
Learn about the Elastic Search AI Platform from the experts at our live events.
Register now