As of Friday October 16th, access to restricted content on this site now requires you to log in with your Genesys account. If you don't have an account, you can request one at these locations: Request MyPartner Portal Account or Request My Support Account.
Jump to: navigation, search

Workbench Kibana Application Type

General Section

Editable Option

Workbench Application Name

Default Values: "Workbench_Kibana_Primary"
Valid Values: Any String name (i.e. "WB_Kibana_Pri")
Changes Take Effect: Immediately
Description: The name of the Workbench Kibana application

Read Only Options

Workbench Application Type

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

Workbench Version

Default Values: "9.0.000.01"
Valid Values: WB Version
Changes Take Effect: After Workbench Kibana application (i.e. "WB_Kibana_Primary") startup
Description: The Workbench Application Version

Associated Workbench Agent Application

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

Data-Center

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

Host IP Address

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

Host Time-Zone

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

Deployment Section

Read Only Options

Installation Directory

Default Values: "<WORKBENCH_HOME>\Kibana"
Valid Values: Valid Path (i.e. C:\Program Files\Workbench_9_0\Kibana")
Changes Take Effect: After Workbench Kibana application (i.e. "WB_Kibana_Primary") startup
Description: Absolute path of the folder where this application is installed

Configuration Directory

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

Logging Section

Editable Options

Log File Location

Default Values: "<WORKBENCH_HOME>\Kibana\logs\kibana.log"
Valid Values: Valid folder path
Changes Take Effect: After Workbench Kibana application (i.e. "WB_Kibana_Primary") restart
Description: Absolute path of the log file location

Log Verbose

Default Values: False
Valid Values: True, False
Changes Take Effect: After Workbench Kibana application (i.e. "WB_Kibana_Primary") restart
Description: Set the value of this setting to true to log all events, including system usage information and all requests.

Log Silent

Default Values: False
Valid Values: True, False
Changes Take Effect: After Workbench Kibana application (i.e. "WB_Kibana_Primary") restart
Description: Set the value of this setting to true to suppress all logging output.

Log Quiet

Default Values: False
Valid Values: True, False
Changes Take Effect: After Workbench Kibana application (i.e. "WB_Kibana_Primary") restart
Description: Set the value of this setting to true to suppress all logging output other than error messages.

Important
  • Only enabled 1 of the "Verbose Log", "Quit Log" or "Silent Log" options above; else the Workbench Kibana component could fail to start.
Warning
  • Kibana does not provide Kibana log file rotation.
  • Therefore please monitor/manage this Kibana log file accordingly to ensure it does not grow indefinitely and negatively impact the host and/or its applications

Workbench Kibana Identifiers

Editable Options

HTTP Port

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

Workbench Elasticsearch Host

Default Values: "http://<HOSTNAME>:9200 (i.e. "http://MY-WB-VM:9200")
Valid Values: Valid Elasticsearch Hostname and Port)
Changes Take Effect: After Workbench Kibana application (i.e. "WB_Kibana_Primary") restart
Description: IPv4 address of the host where Elasticsearch (to which Kibana is going to connect) is running

Read Only Options

Host Name

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

This page was last edited on July 8, 2020, at 08:19.

Feedback

Comment on this article:

blog comments powered by Disqus