debug-level
Section: statserver
Default Value: Init
Valid Values: all, Action, Client, Init, HA, Java, Mngmnt, Reset, Server, SPT, SQL, Status
Changes Take Effect: Immediately upon notification
A comma-separated list of debug categories that are visible in the Stat Server log:
- all Synonymous with Init,Server,Client,Status,Action,SQL,Mngmnt,Java,Reset. The debug level that you designate for this category supersedes any debug level that you designate for other categories.
- Action Logs changes to the internal Stat Server object model and provides a significant source of troubleshooting data, which includes entries following every TEvent.
- Client Logs all Stat Server communication with its clients, such as the opening of statistics and all statistical values sent to the client. This value generates a large amount of data, and should be sparingly used for troubleshooting reproducible problems with statistics.
- Init Used for capturing data related to Configuration Server that affects Stat Server, including dynamic Configuration Server changes made as Stat Server starts--such as the addition, deletion, and/or change of objects or their properties having an affect on Stat Server. This value is useful for tracking initial configuration and dynamic changes and is much more compact than the information provided in the Configuration Server log. Genesys recommends that you always include this value in this option.
- HA Logs messages related to HA functionality.
- Java Displays information related to Java extension functionality. Use this value only for statistics in the Outbound Contact 7.2.0+ or MCR 7.0.1+ (MCR has been renamed to eServices in release 8.0).
- Mngmnt Displays profiling information, including the number of currently connected clients, statistics being computed at the moment, and statistics to be reported to clients.
- Reset Enables the log messages Stat Server sends to clients while sending statistics requested with a reset-based notification mode.
- Server Logs T-Server events pertaining to Stat Server. Genesys recommends that you not include this value if you maintain logs for the related T-Server(s).
- SPT Logs events related to Stat Server startup. This value is provided to maintain backward compatibility and may be eliminated in future releases.
- SQL Displays the SQL statements issued if you have configured a database for Stat Server.
- Status Logs events related to the current state of objects and is useful for troubleshooting Stat Server-Router problems.
This option is enabled only if you have set the verbose common log option to all.
In graphical environments, log output often takes more than half of a server's execution time. To maintain performance, use only the debug levels that you need and run Stat Server in the background. Also, minimize the Stat Server window or redirect log output to a different device, such as a file. Be very careful, however, when directing log output to a file and consider the available free disk space, directory and file permissions, and possible conflicts with different software trying to use the log file at the same time.
For each debug category, you can also set the level of debug logging by specifying a numerical value from [0–9] (with 9 being the most verbose) and appending the number to each category.
For example: Init, Status:6
Debug level 0 is synonymous to no logging at all for the specified debug category.
Debug levels 1–4 provide less logging information than was provided in prior releases but more than debug level 0.
Debug level 5 provides exactly the same logging information that was provided in prior releases. This level is the default level if none is otherwise specified.
Debug levels 6–7 provide more detailed output than level 5.
Debug levels 8–9 provide the most extensive log output requiring further internal processing which, in turn, further degrades Stat Server performance.
The SIP Server 8.1.1 product provides a troubleshooting tool that parses the log output of several Genesys servers including Stat Server. Refer to the SipSpan2 User's Guide, available on the SIP Server CD, for information on how to use this tool.
This option was previously named DebugLevel.
ixn-id-in-status-table
Section: statserver
Default Value: off
Valid Values: on, off
Changes Take Effect: Immediately upon notification
Related Options: multimedia-activity-in-status-table; enable-binding
Specifies whether Stat Server will populate the IxnID field for records written to the STATUS table. If you set this option to off or if you do not set configure this option, the IxnID field will be null. This field provides functionality, comparable to connection IDs for calls, for Multimedia interactions that rely predominantly on the number generated by Interaction Server for identification in the interaction flow.
Note: If you set this option to on, consider also setting the multimedia-activity-in-status-table configuration option to yes so that Stat Server will record information about the status of multimedia interactions in the other fields of the STATUS table.
Warning! To avoid data loss, do not change the setting of this option in runtime if you have also set enable-binding to yes.
local-time-in-status-table
Section: statserver
Default Value: off
Valid Values: on, off
Changes Take Effect: Immediately upon notification
Related Options: time-format; enable-binding
Specifies whether to populate the StartLocalTime and EndLocalTime fields in the STATUS table. If you set the value of this option to off, or if you do not specify a value, the StartLocalTime and EndLocalTime fields will contain no data. For Solution Reporting applications, set this option to off; such reports do not use the local time fields, and setting this option to on could affect performance. When setting this option to on, also set the time-format option to the desired format. Refer to the Table and Column Description in the Stat Server Deployment Guide for a complete description of the STATUS table.
This option was previously named LocalTimeInStatusTable.
Warning! To avoid data loss, do not change the value of this option in runtime if you have also set enable-binding to yes.
voice-reasons-table
Section: statserver
Default Value: no
Valid Values: yes, no
Changes Take Effect: Immediately upon notification
Specifies whether Stat Server stores the reasons for agents to change or continue Ready and NotReady states and AfterCallWork work mode. If this option is set to yes, Stat Server writes the reasons records directly to the VOICE_REASONS table in the Stat Server database. Refer to the The VOICE_REASONS Table in the Stat Server Deployment Guide for more information.
status-table
Section: statserver
Default Value: off
Valid Values: on, off
Changes Take Effect: Immediately
Specifies whether Stat Server writes records about agent statuses directly to the STATUS table in the Stat Server database. Refer to the The STATUS Table in the Stat Server Deployment Guide for more information.
This option was previously named StatusTable.
qinfo-table
Section: statserver
Default Value: off
Valid Values: on, off
Changes Take Effect: Immediately upon notification
Specifies whether Stat Server writes records about queue statuses directly to the QINFO table in the Stat Server database. Refer to the The QINFO Table in the Stat Server Deployment Guide for more information.
This option was previously named QInfoTable.
management-port
Section: statserver
Default Value: 3031
Valid Values: Any available TCP port (Integers 1 through 65535)
Changes Take Effect: After restart
Specifies the TCP/IP port that Stat Server reserves for connections that its SNMP Option Management Client establishes.
Warning! You must specify a value for this option if you are using an SNMP connection. Do not change the value for this option while Stat Server is running.
Optimizing Performance
Review the recommendations provided in this topic to optimize Stat Server performance.
Hardware-Related Recommendations
- Consider the following formula, which approximates Stat Server memory, in megabytes, for a typical large contact center:
MemoryReqd = 100 + (NStatistics × 0.0012)
where NStatistics represents the number of opened statistics and 0.0012 refers to approximately 1.2 KB of memory per statistic. This formula applies to Stat Server memory calculation of core statistics. Java Extension clients might request additional memory of which Stat Server is unaware.
For example, Stat Server on a computer with 1.5 GB of memory should be more than ample to handle CC Analyzer requests of 30,000 active Agent or Place objects that originate from the Genesys-provided Agent and Place reports):
NStatistics = 28 statistics/report layout × 30,000 objects = 840,000 statistics
MemoryReqd = 100 + (840,000 × 0.0012) = 1,108 MB
For smaller contact centers, you can reduce the constant (100) to a smaller value.
Install Stat Server on a computer with sufficient physical memory to avoid swapping. - Consider distributing the total number of required statistics for Solution Reporting and real-time interaction processing for all solutions over a number of Stat Server applications.
- Install Stat Server and source event server on the same computer or connect them through a fast LAN. If you are using several T-Server applications, position Stat Server nearest to the one.
- Do not install Stat Server on the same computer as Configuration Server.
- Do not install real-time, third-party applications on the computer that is running Stat Server.
- If you want to store Stat Server data, consider dedicating a separate Stat Server application whose sole purpose is to write data to the Stat Server database.
- For large contact centers, consider allocating approximately 5 MB of space for each day Stat Server writes data to a database. This recommendation applies only if you configure Stat Server with a database access point and enable your Stat Server application to write data to a database by setting corresponding configuration options.
Software-Related Recommendations
- For Stat Server applications that write to the Stat Server database, configure options only for the tables that you need by setting the following configuration options:
- Review the configuration options that are related to write operations to this database:
- For Oracle, Microsoft SQL, and DB2 relational database management systems (RDBMSs), set the enable-binding option to Yes.
- Set the local-time-in-status-table configuration option to No if you do not need a translation of UTC time to the time one of the host on which Stat Server is deployed.
- Set the ixn-id-in-status-table option to No for Solution Reporting and other clients that employ only an interaction’s connection ID.
- You can improve Stat Server performance further by tuning the debug-level configuration option. Specify only the debugging log level that you need.
Antivirus
Antivirus software can affect system performance and call response time, but it prevents viruses from hiding in software. Genesys recommends to keep antivirus software enabled on hosts where Stat Server is running.
Performance of all applications on a particular host should be analyzed. There might be more vulnerable than Stat Server applications. Some of those vulnerable applications can be considered to be moved to a different host. Genesys does not recommend excluding Stat Server from the antivirus scanning, but in case of a significant overhead, you can consider to disable the following:
- The folder in which Stat Server is running.
- Any logs folders.
- The statserv.exe process on Windows.
- The statserv_32, statserv_64, statserv_32_unstripped, or statserv_64_unstripped process on Linux.
The antivirus software must not restrict any ports that are used by the Genesys applications.