log4jedit

  • Version: 3.0.3
  • Released on: 2016-08-11
  • Changelog
  • Compatible: 5.1.2, 5.1.1, 5.0.0, 2.4.1, 2.4.0

Read events over a TCP socket from a Log4j SocketAppender. This plugin works only with log4j version 1.x.

Can either accept connections from clients or connect to a server, depending on mode. Depending on which mode is configured, you need a matching SocketAppender or a SocketHubAppender on the remote side.

One event is created per received log4j LoggingEvent with the following schema:

  • timestamp ⇒ the number of milliseconds elapsed from 1/1/1970 until logging event was created.
  • path ⇒ the name of the logger
  • priority ⇒ the level of this event
  • logger_name ⇒ the name of the logger
  • thread ⇒ the thread name making the logging request
  • class ⇒ the fully qualified class name of the caller making the logging request.
  • file ⇒ the source file name and line number of the caller making the logging request in a colon-separated format "fileName:lineNumber".
  • method ⇒ the method name of the caller making the logging request.
  • NDC ⇒ the NDC string
  • stack_trace ⇒ the multi-line stack-trace

Also if the original log4j LoggingEvent contains MDC hash entries, they will be merged in the event as fields.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

log4j {
}

Available configuration options:

Setting Input typeRequiredDefault value

add_field

hash

No

{}

codec

codec

No

"plain"

enable_metric

boolean

No

true

host

string

No

"0.0.0.0"

id

string

No

mode

string, one of ["server", "client"]

No

"server"

port

number

No

4560

tags

array

No

type

string

No

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

codecedit

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

  • Value type is boolean
  • Default value is true

Disable or enable metric collection and reporting for this specific plugin instance. By default we record metrics from all plugins, but you can disable metrics collection for a specific plugin.

hostedit

  • Value type is string
  • Default value is "0.0.0.0"

When mode is server, the address to listen on. When mode is client, the address to connect to.

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

Add a unique named ID to the plugin instance. This ID is used for tracking information for a specific configuration of the plugin and will be useful for debugging purposes.

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

If you don’t explicitly set this field, Logstash will generate a unique name.

modeedit

  • Value can be any of: server, client
  • Default value is "server"

Mode to operate in. server listens for client connections, client connects to a server.

portedit

  • Value type is number
  • Default value is 4560

When mode is server, the port to listen on. When mode is client, the port to connect to.

tagsedit

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

typeedit

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