- 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
- community_id
- convert
- copy_fields
- decode_base64_field
- 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
- rate_limit
- 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
- 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
- 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 Kibana dashboard loading
editConfigure Kibana dashboard loading
editPacketbeat comes packaged with example Kibana dashboards, visualizations, and searches for visualizing Packetbeat data in Kibana.
To load the dashboards, you can either enable dashboard loading in the
setup.dashboards
section of the packetbeat.yml
config file, or you can
run the setup
command. Dashboard loading is disabled by default.
When dashboard loading is enabled, Packetbeat uses the Kibana API to load the sample dashboards. Dashboard loading is only attempted when Packetbeat starts up. If Kibana is not available at startup, Packetbeat will stop with an error.
To enable dashboard loading, add the following setting to the config file:
setup.dashboards.enabled: true
Configuration options
editYou can specify the following options in the setup.dashboards
section of the
packetbeat.yml
config file:
setup.dashboards.enabled
editIf this option is set to true, Packetbeat loads the sample Kibana dashboards
from the local kibana
directory in the home path of the Packetbeat installation.
Packetbeat loads dashboards on startup if either enabled
is set to true
or the setup.dashboards
section is included in the configuration.
When dashboard loading is enabled, Packetbeat overwrites any existing dashboards that match the names of the dashboards you are loading. This happens every time Packetbeat starts.
If no other options are set, the dashboard are loaded
from the local kibana
directory in the home path of the Packetbeat installation.
To load dashboards from a different location, you can configure one of the
following options: setup.dashboards.directory
,
setup.dashboards.url
, or
setup.dashboards.file
.
setup.dashboards.directory
editThe directory that contains the dashboards to load. The default is the kibana
folder in the home path.
setup.dashboards.url
editThe URL to use for downloading the dashboard archive. If this option is set, Packetbeat downloads the dashboard archive from the specified URL instead of using the local directory.
setup.dashboards.file
editThe file archive (zip file) that contains the dashboards to load. If this option is set, Packetbeat looks for a dashboard archive in the specified path instead of using the local directory.
setup.dashboards.beat
editIn case the archive contains the dashboards for multiple Beats, this setting
lets you select the Beat for which you want to load dashboards. To load all the
dashboards in the archive, set this option to an empty string. The default is
"packetbeat"
.
setup.dashboards.kibana_index
editThe name of the Kibana index to use for setting the configuration. The default
is ".kibana"
setup.dashboards.index
editThe Elasticsearch index name. This setting overwrites the index name defined
in the dashboards and index pattern. Example: "testbeat-*"
This setting only works for Kibana 6.0 and newer.
setup.dashboards.always_kibana
editForce loading of dashboards using the Kibana API without querying Elasticsearch for the version.
The default is false
.
setup.dashboards.retry.enabled
editIf this option is set to true, and Kibana is not reachable at the time when dashboards are loaded, Packetbeat will retry to reconnect to Kibana instead of exiting with an error. Disabled by default.
setup.dashboards.retry.interval
editDuration interval between Kibana connection retries. Defaults to 1 second.
setup.dashboards.retry.maximum
editMaximum number of retries before exiting with an error. Set to 0 for unlimited retrying. Default is unlimited.
On this page
- Configuration options
setup.dashboards.enabled
setup.dashboards.directory
setup.dashboards.url
setup.dashboards.file
setup.dashboards.beat
setup.dashboards.kibana_index
setup.dashboards.index
setup.dashboards.always_kibana
setup.dashboards.retry.enabled
setup.dashboards.retry.interval
setup.dashboards.retry.maximum