Workbench Agent Application Type

General Section

Workbench Application Name

Default Values: "WBA_<HOSTNAME>"
Valid Values: Any String (i.e. "WBA_MY-VM")
Changes Take Effect: Immediately
Description: The name of the Workbench Agent application

Workbench Agent Port

Default Values: 9091 (or the port number given at custom installation time)
Valid Values: A valid and free Port number (i.e. not used by other applications on the host)
Changes Take Effect: After Workbench Agent application (i.e. "WB_Agent_Primary") restart
Description: The Port at which clients connect

Workbench Application Type

Default Values: "Workbench Agent"
Valid Values: Valid Workbench Application Type
Changes Take Effect: N/A
Description: Workbench Application Type

Workbench Version

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

Data-Center

Default Values: default
Valid Values: Read-Only
Changes Take Effect: Aftern Workbench Agent application (i.e. "WB_Agent_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 Agent application associated host (i.e. "LAB-WB-VM1")
Valid Values: Valid Hostname
Changes Take Effect: After Workbench Agent application (i.e. "WB_Agent_Primary") startup
Description: The Hostname of the host where this Workbench Agent application is running

Host IP Address

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

Host Time-Zone

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

Deployment Section

Installation Directory

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

Configuration Directory

Default Values: "<WORKBENCH_HOME>\WorkbenchAgent"
Valid Values: Valid Path (i.e. C:\Program Files\Workbench_9.x.xxx.xx\WorkbenchAgent")
Changes Take Effect: After Workbench Agent application (i.e. "WB_Agent_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: ALL, INFO, DEBUG, ERROR, WARNING, FATAL, TRACE, OFF
Changes Take Effect: After Workbench Agent application (i.e. "WB_Agent_Primary") restart
Description: Application/Component Logging Level (e.g. INFO or DEBUG)

Log File Location

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

Segment (MB)

Default Values: 50
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Agent application (i.e. "WB_Agent_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 Agent application (i.e. "WB_Agent_Primary") restart
Description: Maximum count of log files before rotated/cycled

MetricBeat General Section

Log File Location

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

Segment (MB)

Default Values: 50
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Agent application (i.e. "WB_Agent_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 Agent application (i.e. "WB_Agent_Primary") restart
Description: Maximum count of log files before rotated/cycled

MetricBeat Output

Default Values: <Hostname>:<Port> of the destination Workbench Logstash application
Valid Values: Valid <Hostname>:<Port> combination
Changes Take Effect: After Workbench Agent application (i.e. "WBA_cc-app-demo-1") startup
Description: The Hostname of the host where this Workbench Agent application is running

MetricBeat Http Port

Default Values:

• For Workbench 9.0 to 9.2 - 5067 (or the port number given at custom installation time)
  
• For Workbench 9.3+ - 6067 (or the port number given at custom installation time)
  

Valid Values: A valid and free Port number (i.e. not used by other applications on the host)
Changes Take Effect: After Workbench Agent application (i.e. "WB_Agent_Primary") restart
Description: The MetricBeat Port

MetricBeat Host Metrics Section

Disk

Default Values: true/checked
Valid Values: true/false
Changes Take Effect: After Workbench Agent (i.e. "WBA_cc-app-demo-1") restart
Description: Collect and transmit [Disk] metrics from this Host

Network

Default Values: true/checked
Valid Values: true/false
Changes Take Effect: After Workbench Agent (i.e. "WBA_cc-app-demo-1") restart
Description: Collect and transmit [Network] metrics from this Host

Uptime

Default Values: true/checked
Valid Values: true/false
Changes Take Effect: After Workbench Agent (i.e. "WBA_cc-app-demo-1") restart
Description: Collect and transmit [Uptime] metrics from this Host

Host Metric Collection Frequency (seconds)

Default Values: 60 (seconds)
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Agent (i.e. "WBA_cc-app-demo-1") restart
Description: The collect/transmit frequency for [Host] metrics from this Host

CPU

Default Values: true/checked
Valid Values: true/false
Changes Take Effect: After Workbench Agent application (i.e. "WB_Agent_Primary") startup
Description: Transmit CPU stats to Workbench

Memory

Default Values: true/checked
Valid Values: true/false
Changes Take Effect: After Workbench Agent application (i.e. "WB_Agent_Primary") startup
Description: Transmit Memory (RAM) stats to Workbench

MetricBeat Associated Application Metrics Section

Top / Specific

Default Values: Top 10
Valid Values: Top or Specific
Changes Take Effect: After Workbench Agent (i.e. "WBA_cc-app-demo-1") restart
Description:

• If Top - collect and transmit the Top X (i.e. 10) [Application] metrics from this Host
  
• If Specific - collect and transmit certain (i.e. "sip" - based on a Regex match) [Application] metrics from this Host
  

Process Summary

Default Values: Enabled/True
Valid Values: Enabled/Disabled (True/False)
Changes Take Effect: After Workbench Agent (i.e. "WBA_cc-app-demo-1") restart
Description: Collects high level statistics about the running processes.

Application/Process Metric Collection Frequency (seconds)

Default Values: 60 (seconds)
Valid Values: Valid positive integer
Changes Take Effect: After Workbench Agent (i.e. "WBA_cc-app-demo-1") restart
Description: The collect/transmit frequency for [Application/Process] metrics from this Host