Online filebeat deployment documentation and usage
Step 1: install filebeat
Reference: https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-installation.html
Step 2: filebeat directory description
Type Description Locationhome Home of the Filebeat installation. {extract.path} bin The location for the binary files. {extract.path} config The location for configuration files. {extract.path} data The location for persistent data files. {extract.path} / datalogs The location for the logs created by Filebeat. {extract.path} / logs
Step 3: filebeat configuration
The default profile is filebeat.yml
The content is:
# # Filebeat Configuration Example #
# This file is an example configuration file highlighting only the most common
# options. The filebeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
# You can find the full configuration reference here:
Https://www.elastic.co/guide/en/beats/filebeat/index.html
# For more available modules and options, please see the filebeat.reference.yml sample
# configuration file.
# = = Filebeat inputs = =
Filebeat.inputs:
# Each-is an input. Most options can be set at the input level, so
# you can use different inputs for various configurations.
# Below are the input specific configurations.
Type: log
# Change to true to enable this input configuration.
Enabled: false
# Paths that should be crawled and fetched. Glob based paths.
Paths:
/ var/log/.log
#-c:\ programdata\ elasticsearch\ logs\
# Exclude lines. A list of regular expressions to match. It drops the lines that are
# matching any regular expression from the list.
# exclude_lines: ['^ DBG']
# Include lines. A list of regular expressions to match. It exports the lines that are
# matching any regular expression from the list.
# include_lines: ['^ ERR','^ WARN']
# Exclude files. A list of regular expressions to match. Filebeat drops the files that
# are matching any regular expression from the list. By default, no files are dropped.
# exclude_files: ['.gz $']
# Optional additional fields. These fields can be freely picked
# to add additional information to the crawled log files for filtering
# fields:
# level: debug
# review: 1
Multiline options
# Multiline can be used for log messages spanning multiple lines. This is common
# for Java Stack Traces or C-Line Continuation
# The regexp Pattern that has to be matched. The example pattern matches all lines starting with [
# multiline.pattern: ^ [
# Defines if the pattern set under pattern should be negated or not. Default is false.
# multiline.negate: false
# Match can be set to "after" or "before". It is used to define if lines should be append to a pattern
# that was (not) matched before or after or as long as a pattern is not matched based on negate.
# Note: After is the equivalent to previous and before is the equivalent to to next in Logstash
# multiline.match: after
# = = Filebeat modules = =
Filebeat.config.modules:
# Glob pattern for configuration loading
Path: ${path.config} / modules.d/*.yml
# Set to true to enable config reloading
Reload.enabled: false
# Period on which files under path should be checked for changes
# reload.period: 10s
# = Elasticsearch template setting = =
Setup.template.settings:
Index.number_of_shards: 3
# index.codec: best_compression
# _ source.enabled: false
# = = General = =
# The name of the shipper that publishes the network data. It can be used to group
# all the transactions sent by a single shipper in the web interface.
# name:
# The tags of the shipper are included in their own field with each
# transaction published.
# tags: ["service-X", "web-tier"]
# Optional fields that you can specify to add additional information to the
# output.
# fields:
# env: staging
# = = Dashboards = =
# These settings control loading the sample dashboards to the Kibana index. Loading
# the dashboards is disabled by default and can be enabled either by setting the
# options here, or by using the-setup CLI flag or the setup command.
# setup.dashboards.enabled: false
# The URL from where to download the dashboards archive. By default this URL
# has a value which is computed based on the Beat name and version. For released
# versions, this URL points to the dashboard archive on the artifacts.elastic.co
# website.
# setup.dashboards.url:
# = = Kibana = =
# Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.
# This requires a Kibana endpoint configuration.
Setup.kibana:
# Kibana Host
# Scheme and port can be left out and will be set to the default (http and 5601)
# In case you specify and additional path, the scheme is required: http://localhost:5601/path
# IPv6 addresses should always be defined as: https://[2001:db8::1]:5601
# host: "localhost:5601"
# Kibana Space ID
# ID of the Kibana Space into which the dashboards should be loaded. By default
# the Default Space will be used.
# space.id:
# = = Elastic Cloud = =
# These settings simplify using filebeat with the Elastic Cloud (https://cloud.elastic.co/).
# The cloud.id setting overwrites the output.elasticsearch.hosts and
# setup.kibana.host options.
# You can find the cloud.id in the Elastic Cloud web UI.
# cloud.id:
# The cloud.auth setting overwrites the output.elasticsearch.username and
# output.elasticsearch.password settings. The format is:.
# cloud.auth:
# = = Outputs = =
# Configure what output to use when sending the data collected by the beat.
#-Elasticsearch output--
Output.elasticsearch:
# Array of hosts to connect to.
Hosts: ["localhost:9200"]
# Optional protocol and basic auth credentials.
# protocol: "https"
# username: "elastic"
# password: "changeme"
#-Logstash output--
# output.logstash:
# The Logstash hosts
# hosts: ["localhost:5044"]
# Optional SSL. By default is off.
# List of root certificates for HTTPS server verifications
# ssl.certificate_authorities: ["/ etc/pki/root/ca.pem"]
# Certificate for SSL client authentication
# ssl.certificate: "/ etc/pki/client/cert.pem"
# Client Certificate Key
# ssl.key: "/ etc/pki/client/cert.key"
# = = Procesors = =
# Configure processors to enhance or manipulate events generated by the beat.
Processors:
Add_host_metadata: ~ add_cloud_metadata: ~
# = = Logging = =
# Sets log level. The default log level is info.
# Available log levels are: error, warning, info, debug
# logging.level: debug
# At debug level, you can selectively enable logging only for some components.
# To enable all selectors use ["]. Examples of other selectors are "beat"
# "publish", "service".
# logging.selectors: ["]
# = = Xpack Monitoring = =
# filebeat can export internal metrics to a central Elasticsearch monitoring
# cluster. This requires xpack monitoring to be enabled in Elasticsearch. The
# reporting is disabled by default.
# Set to true to enable the monitoring reporter.
# xpack.monitoring.enabled: false
# Uncomment to send the metrics to Elasticsearch. Most settings from the
# Elasticsearch output are accepted here as well. Any setting that is not set is
# automatically inherited from the Elasticsearch output configuration, so if you
# have the Elasticsearch output configured, you can simply uncomment the
# following line.
# xpack.monitoring.elasticsearch:
For more information on the configuration file, please see: https://www.cnblogs.com/zlslch/p/6622079.html
Step 4: filebeat grabs each service log and creates an index to store it in es with the name of the service
Write a filebeat-123.yml file as follows: filebeat.config: prospectors: path: / data/software/filebeat-6.5.1/conf/*.yml reload.enabled: true reload.period: 10soutput.elasticsearch: hosts: ["IP:9200"] index: "% {[fields] [out_topic]}" setup.template.name: "customname" setup.template.pattern: "customname-*" setup.template.overwrite: truelogging : level: debug combines the file ceshi.yml- type: logpaths:- / var/log/zookeeper/zookeeper.logtags: ["zookeeper"] exclude_files: [".gz $"] scan_frequency: 1sfields:server_name: hostname out_topic: "zookeeper_log" multiline:pattern: "^\\ S" match: after- type: logpaths:- / var/log/nginx/access.logtags: ["nginx"] exclude_files under the custom path : [".gz $"] scan_frequency: 1sfields:server_name: hostname out_topic: "nginx_log" multiline:pattern: "^\ S" match: after
In the above section, we crawled the zookeeper log and nginx log, and defined the index names as zookeeper_log and nginx_log, respectively.
Step 5: start filebeat and view the generated index in es
. / filebeat- e-c filebeat-123.yml
Check the index in es
Nginx_log and zookeeper_log indexes have been generated in es, and we look at the contents of the index in kibana
I see that there is already a real-time log running in the zookeeper_log index, so how to automatically update it.
Then we can see that the log is updated in real time 1 minute later on kibana.