- 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_observer_metadata
- add_process_metadata
- add_tags
- community_id
- convert
- copy_fields
- decode_base64_field
- decode_json_fields
- decompress_gzip_field
- dissect
- dns
- drop_event
- drop_fields
- extract_array
- fingerprint
- include_fields
- registered_domain
- rename
- translate_sid
- truncate_fields
- urldecode
- Internal queue
- Logging
- HTTP endpoint
- Instrumentation
- 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
- Thrift-RPC fields
- Detailed TLS fields
- Transaction Event fields
- Measurements (Transactions) fields
- Monitor
- Secure
- Visualize Packetbeat data in Kibana
- Troubleshoot
- Get help
- Debug
- 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
- Fields show up as nested JSON in Kibana
- Contribute to Beats
Settings for internal collection
editSettings for internal collection
editUse the following settings to configure internal collection when you are not using Metricbeat to collect monitoring data.
You specify these settings in the X-Pack monitoring section of the
packetbeat.yml
config file:
monitoring.enabled
editThe monitoring.enabled
config is a boolean setting to enable or disable X-Pack monitoring.
If set to true
, monitoring is enabled.
The default value is false
.
monitoring.elasticsearch
editThe Elasticsearch instances that you want to ship your Packetbeat metrics to. This configuration option contains the following fields:
api_key
editThe detail of the API key to be used to send monitoring information to Elasticsearch. See Grant access using API keys for more information.
bulk_max_size
editThe maximum number of metrics to bulk in a single Elasticsearch bulk API index request.
The default is 50
. For more information, see Elasticsearch.
backoff.init
editThe number of seconds to wait before trying to reconnect to Elasticsearch after
a network error. After waiting backoff.init
seconds, Packetbeat tries to
reconnect. If the attempt fails, the backoff timer is increased exponentially up
to backoff.max
. After a successful connection, the backoff timer is reset. The
default is 1s.
backoff.max
editThe maximum number of seconds to wait before attempting to connect to Elasticsearch after a network error. The default is 60s.
compression_level
editThe gzip compression level. Setting this value to 0
disables compression. The
compression level must be in the range of 1
(best speed) to 9
(best
compression). The default value is 0
. Increasing the compression level
reduces the network usage but increases the CPU usage.
headers
editCustom HTTP headers to add to each request. For more information, see Elasticsearch.
hosts
editThe list of Elasticsearch nodes to connect to. Monitoring metrics are distributed to these nodes in round robin order. For more information, see Elasticsearch.
max_retries
editThe number of times to retry sending the monitoring metrics after a failure.
After the specified number of retries, the metrics are typically dropped. The
default value is 3
. For more information, see Elasticsearch.
parameters
editDictionary of HTTP parameters to pass within the url with index operations.
password
editThe password that Packetbeat uses to authenticate with the Elasticsearch instances for shipping monitoring data.
metrics.period
editThe time interval (in seconds) when metrics are sent to the Elasticsearch cluster. A new snapshot of Packetbeat metrics is generated and scheduled for publishing each period. The default value is 10 * time.Second.
state.period
editThe time interval (in seconds) when state information are sent to the Elasticsearch cluster. A new snapshot of Packetbeat state is generated and scheduled for publishing each period. The default value is 60 * time.Second.
protocol
editThe name of the protocol to use when connecting to the Elasticsearch cluster. The options
are: http
or https
. The default is http
. If you specify a URL for hosts
,
however, the value of protocol is overridden by the scheme you specify in the URL.
proxy_url
editThe URL of the proxy to use when connecting to the Elasticsearch cluster. For more information, see Elasticsearch.
timeout
editThe HTTP request timeout in seconds for the Elasticsearch request. The default is 90
.
ssl
editConfiguration options for Transport Layer Security (TLS) or Secure Sockets Layer
(SSL) parameters like the certificate authority (CA) to use for HTTPS-based
connections. If the ssl
section is missing, the host CAs are used for
HTTPS connections to Elasticsearch. For more information, see SSL.
username
editThe user ID that Packetbeat uses to authenticate with the Elasticsearch instances for shipping monitoring data.
On this page