Logstash Collector

Logstash collector gathers data from various sources and forwards the data to a Logstash server using Lumberjack protocol.

Enabling this feature

To enable the Logstash Collector 1.0 feature, add the following element declaration into your server.xml file, inside the featureManager element:



Configure Logstash collector

To configure the Logstash collector feature, you must specify the hostname and port number of a Logstash server and the ID of your SSL configuration. The following example shows how to configure the Logstash Collector feature to collect data from the default source, which is the message source:


Set message and event parameters

With the Logstash Collector feature, you can change the maximum number of characters that are allowed for the message field in a message, trace, or FFDC event. You can also limit the number of events that are sent per second for each event type that is specified with the source attribute in the following example:


The maxFieldLength parameter is set to 3000 characters and the maxEvents parameter is set to 10 events per second for each event type. For more information, see Forwarding logs and events to Logstash with Logstash collector.

Add custom event tags

The following example sets two tag elements to add custom tags that are associated with the events from various sources. The tags annotate the events to show that they come from serverRackA5 and billingAppTeam systems:


Replace default HTTP access log fields

The following example shows a configuration to replace the default HTTP access log fields with a different set of fields:

<httpEndpoint httpPort="9080" httpsPort="9443" id="defaultHttpEndpoint">
    <accessLogging logFormat='%R{W} %u %{my_cookie}C %s'/>

The logFormat attribute in the embedded accessLogging element specifies the log format options for the different set of fields, which are listed in HTTP access logging. The jsonAccessLogFields attribute is set to logformat to enable the logstash collector to use the set of access log fields that match the log format options.

Feature configuration elements

Features that this feature enables

Supported Java versions

  • JavaSE-1.8

  • JavaSE-11.0

  • JavaSE-17.0

  • JavaSE-21.0

  • JavaSE-22.0

Developing a feature that depends on this feature

If you are developing a feature that depends on this feature, include the following item in the Subsystem-Content header in your feature manifest file.

com.ibm.websphere.appserver.logstashCollector-1.0; type="osgi.subsystem.feature"