System Metrics
For more information, see How Metric Data is Gathered.
Some metrics are reset when the service restarts. You can also reset some metrics manually Resetting metrics.
At the system and server levels, the metrics include all associated dispatchers. At the dispatcher level, metrics include all associated services. For server groups, metrics are for all the dispatchers in the group.
Session Metrics
You can use session metrics to monitor user sessions. This is useful for monitoring system trends such as usage patterns by time of day and day of week. Session metrics are also useful for understanding the context of other metrics. For example, if the number of sessions is extraordinarily high, it could account for the queue length metrics being higher than normal. For more information, see Queue Metrics
The following session metrics are available:
- Number of sessions
Specifies the number of currently active user sessions.
Table 1. Number of sessions Entry
Change Type
Time Scope
Gathering Time
System
Gauge
Point in time
On demand
- Number of sessions high watermark
Specifies the maximum number of active user sessions since the last reset.
Table 2. Number of sessions high watermark Entry
Change Type
Time Scope
Gathering Time
System
Gauge
Since reset
On change
- Number of sessions low watermark
Specifies the minimum number of active user sessions since the last reset.
Table 3. Number of sessions low watermark Entry
Change Type
Time Scope
Gathering Time
System
Gauge
Since reset
On change
Queue Metrics
You can use queue metrics to determine if the system is keeping up with demand. For example, if requests spend too much time in a queue, you may not have enough resources to meet demand.
Queue metrics are available for services that use queues, such as the report service and report data service.
At the system level, queue metrics are available for the following entries:
- Job
Job queue contains metrics related to the internal queue used by all event management services.
- Task
Task queue contains metrics related to the internal queue used by all monitor services. This queue contains tasks until they are successfully completed.
- SMTP
SMTP queue contains metrics related to the internal queue used by all delivery services. This queue contains e-mail messages until they are sent.
Some of the metrics available for these queue metric groups must be enabled to be displayed. For more information, see Enabling job, SMTP, and task queue metrics.
The following queue metrics are available:
- Latency
Specifies the average amount of time that requests have spent in the queue (in seconds).
Table 4. Latency Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Service
Gauge
Since reset
On change
- Number of queue requests
Specifies the number of requests that have passed through the queue.
Table 5. Number of queue requests Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Service
Counter
Since reset
On change
- Queue length
Specifies the number of items currently in the queue.
Table 6. Queue length Entry Change Type Time Scope Gathering Time System
Server/Server group
Service
Gauge
Point in time
On demand
- Queue length high watermark
Specifies the maximum number of items in the queue since the last reset.
Table 7. Queue length high watermark Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Service
Gauge
Since reset
On change
- Queue length low watermark
Specifies the minimum number of items in the queue since the last reset.
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Service
Gauge
Since reset
On change
- Time in queue
Specifies the cumulative amount of time that requests have spent in the queue (in days, hours, minutes, and seconds).
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Service
Counter
Since reset
On change
- Time in queue high watermark
Specifies the maximum length of time that a request waited in the queue (in days, hours, minutes, and seconds).
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Service
Gauge
Since reset
On change
- Time in queue low watermark
Specifies the minimum length of time, in days, hours, minutes, or seconds, that a request waited in the queue.
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Service
Gauge
Since reset
On change
JVM Metrics
You can use JVM metrics to monitor the Java™ Virtual Machine and the associated heap size, which specifies the amount of memory that is currently in use. For example, if a dispatcher has been running for a long time and heap usage is high, you may want to restart the dispatcher. The maximum heap size metric tells you if you have allocated a suitable amount of memory to the JVM based on the amount of hardware memory available. The current heap size, in relation to the maximum heap size, lets you know if available memory is being used. If current heap size is close to the maximum heap size, you may want to adjust tuning settings to reduce the load on a particular JVM. The current heap size may vary widely depending on the current load on the system.
For more information on tuning, see Tune Server Performance.
The following JVM metrics are available:
- Current heap size (bytes)
Specifies the current size of the JVM heap (in bytes).
Entry
Change Type
Time Scope
Gathering Time
Dispatcher
Gauge
Point in time
On demand
- Initially requested heap size (bytes)
Specifies the initial amount of memory that the JVM requests from the operating system during startup (in bytes).
Entry
Change Type
Time Scope
Gathering Time
Dispatcher
Gauge
Point in time
On demand
- Maximum heap size (bytes)
Specifies the maximum amount of memory that can be used by the JVM (in bytes).
Entry
Change Type
Time Scope
Gathering Time
Dispatcher
Gauge
Point in time
On demand
- Up time
The length of time that the JVM has been running (in days, hours, minutes, and seconds.
At the system, server, and server group levels, this is the highest value from all associated dispatchers.
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Counter
Point in time
On demand
- Committed heap size
Specifies the amount of memory that is guaranteed to be available for use by the JVM (in bytes).
Entry
Change Type
Time Scope
Gathering Time
Dispatcher
Gauge
Point in time
On demand
Request Metrics
You can use request metrics to monitor volume of requests, operational status of services, response times, and processing times. General request metrics include data for all services and are a consolidation of metrics for all dispatchers. Request metrics specific to a service include only data for that service.
At the system, server, and server group levels, the metrics include data from all associated dispatchers. At the dispatcher level, metrics include all associated services.
The following request metrics are available:
- Current time
Specifies the current date and time used by the service to interpret time values.
Use only if the service has no clock synchronization mechanism.
Entry
Change Type
Time Scope
Gathering Time
Service
Counter
Point in time
On demand
- Last response time
Specifies processing time for the most recent successful or failed request (in days, hours, minutes, and seconds).
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Gauge
Point in time
On change
- Number of failed requests
Specifies the number of service requests that failed (a fault was returned).
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Counter
Since reset
On change
- Number of processed requests
Specifies the number of processed requests.
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Counter
Since reset
On change
- Number of successful requests
Specifies the number of service requests that succeeded (no fault was returned).
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Counter
Since reset
On change
- Percentage of failed requests
Specifies the percentage of processed requests that failed.
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Gauge
Since reset
On change
- Percentage of successful requests
Specifies the percentage of processed requests that succeeded.
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Gauge
Since reset
On change
- Response time high watermark
Specifies the maximum length of time taken to process a successful or failed request (in days, hours, minutes, and seconds).
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Gauge
Since reset
On change
- Response time low watermark
Specifies the minimum length of time taken to process a successful or failed request (in days, hours, minutes, and seconds).
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Gauge
Since reset
On change
- Seconds per successful request
Specifies the average length of time taken to process a successful request (in seconds).
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Gauge
Since reset
On change
- Service time
Specifies the time taken to process all requests (in days, hours, minutes, and seconds).
Entry
Change Time
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Counter
Since reset
On change
- Service time failed request
Specifies the time taken to process all failed service requests (in days, hours, minutes, and seconds).
Entry
Change Time
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Counter
Since reset
On change
- Service time successful requests
Specifies the time taken to process all successful service requests (in days, hours, minutes, and seconds).
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Counter
Since reset
On change
- Successful requests per minute
Specifies the average number of successful requests processed in one minute.
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Dispatcher
Service
Gauge
Since reset
On change
Process Metrics for Report and Batch Report Service and Metadata Service
The following process metrics are available for report service and batch report service and metadata service:
- Number of processes
Specifies the number of processes currently running.
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Report service and Batch report service
Metadata service
Gauge
Point in time
On demand
- Number of configured processes
Specifies the same value that was configured for the following properties of affected services:
- "Maximum number of processes for the [service_name] during peak period"
- "Maximum number of processes for the [service_name] during non-peak period" to be a non-default value
This value cannot be reset.
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Report service and Batch report service
Metadata service
Gauge
Point in time
On demand
- Number of processes high watermark
For system, server, and server group, the total of all Number of processes high watermark metrics for all associated resources is specified.
For services, the maximum number of processes that ran at any one time since the last reset is specified.
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Report service and Batch report service
Metadata service
Gauge
Since reset
On change
- Number of processes low watermark
For system, server, and server group, the total of all Number of processes low watermark metrics for all associated resources is specified.
For services, the minimum number of processes that ran at any one time since the last reset is specified.
Entry
Change Type
Time Scope
Gathering Time
System
Server/Server group
Report service and Batch report service
Metadata service
Gauge
Since reset
On change