Workbench Logstash Application Type

General Section

Workbench Application Name

Default Values: "WB_Logstash_Primary"
Valid Values: Any String name (i.e. "WB_Logstash_Pri")
Changes Take Effect: Immediately
Description: The name of the Workbench Logstash application

Workbench Application Type

Default Values: Workbench Logstash
Valid Values: Valid Workbench Application Type
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: Workbench Application Type

Workbench Version

Default Values: "9.x.xxx.xx"
Valid Values: WB Version
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: The Workbench Application Version

Associated Workbench Agent Application

Default Values: "WB_Agent_Primary"
Valid Values: Name of associated Workbench Agent application
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: The name of the Workbench Agent associated with this application/host

Data-Center

Default Values: <DC value enter at installation
Valid Values: Read-Only
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: The name of the Data-Centre associated with this application; a prepatory setting that will evolve in WB 9.x

Host Name

Default Values: Hostname of the Workbench Logstash application associated host (i.e. "LAB-WB-VM1")
Valid Values: Valid Hostname
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: The Hostname of the host where this Workbench Logstash application is running

Host IP Address

Default Values: IP Address of the Workbench Logstash application associated host (i.e. "10.20.30.40")
Valid Values: Valid IP address
Changes Take Effect: After Workbench Logstash application (i.e. "WB__Primary") startup
Description: The IPv4 Address of the host where this Workbench Logstash application is running

Host Time-Zone

Default Values: Time-Zone of the Workbench Logstash application associated host (i.e. "Europe/London")
Valid Values: Valid Host Time-Zone
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: The Time-Zone of the host where this Workbench Logstash application is running

Deployment Section

Installation Directory

Default Values: "<WORKBENCH_HOME>\Logstash"
Valid Values: Valid Path (i.e. C:\Program Files\Workbench_9.x.xxx.xx\Logstash")
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: Absolute path of the folder where this application is installed

Configuration Directory

Default Values: "<WORKBENCH_HOME>\Logstash\config"
Valid Values: Valid Path (i.e. C:\Program Files\Workbench_9.x.xxx.xx\Logstash\config")
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: Absolute path of the folder where the configuration file of this application is located

Logging Section

Log Level

Default Values: info
Valid Values: info, debug, error, warning, fatal, trace
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") restart
Description: Application/Component Logging Level (e.g. info or debug)

Log File Location

Default Values:<WORKBENCH_HOME>\\Logstash\\logs
Valid Values: Valid Path (i.e. "C:\\Program Files\\Workbench_9.x.xxx.xx\\Logstash\\logs")
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") restart
Description: Absolute path of the folder where the Workbench Logstash application log file is located

Important

• Note for Windows the required double '\\' separator used in the Logstash log file location

Segment (MB)

Default Values: 50 (MB)
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") restart
Description: Maximum size of the log file before it is rotated/cycled

Expire

Default Values: 10
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") restart
Description: Maximum number of log files before being rotated/cycled

Workbench Logstash Locations

Data Directory

Default Values: <WORKBENCH_HOME>\\Logstash\\data
Valid Values: Valid Path (i.e. "C:\\Program Files\\Workbench_9.x.xxx.xx\\Logstash\\data")
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: Absolute path of the folder where the Logstash data is stored

Workbench Logstash Identifiers

Node Name

Default Values:"node-<THE_WORKBENCH_HOSTNAME>_Logstash"
Valid Values: A valid "node-"<HOSTNAME>_<Logstash> combination
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Elasticsearch_Primary") startup
Description: This a human readable identifier for a particular instance of Logstash so it is included in the response of many APIs. It defaults to the hostname that the machine has when Logstash starts but can be configured explicitly.

HTTP Port

Default Values: "9600" (or the port number provided at custom installation
Valid Values: Valid free port integer
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") restart
Description: Logstash Port to bind to for incoming HTTP requests.

Network Host

Default Values: Hostname of the Workbench Logstash application associated host (i.e. "LAB-WB-VM1")
Valid Values: Valid Hostname
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: The Hostname of the host where this Workbench Logstash application is running.

Workbench Logstash Queue Settings

Queue Page Capacity

Default Values: "64" (MB)
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") restart
Description: The maximum size of a queue page in bytes. The queue data consists of append-only files called "pages". The default size is 64mb. Changing this value is unlikely to have performance benefits.

Queue Max Events

Default Values: "0" (Zero)
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") restart
Description: The maximum number of events that are allowed in the queue. The default is 0 (unlimited).

Queue Max Bytes

Default Values: "1024" (MB)
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") restart
Description: The total capacity of the queue in number of bytes. The default is 1024mb (1gb). Make sure the capacity of your disk drive is greater than the value you specify here.

Metrics Pipeline

Event Input Port

Default Values: "5048"
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") restart
Description: The Metrics Input Port.

Event IO Output Host

Default Values: Hostname of the Workbench Logstash application associated host (i.e. "LAB-WB-VM1")
Valid Values: Valid Hostname
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: The Metrics Pipeline Output Host.

Event Elastic Output Host

Default Values: http://<HOSTNAME>:9200
Valid Values: Valid Hostname
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: The Elasticsearch Host:Port.

Status Pipeline

Event Input Port

Default Values: "5047"
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") restart
Description: The Status Pipeline Port.

Event IO Output Host

Default Values:

• For WB 9.0 to 9.2 - http://<HOSTNAME>:8182
  
• For WB 9.3 - http://<HOSTNAME>:8181
  

Valid Values: Valid Hostname
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") startup
Description: The Status Pipeline Output Host.

Insights Pipeline

Port

Default Values: "9090"
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Logstash application (i.e. "WB_Logstash_Primary") restart
Description: The Anomaly Detection "Insights" Pipeline Port.