Show Table of Contents
4.2.5. RHQServer - RHQ Server Remote API Subsystem Service
Overview
Table 4.41. Overview
| Description: | Details on remote API communications with external clients, including the CLI |
| Singleton: | yes |
| Plugin: | RHQServer |
Child Resource Types
none
Connection Properties
Table 4.42.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Object Name | yes | objectName | |
| Name Template | yes | nameTemplate | |
| Description Template | yes | descriptionTemplate |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Table 4.43. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Number Failed Invocations | measurement | Total number of remote API requests that were received but failed to be processed successfully | NumberFailedInvocations |
| Number Failed Invocations per Minute | measurement | Total number of remote API requests that were received but failed to be processed successfully | NumberFailedInvocations |
| Number Successful Invocations | measurement | Total number of remote API requests that were received and successfully processed | NumberSuccessfulInvocations |
| Number Successful Invocations per Minute | measurement | Total number of remote API requests that were received and successfully processed | NumberSuccessfulInvocations |
| Number Total Invocations | measurement | Total number of remote API requests that were received regardless of their success or failure | NumberTotalInvocations |
| Number Total Invocations per Minute | measurement | Total number of remote API requests that were received regardless of their success or failure | NumberTotalInvocations |
| Average Execution Time | measurement | Average time it took to process incoming remote API requests that were ultimately successful | AverageExecutionTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Table 4.44. Metrics
| Name | Description |
|---|---|
| Clear Metrics | Clear the collected metric data and start collecting anew |
| View Received Call Time Data | View statistical information about each subsystem call into the server |
Package Types
none
Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.