Workbench Heartbeat Application Type

General Section

Workbench Application Name

Default Values: "WB_Heartbeat_Primary"
Valid Values: Any String name (i.e. "WB_Heartbeat_Pri")
Changes Take Effect: Immediately
Description: The name of the Workbench Heartbeat application

Workbench Application Type

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

Workbench Version

Default Values: "9.x.xxx.xx"
Valid Values: WB Version
Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_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 Heartbeat application (i.e. "WB_Heartbeat_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 Heartbeat application (i.e. "WB_Heartbeat_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 Heartbeat application associated host (i.e. "LAB-WB-VM1")
Valid Values: Valid Hostname
Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") startup
Description: The Hostname of the host where this Workbench Heartbeat application is running

Host IP Address

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

Host Time-Zone

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

Deployment Section

Installation Directory

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

Configuration Directory

Default Values: "<WORKBENCH_HOME>\Heartbeat"
Valid Values: Valid Path (i.e. C:\Program Files\Workbench_9.x.xxx.xx\Heartbeat")
Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_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
Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") restart
Description: Application/Component Logging Level (e.g. INFO or DEBUG)

Log File Location

Default Values:<WORKBENCH_HOME>\\Heartbeat\\logs
Valid Values: Valid Path (i.e. "C:\\Program Files\\Workbench_9.x.xxx.xx\\Heartbeat\\logs")
Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") restart
Description: Absolute path of the folder where the Workbench Heartbeat 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
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Heartbeat 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 Heartbeat application (i.e. "WB_Logstash_Primary") restart
Description: Maximum number of log files before being rotated/cycled

Workbench Heartbeat Locations

Data Directory

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

Important

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

Workbench Heartbeat Identifiers

Node Name

Default Values:"node-<THE_WORKBENCH_HOSTNAME>_Heartbeat"
Valid Values: Valid String
Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") startup
Description: This a human readable identifier for a particular instance of Heartbeat so it is included in the response of many APIs.

HTTP Port

Default Values: "<Logstash URL>:<Port>"
Valid Values: Valid host/port combination
Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") restart
Description: The Workbench Heartbeat events will be sent to this Workbench Logstash output destination for processing/storage in Workbench Elasticsearch.

Logstash Output

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

Network Host

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

Monitors

WB IO

Default Values: "10"
Valid Values: Valid positive integer
Max Value: 60 seconds Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") restart
Description: The frequency in seconds of Workbench Heartbeat checking the health of the Workbench IO component/port.

WB Agent

Default Values: "10"
Valid Values: Valid positive integer
Max Value: 60 seconds Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") restart
Description: The frequency in seconds of Workbench Heartbeat checking the health of the Workbench Agent component/port.

WB Elasticsearch

Default Values: "10"
Valid Values: Valid positive integer
Max Value: 60 seconds Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") restart
Description: The frequency in seconds of Workbench Heartbeat checking the health of the Workbench Elasticsearch component/port.

WB Kibana

Default Values: "10"
Valid Values: Valid positive integer
Max Value: 60 seconds Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") restart
Description: The frequency in seconds of Workbench Heartbeat checking the health of the Workbench Kibana component/port.

WB Logstash

Default Values: "10"
Valid Values: Valid positive integer
Max Value: 60 seconds Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") restart
Description: The frequency in seconds of Workbench Heartbeat checking the health of the Workbench Logstash component/port.

WB ZooKeeper

Default Values: "10"
Valid Values: Valid positive integer
Max Value: 60 seconds Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") restart
Description: The frequency in seconds of Workbench Heartbeat checking the health of the Workbench ZooKeeper component/port.

WB Metricbeat

Default Values: "10"
Valid Values: Valid positive integer
Max Value: 60 seconds Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") restart
Description: The frequency in seconds of Workbench Heartbeat checking the health of the Workbench Metricbeat component/port.

WB Heartbeat

Default Values: "10"
Valid Values: Valid positive integer
Max Value: 60 seconds Changes Take Effect: After Workbench Heartbeat application (i.e. "WB_Heartbeat_Primary") restart
Description: The frequency in seconds of Workbench Heartbeat checking the health of the Workbench Heartbeat component/port.