server task stats

Edit online

Manages the gathering and reporting of statistics for Security Verify Access servers and server instances.

Requires authentication (administrator ID and password) to use this command.

Syntax

server task server_name–host_name stats get [component]

server task server_name–host_name stats list

server task server_name–host_name stats off [component]

server task server_name–host_name stats on component [interval [count]] [destination]

server task server_name–host_name stats reset [component]

server task server_name–host_name stats show [component]

Description

The server task stats command manages the gathering and reporting of statistics for Security Verify Access servers and server instances. You can use the stats commands with configuration setting that are defined by the stanza entries in the server configuration file to manage statistics.

Statistics gathering is enabled through:

The stats on command.
The defined configuration settings.

Then, you can use the stats on commands to modify the behavior for gathering and reporting statistics.

For example, statistics are enabled to create five statistics reports with each report generated each day. You can use the stats on command to change the frequency to every 12 hours. For this example, assume that the following command started statistics gathering:

pdadmin sec_master> server task PDWebPI-linuxweb.wasp.ibm.com stats on \
pdwebpi.stats 86400 5 file path=/tmp/stats.log

To modify the interval to 12 hours and create 10 reports, issue the following command:

pdadmin sec_master> server task PDWebPI-linuxweb.wasp.ibm.com stats on \
pdwebpi.stats 43200 10

Although the destination is not specified, the statistics infrastructure assumes any preexisting value. Entering the previous command does disable statistics from being written to the previously defined log file. However, if you specified a different destination, statistics reports would be written to the new destination only. You cannot use the stats on command to write statistics reports to more than one destination.

For more information about gathering statistics, see the Auditing topics in the IBM Knowledge Center.

Options

component

Specifies the component about which to gather or report statistics.

count

Specifies the number of reports to send to a log file. When you use the count option, you must specify the interval option. If you specify the interval option without the count option, the duration of reporting is indefinite.

After the count value is reached, reporting to a log file stops. Although statistics are no longer sent to a log file, the statistic component is still enabled. You can obtain reports from memory by using the stats get command.

destination

Specifies where the gathered statistics are written, where destination can be one of the following options:

file path=file_name: Specifies the fully qualified name of the log file.
log_agent: Specifies a directory where statistics information is gathered. For more information about logging events, see the Troubleshooting topics in the IBM Knowledge Center.

get

Displays the current report for a specific component or for all enabled components. If you specify the component option, displays the current report for that component; otherwise, displays the current report for all enabled components.

interval

Specifies the interval in seconds when statistics are sent from memory to a log file. When this option is specified, statistics are sent, by default, to the server-specific log file designated by the logcfg entry in the server configuration file. You can specify another location by using the destination option. If an interval is not specified, statistics are not sent to a log file, but remain in memory.

Although statistics are not sent to a log file, the statistic component is still enabled. You can obtain reports from memory by using the stats get command.

list

Lists all components that are available to gather and report statistics.

off

Disables gathering of statistics for a specific component or for all components. If you specify the component option, disables gathering of statistics for that component; otherwise, disables gathering of statistics for all components.

on

Enables gathering of statistics for a specific component. When you enable gathering of statistics, you can also set the reporting frequency, count, and log file.

reset

Resets gathering of statistics for a specific component or for all enabled components. If you specify the component option, resets gathering of statistics for that component; otherwise, resets gathering of statistics for all components.

server_name–host_name

Specifies the name of the server or server instance. You must specify the server name in the exact format as it is shown in the output of the server list command.

For example, if the configured name of a single WebSEAL server on host example.dallas.ibm.com is default, the server_name would be default-webseald and the host_name would be example.dallas.ibm.com. For this example, the name of the server would be default-webseald-example.dallas.ibm.com.

If multiple server instances are configured on the same computer, for example:

The host is example.dallas.ibm.com.
The configured name of the WebSEAL server instance is webseal2-webseald.

Then,

The server_name is webseal2-webseald.
The host_name is example.dallas.ibm.com.
The name of the server instance is webseal2-webseald-example.dallas.ibm.com.

show

Lists all enabled components or indicates whether a specific component is enabled. If you specify the component option and the component is enabled, the output lists that component; otherwise, no output is displayed. If you do not specify the component option, the output lists all enabled components.

Return codes

0: The command completed successfully.
1: The command failed. See "Error messages" in the IBM Knowledge Center. This reference provides a list of the Security Verify Access error messages by decimal or hexadecimal codes.

Examples

The following example uses the stats list command to lists all enabled components on the ivacld-mogman.admogman.com authorization server:
```
#pdadmin sec_master> server task ivacld-mogman.admogman.com stats list

pd.ras.stats.monitor
pd.log.EventPool.queue
```
The following example:
- Uses the stats on command to enable gathering of statistics for the pd.log.EventPool.queue component on the ivacld-mogman.admogman.com authorization server.
- Sets the reporting frequency to 30 days, that is, 2592000 seconds.
- Sets the destination to the c:\myEPstats.log log file.
```
#pdadmin sec_master> server task ivacld-mogman.admogman.com stats on \
pd.log.EventPool.queue 2592000 file path=c:\myEPstats.log
```