WMI 输入插件

编辑
  • 插件版本: v3.0.4
  • 发布日期: 2018-04-06
  • 更新日志

其他版本,请参阅版本化的插件文档

安装

编辑

对于默认未捆绑的插件,可以通过运行bin/logstash-plugin install logstash-input-wmi轻松安装。有关更多详细信息,请参阅使用插件

获取帮助

编辑

有关插件的问题,请在Discuss论坛中打开一个主题。对于错误或功能请求,请在Github中打开一个问题。有关 Elastic 支持的插件列表,请查阅Elastic 支持矩阵

描述

编辑

从 WMI 查询收集数据

这对于收集性能指标以及其他可通过 Windows 主机上的 WMI 访问的数据非常有用

示例

    input {
      wmi {
        query => "select * from Win32_Process"
        interval => 10
      }
      wmi {
        query => "select PercentProcessorTime from Win32_PerfFormattedData_PerfOS_Processor where name = '_Total'"
      }
      wmi { # Connect to a remote host
        query => "select * from Win32_Process"
        host => "MyRemoteHost"
        user => "mydomain\myuser"
        password => "Password"
      }
    }

WMI 输入配置选项

编辑

此插件支持以下配置选项以及稍后描述的通用选项

设置 输入类型 是否必需

host

字符串

interval

数字

namespace

字符串

password

password

query

字符串

user

字符串

另请参阅通用选项,以获取所有输入插件支持的选项列表。

 

host

编辑
  • 值类型为字符串
  • 默认值为"localhost"

要连接的主机(默认为 localhost)

interval

编辑
  • 值类型为数字
  • 默认值为10

轮询间隔

namespace

编辑
  • 值类型为字符串
  • 默认值为"root\cimv2"

进行远程连接时的命名空间

password

编辑
  • 值类型为密码
  • 此设置没有默认值。

进行远程连接时的密码

query

编辑
  • 这是一个必需的设置。
  • 值类型为字符串
  • 此设置没有默认值。

WMI 查询

user

编辑
  • 值类型为字符串
  • 此设置没有默认值。

进行远程连接时的用户名

通用选项

编辑

所有输入插件都支持这些配置选项

设置 输入类型 是否必需

add_field

哈希

codec

codec

enable_metric

布尔

id

字符串

tags

数组

type

字符串

add_field

编辑
  • 值类型为哈希
  • 默认值为{}

向事件添加字段

codec

编辑

用于输入数据的编解码器。输入编解码器是在数据进入输入之前解码数据的便捷方法,而无需在 Logstash 管道中使用单独的过滤器。

enable_metric

编辑
  • 值类型为布尔
  • 默认值为true

默认情况下,禁用或启用此特定插件实例的指标日志记录,我们记录所有可以记录的指标,但是您可以禁用特定插件的指标收集。

  • 值类型为字符串
  • 此设置没有默认值。

向插件配置添加唯一的ID。如果未指定 ID,则 Logstash 将生成一个。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时,这尤其有用,例如,如果您有 2 个 wmi 输入。在这种情况下添加命名 ID 将在使用监控 API 时帮助监控 Logstash。

input {
  wmi {
    id => "my_plugin_id"
  }
}

id字段中的变量替换仅支持环境变量,不支持使用来自秘密存储的值。

tags

编辑
  • 值类型为数组
  • 此设置没有默认值。

向您的事件添加任意数量的标签。

这有助于以后的处理。

type

编辑
  • 值类型为字符串
  • 此设置没有默认值。

向此输入处理的所有事件添加一个type字段。

类型主要用于过滤器激活。

该类型作为事件本身的一部分存储,因此您也可以使用该类型在 Kibana 中搜索它。

如果您尝试在已经具有类型的事件上设置类型(例如,当您从发送器向索引器发送事件时),则新的输入不会覆盖现有类型。在发送器上设置的类型会保留在事件的整个生命周期中,即使发送到另一个 Logstash 服务器也是如此。