4.2.5. RHQServer - RHQ Server Remote API Subsystem Service


Overview

Expand
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

Expand
Table 4.42. 
NameDescriptionRequiredInternal 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

Expand
Table 4.43. Metrics
NameTypeDescriptionInternal Name
Number Failed InvocationsmeasurementTotal number of remote API requests that were received but failed to be processed successfullyNumberFailedInvocations
Number Failed Invocations per MinutemeasurementTotal number of remote API requests that were received but failed to be processed successfullyNumberFailedInvocations
Number Successful InvocationsmeasurementTotal number of remote API requests that were received and successfully processedNumberSuccessfulInvocations
Number Successful Invocations per MinutemeasurementTotal number of remote API requests that were received and successfully processedNumberSuccessfulInvocations
Number Total InvocationsmeasurementTotal number of remote API requests that were received regardless of their success or failureNumberTotalInvocations
Number Total Invocations per MinutemeasurementTotal number of remote API requests that were received regardless of their success or failureNumberTotalInvocations
Average Execution TimemeasurementAverage time it took to process incoming remote API requests that were ultimately successfulAverageExecutionTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Expand
Table 4.44. Metrics
NameDescription
Clear MetricsClear the collected metric data and start collecting anew
View Received Call Time DataView statistical information about each subsystem call into the server

Package Types

none
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat