Null output plugin v3.0.3

  • Plugin version: v3.0.3
  • Released on: 2017-06-23
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting Help

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

A null output. This is useful for testing logstash inputs and filters for performance.

Null Output Configuration Options

There are no special configuration options for this plugin, but it does support the Common Options.

Common Options

The following configuration options are supported by all output plugins:

Setting Input typeRequired

codec

codec

No

enable_metric

boolean

No

id

string

No

codec

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

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output without needing a separate filter in your Logstash pipeline.

enable_metric

  • 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.

id

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

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 null outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  null {
    id => "my_plugin_id"
  }
}