Logstash官网文档译文（一）

设置并启动Logstash

Logstash目录布局

本节描述在解包Logstash安装包时创建的默认目录结构。

.zip和.tar.gz包的目录布局

.zip和.tar.gz包是完全独立的。默认情况下，所有文件和目录都包含在主目录中——解压归档文件时创建的目录。

这非常方便，因为您不需要创建任何目录就可以开始使用Logstash，而卸载Logstash就像删除主目录一样简单。但是，建议更改config和logs目录的默认位置，这样以后就不会删除重要的数据。

Debian和RPM包目录布局

Docker镜像的目录布局

Docker映像是从.tar.gz包中创建的，并遵循类似的目录布局。

Logstash配置文件

Logstash有两种类型的配置文件:pipeline配置文件(定义Logstash处理管道)和setting文件(指定控制Logstash启动和执行的选项)。

Pipeline配置文件

在定义Logstash处理管道的各个阶段时，您将创建管道配置文件。在deb和rpm中，将管道配置文件放在/etc/logstash/conf的目录下。Logstash尝试只加载/etc/logstash/conf中扩展名为.conf的文件并忽略所有其他文件。

Settings配置文件

在Logstash安装中已经定义了设置文件。Logstash包含以下设置文件:

logstash.yaml

包含Logstash配置指令。您可以在这个文件中设置指令，而不是在命令行中传递指令。您在命令行中设置的任何指令都会覆盖logstash.yaml中相应的设置。查到logstash.yml以获取更多信息。

pipeline.yaml

包含用于在单个Logstash实例中运行多个管道的框架和指令。有关更多信息，请参阅多个管道。

jvm.options

包含JVM配置指令。使用此文件设置总堆空间的初始值和最大值。还可以使用此文件设置Logstash的区域设置。在单独的行中指定每个指令。该文件中的所有其他设置都被认为是专家设置。

log4j2.properties

包含log4j2库的默认设置。有关更多信息，请参阅Log4j2配置。

startup.options(Linux)

包含系统安装脚本在/usr/share/logstash/bin中使用的选项，用于为您的系统构建适当的启动脚本。在安装Logstash包时，在安装过程的最后执行system-install脚本，并使用在启动时指定的设置。选项，用于设置用户、组、服务名称和服务描述等选项。默认情况下，Logstash服务安装在用户Logstash下。启动。options文件使您更容易安装Logstash服务的多个实例。您可以复制文件并更改特定设置的值。注意这个启动。启动时没有读取选项文件。如果您希望更改Logstash启动脚本(例如，更改Logstash用户或从不同的配置路径读取)，则必须重新运行system-install脚本(以root身份)以传入新的设置。

Logstash.yml

您可以在Logstash设置文件logstash.yaml中设置选项，以控制Logstash的执行。例如，您可以指定管道设置、配置文件的位置、日志记录选项和其他设置。当您运行logstash时，logstash文件中的大多数设置也可以作为命令行指令使用。您在命令行中设置的任何指令都会覆盖logstash.yaml文件中相应的设置。

logstash.yaml文件是用YAML编写的。它的位置因平台而异(请参阅Logstash目录布局)。您可以以层次形式指定设置或使用 flat keys。例如，要使用分层形式设置管道批大小和批延迟，可以指定:

pipeline:
  batch:
    size: 125
    delay: 50

要表示与普通键相同的值，可以指定:

pipeline.batch.size: 125
pipeline.batch.delay: 50

logstash.yaml文件还支持环境变量和keystore secrets的bash式填写设置值。

pipeline:
  batch:
    size: ${BATCH_SIZE}
    delay: ${BATCH_DELAY:50}
node:
  name: "node_${LS_NODE_NAME}"
path:
   queue: "/tmp/${QUEUE_DIR:queue}"

注意，支持 $ 符号，在上面的例子中，设置默认批处理延迟为 50，默认 path.queue 为 /tmp/queue。

模块也可以在logstash.yml文件中指定。模块的定义将有这样的格式：

modules:
  - name: MODULE_NAME1
    var.PLUGIN_TYPE1.PLUGIN_NAME1.KEY1: VALUE
    var.PLUGIN_TYPE1.PLUGIN_NAME1.KEY2: VALUE
    var.PLUGIN_TYPE2.PLUGIN_NAME2.KEY1: VALUE
    var.PLUGIN_TYPE3.PLUGIN_NAME3.KEY1: VALUE
  - name: MODULE_NAME2
    var.PLUGIN_TYPE1.PLUGIN_NAME1.KEY1: VALUE
    var.PLUGIN_TYPE1.PLUGIN_NAME1.KEY2: VALUE

如果使用命令行指令 --modules，任何在logstash.yml文件中定义的模块将被忽略。

logstash.yml文件包括以下设置:

用于安全设置的秘密密钥库

当你配置Logstash时，你可能需要指定敏感的设置或配置，如密码。与其依靠文件系统权限来保护这些值，你可以使用Logstash keystore来安全地存储用于配置设置的秘密值。

在向keystore添加密钥及其秘密值后，你可以在配置敏感设置时使用密钥来代替秘密值。

引用密钥的语法与环境变量的语法相同:

${KEY}

其中KEY是钥匙的名称。