Filebeat快速入門

Filebeat快速入門

本筆記整理於https://www.elastic.co/guide/en/beats/filebeat/current/filebeat-installation.html，僅作我的學習總結使用。
Filebeat是輕量級日誌採集工具，常常與ELK搭配使用，做爲數據採集源頭使用。

filebeat使用示意圖

安裝部署

Centos7(做者使用)

因爲下載太慢了，因此我這裏保存了一個下載好的版本（filebeat-6.3.2-linux-x86_64.tar）,若是使用請自取：https://quqi.gblhgk.com/s/1727102/vafFOSOsw5AXKP3d

上傳到服務器，解壓便可

deb(何嘗試):

curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-7.6.1-amd64.deb
    sudo dpkg -i filebeat-7.6.1-amd64.deb

rpm(何嘗試):

curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-7.6.1-x86_64.rpm
sudo rpm -vi filebeat-7.6.1-x86_64.rpm

mac(何嘗試):

curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-7.6.1-darwin-x86_64.tar.gz
tar xzvf filebeat-7.6.1-darwin-x86_64.tar.gz

linux(何嘗試):

curl -L -O https://artifacts.elastic.co/downloads/beats/filebeat/filebeat-7.6.1-linux-x86_64.tar.gz
tar xzvf filebeat-7.6.1-linux-x86_64.tar.gz

Windows(何嘗試)：

1. 下載 https://download.elastic.co/beats/filebeat/filebeat-5.0.0-windows.zip

2. 解壓到 C:\Program Files

3. 重命名 filebeat-5.0.0-windows 目錄爲 Filebeat

4. 右鍵點擊 PowerSHell 圖標，選擇『以管理員身份運行』

5. 運行下列命令，將 Filebeat 安裝成 windows 服務：

PS > cd 'C:\Program Files\Filebeat'
    PS C:\Program Files\Filebeat> .\install-service-filebeat.ps1

注意
可能須要額外授予執行權限。命令爲：PowerShell.exe -ExecutionPolicy RemoteSigned -File .\install-service-filebeat.ps1

快速使用

做者環境：centos七、JDK八、filebeat-6.3.二、logstash-6.5.1

filebeat.yml配置

修改filebeat.yml配置文件，主要修改節點【filebeat.inputs、 paths、 include_lines、name、(output.logstash)】

按需修改，我這裏配置filebeat須要監聽【 /shaofei/logs】文件夾下後綴爲[.log]的文件，監聽的關鍵字是【'Exception','用戶登陸異常'】，
注意： 若是須要監聽中文，須要保證文件編碼爲UTF-8。或者使用【encoding】指定所監聽的文件編碼
我配置了name: 爲"study128"，我這裏使用Logstash做爲它的輸出端【 Logstash output 】,即便沒有接收端來接收filebeat輸出的日誌也不會影響filebeat的啓動
修改配置文件的時候必定要注意yml的格式

###################### 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: true

  # Paths that should be crawled and fetched. Glob based paths.
  paths:
    - /filebeat/testlogs/input/*.log 
  include_lines: ['Exception','用戶登陸異常']
    #- c:\programdata\elasticsearch\logs\*
  #encoding: gbk
  # 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

  # Mutiline 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
  
multiline:
 tail_files: true

#============================= 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: "study128"

# 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"

#============================= 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 `<user>:<pass>`.
#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: ["127.0.0.1:10515"]

  # 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"

#================================ 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:
#scan_frequency: 30s
#----------------------------- kafka output --------------------------------  
#output.kafka:
#  enabled: true
#  hosts: ["132.228.248.201:9092","132.228.248.202:9092","132.228.248.203:9092"]
#  topic: ETE_CBA_ZZQS_LOG_ERROR
#  version: 0.10.0.1

啓動filebeat

./filebeat -e -c filebeat.yml -d "publish"

因爲filebeat.yml啓動會報錯，執行修改filebeat.yml的權限（使用其建議的命令便可）

啓動成功

注意： 要保證filebeat.yml配置的採集路徑是有讀取權限的！

測試採集是否成功

1. 在指定目錄下建立測試日誌

echo "
    2020-03-27 16:51:25,422 ERROR com.quxuecx.Start ->net.sf.json.JSONException: JSONObject["matchID"] not found.
    2020-03-27 16:51:25,422 ERROR com.quxuecx.Start ->net.sf.json.JSONException: JSONObject["matchID"] not found.
    2020-03-27 16:51:25,422 ERROR com.quxuecx.Start ->net.sf.json.JSONException: JSONObject["matchID"] not found.
">>b.log

2. 成功

注意： 若是沒有看到上述採集成功的圖片，請仔細檢查filebeat.yml配置文件以及所監聽路徑和文件的權限是否能夠讀取。
注意： 文件的內容，必須爲log日誌格式以及包括你所監聽的關鍵字，請注意。

對接logstash測試

特別注意： filebeat.yml中配置的output.logstash: hosts: ["127.0.0.1:10515"]其中10515這個端口要和logstash配置文件中input filebeat的端口一致。

logstash的概述請查看>> https://blog.csdn.net/pyfysf/article/details/100942174

logstash的配置文件log_error.conf

input {
    # 配置filebeat
    beats {
        port => 10515
    }
}

filter {

}

output {

    # 配置輸出到文件中
    file{
       path=>"/home/shaofei/output.log"
    }

    #配置輸出到控制檯
	stdout{
		codec=>rubydebug
	}
}

啓動logstash

./bin/logstash -rf ./config/log_error.conf

配置文件log_error.conf

input {
    # 配置filebeat
    beats {
        port => 10515
    }
}

filter {

}

output {

    # 配置輸出到文件中
    file{
       path=>"/home/shaofei/output.log"
    }

    #配置輸出到控制檯
	stdout{
		codec=>rubydebug
	}
}

啓動logstash

./bin/logstash -rf ./config/log_error.conf