wmi

edit
  • Version: 3.0.0
  • Released on: 2016-09-10
  • Changelog
  • Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-input-wmi.

Collect data from WMI query

This is useful for collecting performance metrics and other data which is accessible via WMI on a Windows host

Example:

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

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

wmi {
    query => ...
}

Available configuration options:

Setting Input type Required Default value

add_field

hash

No

{}

codec

codec

No

"plain"

enable_metric

boolean

No

true

host

string

No

"localhost"

id

string

No

interval

number

No

10

namespace

string

No

"root\\cimv2"

password

password

No

query

string

Yes

tags

array

No

type

string

No

user

string

No

Details

edit

 

add_field

edit
  • Value type is hash
  • Default value is {}

Add a field to an event

codec

edit
  • Value type is codec
  • Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

enable_metric

edit
  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

host

edit
  • Value type is string
  • Default value is "localhost"

Host to connect to ( Defaults to localhost )

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

interval

edit
  • Value type is number
  • Default value is 10

Polling interval

namespace

edit
  • Value type is string
  • Default value is "root\cimv2"

Namespace when doing remote connections

password

edit
  • Value type is password
  • There is no default value for this setting.

Password when doing remote connections

query

edit
  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

WMI query

tags

edit
  • Value type is array
  • There is no default value for this setting.

Add any number of arbitrary tags to your event.

This can help with processing later.

type

edit
  • Value type is string
  • There is no default value for this setting.

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

user

edit
  • Value type is string
  • There is no default value for this setting.

Username when doing remote connections