Red Hat Training

A Red Hat training course is available for Red Hat Fuse

JON Performance Metrics Reference

Red Hat JBoss Fuse

Fuse Plugin Pack for JBoss ON

Red Hat

Version 6.3
16 Jul 2018

Abstract

This guide describes the information you can collect about your Fuse managed resources and then display it in JBoss Operation Network.

Chapter 1. Monitoring Fuse Resources

Abstract

Using Red Hat JBoss Operations Network (JON), you can discover, import, and monitor Red Hat JBoss Fuse resources.

1.1. Installation Procedure

The JBoss ON for Fuse plugin pack is not installed with the JON base distribution. You must download and install it separately after you have installed the JON base distribution.
To install JBoss ON for Fuse:
  1. Select JBoss ON for Fuse under Management in the sidebar menu (or from the Product drop-down menu).
  2. Click the Patches tab to view the latest JBoss ON for Fuse patch packages.
  3. Click Download next to the latest patch package Red Hat JBoss ON 3.3 Management Plug-in Pack Update-XX for Red Hat JBoss Fuse 6 (where the latest update at the time of writing was Update-06).
  4. Unzip the plug-in package, jon-plugin-pack-fuse-3.3.0.GA-update-XX.zip, to a temporary directory.
  5. Install the jar files in one of two ways:

1.2. Using JBoss Operations Network with Fuse on EAP

The new FuseJBoss Application Server 7 Plugin exposes the following services under JBossAS7 standalone server and managed server resources from the JBossAS7 Plugin:
  • Apache ActiveMQ Services - singleton parent resource for all ActiveMQ Broker services
  • Apache Camel Services - singleton parent resource for all Camel Context services
  • Apache CXF Services - singleton parent resource for all CXF Bus and CXF Endpoint services
It can auto-discover standalone mode deployments and determine all the required configuration, including management username and password from the parent resource.
For domain deployments of EAP, it can auto-discover all the services. However, you can provide the management username and password in a text file rhq-user.properties in the eap-install-dir/domain/configuration/ directory, with a single entry of the format:
username=BASE64 encoded UTF-8 password
You can add a user to the ApplicationRealm, and uncomment the following line in the JBoss AS7 profiles, used by managed servers to be monitored.
remoting-connector use-management-endpoint="false"/>-->
Note
This will make the MBeanServer accessible over the same Remoting connector used for remote JNDI and EJB access. Any user that can authenticate against the realm ApplicationRealm will be able to access the MBeanServer.
An alternative method to expose the username and password in a text file, is to manually import FuseJBossAS7 services as child services under managed servers to be monitored, and providing the username, password in the manually added resource. You must add a user to the ApplicationRealm.
Note
The auto-discovery only adds these services when any children resources are detected. For example, Apache Camel Services resource will be auto-discovered, when any Camel MBeans are detected in the server. The availability of these parent services tracks the availability of their respective children resources in the server. It also applies to manually imported services.

Chapter 2. JBoss ON Managed Fuse Resources

Overview

Metrics are collected for managed resources that are deployed in Red Hat JBoss Fuse.
  • Apache ActiveMQ managed resources
  • Apache Camel managed resources
  • Apache CXF managed resources
  • JBoss Fuse managed resources
  • Fuse Fabric managed resources
Note
This guide descibes the metrics collected on Apache Camel, Apache CXF, JBoss Fuse, and Fuse Fabric managed resources only. The Performance Metrics Reference for Red Hat JBoss A-MQ describes the metrics collected on Apache ActiveMQ-managed resources.
Important
Newly added resources, such as ActiveMQ queues and topics, will not appear in JON's list of resources until the JON agent discovers and adds them into inventory. By default, the agent scans for services at twenty-four hour intervals, but you can easily change the default interval either through the JON console or by resetting it in the agent's configuration file. For details, see Setting Discovery Scan Intervals in the Configuring JBoss ON Servers and Agents guide at https://access.redhat.com/site/documentation/.
Based on a managed resource's metrics, you can invoke Control Operations on the resource to avoid or correct throughput and performance problems.

Availability Status

For all JBoss Fuse managed resources, this metric is of category Availability and of measurement type Dynamic. It indicates the availability status of a resource during a given time slice.

Table 2.1. Availability Indicators

IconStateDescription
Green check mark
Available (Up)Resource is running and responding to availability checks.
Red ball with white exclamation point inside
DownResource is not responding to availability checks.
Gray ball with white question mark inside
Unknown
The agent has no record of the resource's state.
This could be due to the resource having been newly added to inventory, so has not yet been checked for availability. Or it could be that the agent is down.
Red circle with green dot inside and a red slash cutting diagonally through the circle's diameter
Disabled
The resource has been administratively marked as unavailable.
In reality, the resource could be running or stopped. When a resource is disabled, the server ignores availability reports from the agent to prevent unnecessary alerts triggered by known down (or cycling) states.
Yellow triangle with black exclamation point inside
Mixed (resource groups only)Members in a resource group have different availability states.

Per Minute metrics

Because metrics of type Trends Up and category Throughput continuously increase, the rate of change becomes more important to track than the total number of exchanges. So JBoss ON automatically calculates and creates a secondary Per Minute metric for many of these type of exchanges. By default, the Per Minute metrics, rather than their counterparts, are enabled and charted.

Referencing properties in Dynamic Group Definition expressions

To reference configuration properties and traits in Dynamic Group Definition expressions, you must use the item's internal name.

Chapter 3. Apache Camel Managed Resources

Abstract

Apache Camel metrics are collected for routes that are deployed in Red Hat JBoss ON managed platforms. Based on a resource's metrics, you can invoke Control Operations on the resource to avoid or correct throughput and performance problems.

3.1. Agent Metric Collectors

The main service entries, which collect the required metrics, are:
  • Camel Context
  • Camel Component
  • Camel Endpoint
  • Camel Route
  • Camel Processor
Note
By default, Availability status is collected on all Camel services. Only the Camel Route and Camel Processor services collect additional metrics.

3.2. Camel Context Service

Overview

Description:Camel Context
Singleton:no
Plugin:Camel

Parent Resource Types

  • JMX Server Platform
  • Fabric Container Platform
  • JBoss Fuse Container Platform
  • JBoss AS Server Platform

Child Resource Types

Connection Properties

Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
NameDescriptionRequiredInternal Name
Camel IdThe name of the Camel componentyesCamelId
Camel VersionThe Camel versionyesCamelVersion
Object Name yesobjectName
Name Template yesnameTemplate
Description Template yesdescriptionTemplate
ContextThe name of the Camel Contextyescontext
NameNameyesname

Metrics

Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
NameTypeDescriptionInternal Name
Exchanges CompletedmeasurementIndicates the total number of exchanges processed successfully since start-up or the last reset operationExchangesCompleted
Exchanges Completed per MinutemeasurementIndicates the total number of exchanges processed successfully per minute since start-up or the last reset operationExchangesCompleted
Exchanges FailedmeasurementIndicates the total number of exchanges that failed to process since start-up or the last reset operation.ExchangesFailed
Exchanges Failed per MinutemeasurementIndicates the total number of exchanges that failed to process per minute since start-up or the last reset operation.ExchangesFailed
Exchanges TotalmeasurementIndicates the total number of exchanges, passed or failed, that processed since start-up or the last reset operation.ExchangesTotal
Exchanges Total per MinutemeasurementIndicates the total number of exchanges, passed or failed, that processed per minute since start-up or the last reset operation.ExchangesTotal
Min Processing TimemeasurementIndicates the shortest time, in milliseconds, to process an exchange since start-up or the last reset operation.MinProcessingTime
Mean Processing TimemeasurementIndicates the average processing time, in milliseconds, for all exchanges processed since start-up or the last reset operation.MeanProcessingTime
Max Processing TimemeasurementIndicates the longest time, in milliseconds, to process an exchange since start-up or the last reset operation.MaxProcessingTime
Total Processing TimemeasurementIndicates the total processing time, in milliseconds, to process all exchanges since start-up or the last reset operation.TotalProcessingTime
Last Processing TimemeasurementIndicates the time, in milliseconds, it took to process the last exchange.LastProcessingTime
StatetraitString description of the Camel Resource State.State
Note
All Exchanges* metrics are of measurement type Trends Up and category Throughput. Because Trends Up metrics continuously increase, the rate of change becomes more important to track than the total number of exchanges, so JBoss ON automatically calculates and creates a secondary Per Minute metric for each Exchanges* metric. By default, the Per Minute metrics, rather than their counterparts, are enabled and charted.

Configuration Properties

none

Operations

You can invoke control operations to avoid or correct throughput and performance problems.
NameDescription
start The start operation starts up the selected camel context.
stop The stop operation stops the selected camel context immediately.
suspend The suspend operation pauses the routing of messages and preserves the state of the route, after the completion of all inflight exchanges.
resume The resume operation resumes the processing of messages after a call to suspend.

Package Types

none

3.3. Camel Component Service

Overview

Description:Camel Component
Singleton:no
Plugin:Camel

Parent Resource Types

Child Resource Types

none

Connection Properties

Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
NameDescriptionRequiredInternal Name
Component NameThe name of the Camel component yesComponentName
Object Name yesobjectName
Name Template yesnameTemplate
Description Template yesdescriptionTemplate
NameNameyesname

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

3.4. Camel Endpoint Service

Overview

Description:Camel Endpoint
Singleton:no
Plugin:Camel

Parent Resource Type

Child Resource Types

none

Connection Properties

Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
NameDescriptionRequiredInternal Name
Endpoint UriThe uri of the Camel consumer endpointyesEndpointUri
Object Name yesobjectName
Name Template yesnameTemplate
Description Template yesdescriptionTemplate
NameNameyesname

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

3.5. Camel Processor Service

Overview

Description:Camel Processor
Singleton:no
Plugin:Camel

Parent Resource Types

Child Resource Types

none

Connection Properties

Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
NameDescriptionRequiredInternal Name
Route IdThe name of the Camel routeyesRouteId
Processor IdThe name of the processor in the Camel RouteyesProcessorId
Object Name yesobjectName
Name Template yesnameTemplate
Description Template yesdescriptionTemplate
NameNameyesname

Metrics

Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
NameTypeDescriptionInternal Name
Exchanges CompletedmeasurementIndicates the total number of exchanges the selected processor has processed successfully since processor start-up or the last reset operation.ExchangesCompleted
Exchanges Completed Per MinutemeasurementIndicates the total number of exchanges the selected processor has processed successfully per minute since processor start-up or the last reset operation.ExchangesCompleted
Exchanges FailedmeasurementIndicates the total number of exchanges that the selected processor has failed to process since processor start-up or the last reset operation.ExchangesFailed
Exchanges Failed Per MinutemeasurementIndicates the total number of exchanges that the selected processor has failed to process per minute since processor start-up or the last reset operation.ExchangesFailed
Exchanges TotalmeasurementIndicates the total number of exchanges, passed or failed, that the selected processor has processed since route start-up or the last reset operation.ExchangesTotal
Exchanges Total Per MinutemeasurementIndicates the total number of exchanges, passed or failed, that the selected processor has processed per minute since route start-up or the last reset operation.ExchangesTotal
Min Processing TimemeasurementIndicates the shortest time, in milliseconds, to process an exchange since processor start-up or the last reset operation.MinProcessingTime
Mean Processing TimemeasurementIndicates the average processing time, in milliseconds, for all exchanges processed since processor start-up or the last reset operation.MeanProcessingTime
Max Processing TimemeasurementIndicates the longest time, in milliseconds, to process an exchange since processor start-up or the last reset operation.MaxProcessingTime
Total Processing TimemeasurementIndicates the total processing time, in milliseconds, of all exchanges processed since processor start-up or the last reset operation.TotalProcessingTime
Last Processing TimemeasurementIndicates the time, in milliseconds, it took the selected processor to process the last exchange.LastProcessingTime
StatetraitA string describing the state of the Camel resource.State
Note
All Exchanges* metrics are of measurement type Trends Up and category Throughput. Because Trends Up metrics continuously increase, the rate of change becomes more important to track than the total number of exchanges, so JBoss ON automatically calculates and creates a secondary Per Minute metric for each Exchanges* metric. By default, the Per Minute metrics, rather than their counterparts, are enabled and charted.

Configuration Properties

none

Operations

You can invoke control operations to avoid or correct throughput and performance problems.
NameDescription
reset The reset operation immediately clears all counters, thus all statistics, for the specified processor.
start The start operation starts up the selected processor and all of its services.
stop The stop operation immediately stops the selected processor.

Package Types

none

3.6. Camel Route Service

Overview

Description:Camel Route
Singleton:no
Plugin:Camel

Parent Resource Types

Child Resource Types

none

Connection Properties

Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
NameDescriptionRequiredInternal Name
Route IdThe name of the Camel routeyesRouteId
Endpoint UriThe uri of the consumer endpoint in the Camel routeyesEndpointUri
Object Name yesobjectName
Name Template yesnameTemplate
Description Template yesdescriptionTemplate
NameNameyesname

Metrics

Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
NameTypeDescriptionInternal Name
Exchanges CompletedmeasurementIndicates the total number of exchanges the route has processed successfully since route start-up or the last reset operation.ExchangesCompleted
Exchanges Completed Per MinutemeasurementIndicates the total number of exchanges the route has processed successfully per minute since route start-up or the last reset operation.ExchangesCompleted
Exchanges FailedmeasurementIndicates the total number of exchanges that the route has failed to process since route start-up or the last reset operation.ExchangesFailed
Exchanges Failed Per MinutemeasurementIndicates the total number of exchanges that the route has failed to process per minute since route start-up or the last reset operation.ExchangesFailed
Exchanges TotalmeasurementIndicates the total number of exchanges, passed or failed, that the route has processed since route start-up or the last reset operation.ExchangesTotal
Exchanges Total Per MinutemeasurementIndicates the total number of exchanges, passed or failed, that the route has processed per minute since route start-up or the last reset operation.ExchangesTotal
Inflight ExchangesmeasurementIndicates the number of exchanges currently transiting the route.InflightExchanges
Inflight Exchanges Per MinutemeasurementIndicates the number of exchanges currently transiting the route per minute.InflightExchanges
Min Processing TimemeasurementIndicates the shortest time, in milliseconds, to process an exchange since route start-up or the last reset operation.MinProcessingTime
Mean Processing TimemeasurementIndicates the average processing time, in milliseconds, for all exchanges processed since route start-up or the last reset operation.MeanProcessingTime
Max Processing TimemeasurementIndicates the longest time, in milliseconds, to process an exchange since route start-up or the last reset operation.MaxProcessingTime
Total ProcessingTimemeasurementIndicates the total processing time, in milliseconds, of all exchanges processed since route start-up or the last reset operation.TotalProcessingTime
Last Processing TimemeasurementIndicates the time, in milliseconds, it took the route to process the last exchange.LastProcessingTime
StatetraitA string describing the state of the Camel resource.State
Note
All Exchanges* metrics are of measurement type Trends Up and category Throughput. Because Trends Up metrics continuously increase, the rate of change becomes more important to track than the total number of exchanges, so JBoss ON automatically calculates and creates a secondary Per Minute metric for each Exchanges* metric. By default, the Per Minute metrics, rather than their counterparts, are enabled and charted.

Configuration Properties

none

Operations

You can invoke control operations to avoid or correct throughput and performance problems.
NameDescription
reset The reset operation immediately clears all counters, thus all statistics, for the specified route.
shutdown
The shutdown operation immediately stops and shuts down the selected route, pending the completion of all inflight exchanges.
start The start operation starts up the selected route, including all of its processors and services.
stop
The stop operation immediately stops the selected route, pending the completion of all pending inflight exchanges.

Package Types

none

Chapter 4. Apache CXF Managed Resources

Abstract

Apache CXF metrics are collected for web services that are deployed in Red Hat JBoss ON managed platforms. Based on a resource's metrics, you can invoke Control Operations on the resource to avoid or correct throughput and performance problems.

4.1. Agent Metric Collectors

The main service entries, which collect the required metrics, are:
  • CXF Process
  • CXF Bus
  • CXF Work Queue Manager
  • CXF Work Queue
  • CXF Endpoint
  • CXF Client Operation Counter
  • CXF Client Service Counter
  • CXF Server Operation Counter
  • CXF Server Service Counter
Note
By default, Availability status is collected on all CXF services. Only the CXF Client Operation Counter, CXF Client Service Counter, CXF Server Operation Counter, and CXF Server Service Counter services collect additional metrics.

4.2. CXF Process Server (CXF)

Overview

Description:CXF Process
Singleton: no
Plugin:CXF

Parent Resource Types

  • Managed Platforms

Child Resource Types

  • CXF Process JVM Server

Autodiscovery Process Scans

NameQuery
${processScan.name}
process|basename|match=^java.*,arg|-Dcxf.home|match=.*,arg|
-Dcxf.home|match=.*,arg|-Dcxf.config.file|match=.*

Connection Properties

NameDescriptionRequiredInternal Name
CXF HomeCXF Process Home Directory yes cxf.home
Server Resource KeyJava system property that uniquely identifies this Server yes resourceKey
Version File PatternFile name with Server version yes versionFile
Home DirectorySystem property for home directory yes homeProperty
Connector AddressJMX Service URL no connectorAddress
PrincipalJMX login principal/username no principal
CredentialsJMX login credentials/password no credentials
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

4.3. Bus Service (CXF)

Overview

Description:CXF Bus
Singleton: no
Plugin:CXF

Parent Resource Types

Child Resource Types

Connection Properties

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
Bus IDCXF Bus ID yes bus.id
Avoid Custom Object NamesAvoid Custom JMX Object Names yes skipUnknownProps
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

none

Operations

NameDescription
ShutdownShutdown the CXF bus.

Package Types

none

4.4. WorkQueueManager Service (CXF)

Overview

Description:CXF WorkQueueManager
Singleton: no
Plugin:CXF

Parent Resource Types

Child Resource Types

Connection Properties

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Bus IDCXF Bus ID yes bus.id
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
Avoid Custom Object NamesAvoid Custom JMX Object Names yes skipUnknownProps
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

none

Operations

NameDescription
Shutdown Shut down the Work Queue Manager.

Package Types

none

4.5. WorkQueue Service (CXF)

Overview

Description:CXF WorkQueue
Singleton: no
Plugin:CXF

Parent Resource Types

Child Resource Types

none

Connection Properties

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
Avoid Custom Object NamesAvoid Custom JMX Object Names yes skipUnknownProps
Bus IDCXF Bus ID yes bus.id
NameWorkqueue Name yes name
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

none

Operations

none

Package Types

none

4.6. CXF Endpoint Service (CXF)

Overview

Description:CXF Endpoint
Singleton: no
Plugin:CXF

Parent Resource Types

Child Resource Types

Child resources are not enabled by default. This avoids unnecessary runtime overhead during web service call processing. To enable Performance.Counter.Server and Performance.Counter.Client, add the following to the Spring context file or the Blueprint document:
<bean id="CounterRepository" class="org.apache.cxf.management.counters.CounterRepository">
    <property name="bus" ref="<CXF-bus-instance>" />
</bean>
The Performance.Counter.Server and Performance.Counter.Client type resources will be discovered after the CXF endpoint is invoked at least once.

Connection Properties

NameDescriptionRequiredInternal Name
AddressEndpoint Address no Address
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
Bus IDCXF Bus ID yes bus.id
Avoid Custom Object NamesAvoid Custom JMX Object Names yes skipUnknownProps
ServiceService QName yes service
PortPort Name yes port
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

none

Configuration Properties

none

Operations

NameDescription
StartStart a CXF endpoint.
StopStop a CXF endpoint.

Package Types

none

4.7. ClientServiceCounter Service (CXF)

Overview

Description:CXF Client Service Counter
Singleton: no
Plugin:CXF

Parent Resource Types

Child Resource Types

none

Connection Properties

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
Avoid Custom Object NamesAvoid Custom JMX Object Names yes skipUnknownProps
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

NameTypeDescriptionInternal Name
Average Response TimemeasurementAverage Response TimeAvgResponseTime
Min Response TimemeasurementMinimum Response TimeMinResponseTime
Max Response TimemeasurementMaximum Response TimeMaxResponseTime
Invocation CountmeasurementNumber of Operation invocationsNumInvocations
Invocation Count per MinutemeasurementNumber of Operation invocations per minuteNumInvocations
Checked Application FaultsmeasurementNumber of checked application faults thrownNumCheckedApplicationFaults
Checked Application Faults per MinutemeasurementNumber of checked application faults thrown per minuteNumCheckedApplicationFaults
UnChecked Application FaultsmeasurementNumber of unchecked application faults thrownNumUnCheckedApplicationFaults
UnChecked Application Faults per MinutemeasurementNumber of unchecked application faults thrown per minuteNumUnCheckedApplicationFaults
Logical Runtime FaultsmeasurementNumber of logical runtime faults thrownNumLogicalRuntimeFaults
Logical Runtime Faults per MinutemeasurementNumber of logical runtime faults thrown per minuteNumLogicalRuntimeFaults
Runtime FaultsmeasurementNumber of runtime faults thrownNumRuntimeFaults
Runtime Faults per MinutemeasurementNumber of runtime faults thrown per minuteNumRuntimeFaults
Total Handling TimemeasurementTotal processing timeTotalHandlingTime
Total Handling Time per MinutemeasurementTotal processing time per minuteTotalHandlingTime
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

4.8. ClientOperationCounter Service (CXF)

Overview

Description:CXF Client Operation Counter
Singleton: no
Plugin:CXF

Parent Resource Types

Child Resource Types

none

Connection Properties

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
OperationOperation Name yes operation
Avoid Custom Object NamesAvoid Custom JMX Object Names yes skipUnknownProps
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

NameTypeDescriptionInternal Name
Average Response TimemeasurementAverage Response TimeAvgResponseTime
Min Response TimemeasurementMinimum Response TimeMinResponseTime
Max Response TimemeasurementMaximum Response TimeMaxResponseTime
Invocation CountmeasurementNumber of Operation invocationsNumInvocations
Invocation Count per MinutemeasurementNumber of Operation invocations per minuteNumInvocations
Checked Application FaultsmeasurementNumber of checked application faults thrownNumCheckedApplicationFaults
Checked Application Faults per MinutemeasurementNumber of checked application faults thrown per minuteNumCheckedApplicationFaults
UnChecked Application FaultsmeasurementNumber of unchecked application faults thrownNumUnCheckedApplicationFaults
UnChecked Application Faults per MinutemeasurementNumber of unchecked application faults thrown per minuteNumUnCheckedApplicationFaults
Logical Runtime FaultsmeasurementNumber of logical runtime faults thrownNumLogicalRuntimeFaults
Logical Runtime Faults per MinutemeasurementNumber of logical runtime faults thrown per minuteNumLogicalRuntimeFaults
Runtime FaultsmeasurementNumber of runtime faults thrownNumRuntimeFaults
Runtime Faults per MinutemeasurementNumber of runtime faults thrown per minuteNumRuntimeFaults
Total Handling TimemeasurementTotal processing timeTotalHandlingTime
Total Handling Time per MinutemeasurementTotal processing time per minuteTotalHandlingTime
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

4.9. ServerServiceCounter Service (CXF)

Overview

Description:CXF Server Service Counter
Singleton: no
Plugin:CXF

Parent Resource Types

Child Resource Types

none

Connection Properties

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
Avoid Custom Object NamesAvoid Custom JMX Object Names yes skipUnknownProps
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

NameTypeDescriptionInternal Name
Average Response TimemeasurementAverage Response TimeAvgResponseTime
Min Response TimemeasurementMinimum Response TimeMinResponseTime
Max Response TimemeasurementMaximum Response TimeMaxResponseTime
Invocation CountmeasurementNumber of Operation invocationsNumInvocations
Invocation Count per MinutemeasurementNumber of Operation invocations per minuteNumInvocations
Checked Application FaultsmeasurementNumber of checked application faults thrownNumCheckedApplicationFaults
Checked Application Faults per MinutemeasurementNumber of checked application faults thrown per minuteNumCheckedApplicationFaults
UnChecked Application FaultsmeasurementNumber of unchecked application faults thrownNumUnCheckedApplicationFaults
UnChecked Application Faults per MinutemeasurementNumber of unchecked application faults thrown per minuteNumUnCheckedApplicationFaults
Logical Runtime FaultsmeasurementNumber of logical runtime faults thrownNumLogicalRuntimeFaults
Logical Runtime Faults per MinutemeasurementNumber of logical runtime faults thrown per minuteNumLogicalRuntimeFaults
Runtime FaultsmeasurementNumber of runtime faults thrownNumRuntimeFaults
Runtime Faults per MinutemeasurementNumber of runtime faults thrown per minuteNumRuntimeFaults
Total Handling TimemeasurementTotal processing timeTotalHandlingTime
Total Handling Time per MinutemeasurementTotal processing time per minuteTotalHandlingTime
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

4.10. ServerOperationCounter Service (CXF)

Overview

Description:CXF Server Operation Counter
Singleton: no
Plugin:CXF

Parent Resource Types

Child Resource Types

none

Connection Properties

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
OperationOperation Name yes operation
Avoid Custom Object NamesAvoid Custom JMX Object Names yes skipUnknownProps
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

NameTypeDescriptionInternal Name
Average Response TimemeasurementAverage Response TimeAvgResponseTime
Min Response TimemeasurementMinimum Response TimeMinResponseTime
Max Response TimemeasurementMaximum Response TimeMaxResponseTime
Invocation CountmeasurementNumber of Operation invocationsNumInvocations
Invocation Count per MinutemeasurementNumber of Operation invocations per minuteNumInvocations
Checked Application FaultsmeasurementNumber of checked application faults thrownNumCheckedApplicationFaults
Checked Application Faults per MinutemeasurementNumber of checked application faults thrown per minuteNumCheckedApplicationFaults
UnChecked Application FaultsmeasurementNumber of unchecked application faults thrownNumUnCheckedApplicationFaults
UnChecked Application Faults per MinutemeasurementNumber of unchecked application faults thrown per minuteNumUnCheckedApplicationFaults
Logical Runtime FaultsmeasurementNumber of logical runtime faults thrownNumLogicalRuntimeFaults
Logical Runtime Faults per MinutemeasurementNumber of logical runtime faults thrown per minuteNumLogicalRuntimeFaults
Runtime FaultsmeasurementNumber of runtime faults thrownNumRuntimeFaults
Runtime Faults per MinutemeasurementNumber of runtime faults thrown per minuteNumRuntimeFaults
Total Handling TimemeasurementTotal processing timeTotalHandlingTime
Total Handling Time per MinutemeasurementTotal processing time per minuteTotalHandlingTime
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

Chapter 5. JBoss Fuse Managed Resources

Abstract

JBoss Fuse metrics are collected for Red Hat JBoss Fuse containers and Fabric service.

5.1. Agent Metric Collectors

Abstract

The main service entries, which collect the required metrics, are:
  • JBoss Fuse Container Server
  • JBoss Fuse Fabric Service
.

5.1.1. JBoss Fuse Container Server (JBossFuse)

Overview

Description:JBoss Fuse Container Process
Singleton: no
Plugin:JBossFuse

Parent Resource Types

  • Managed Platforms

Child Resource Types

  • JBoss Fuse Container JVM_Server

Autodiscovery Process Scans

NameQuery
${processScan.name}
process|basename|match=^java.*,arg|-Dkaraf.home|match=.*,arg|
-Dkaraf.base|match=.*,arg|*|match=org\.apache\.karaf\.(main|shell\.wrapper)\.Main

Connection Properties

NameDescriptionRequiredInternal Name
Start Script Path
The path to the script that the Start and Restart operations should use to start the server.
If not absolute, the path is resolved relative to the server home directory (e.g. bin/fuse or bin/karaf).
no startScript
Start Script Prefix
A prefix command line that should be prepended to the start script command line by the Start and Restart operations. The prefix must be an absolute path (for example, /usr/bin/sudo).
This property is most commonly used to run the Server process as a different user than the RHQ Agent for example, sudo -u fuse -g fuse could be used to run the Server as user fuse and group fuse.
You can also chain prefix commands (e.g. nohup sudo -u fuse could be used to make the Server ignore HUP signals and to run as user fuse).
no startScriptPrefix
Start Script Environment Variables
The variables that the Start and Restart operations will add to the environment of the server start script.
Put each name=value pair on a new line. Do not enclose variable values in quotes (e.g. JAVA_OPTS=-Xms512M -Xmx1024M).
On UNIX systems, the typical minimum set of environment variables is: PATH=/usr/bin:/bin. On Windows, the typical minimum set is: PATH=C:\Windows\System32;C:\Windows, and on OS=Windows_NT, the typical minimum set is: SYSTEMROOT=C:\Windows.
It is also good practice to set JAVA_HOME to the absolute path of the install directory of the JRE or JDK you want to use to run the Server instance. If JAVA_HOME is unspecified, the start script attempts to find java in the PATH.
This property is limited to 2000 characters.
no startScriptEnv
Start Script Arguments
The arguments that the Start and Restart operations will pass to the server start script.
Put each argument on a new line. An exception, you can put the value of a space-delimited option on the same line as the option.
This property is limited to 2000 characters.
no startScriptArgs
Log Event SourcesThe list of log files that can be tracked yes logEventSources
JBoss Fuse Container HomeJBoss Fuse Container Home Directory yes karaf.home
JBoss Fuse Container BaseJBoss Fuse Container Base Directory yes karaf.base
Server Resource KeyJava system property that uniquely identifies this Server yes resourceKey
Version File PatternFile name with Server version yes versionFile
Home DirectorySystem property for home directory yes homeProperty
Log FileLog File to track yes logFile
Connector AddressJMX Service URL no connectorAddress
PrincipalJMX login principal/username no principal
CredentialsJMX login credentials/password no credentials
Fabric Registry URLURL to use to connect to the Fabric Registry, required for Fabric managed Containers no zookeeper.url
Fabric Registry PasswordPassword to use to connect to the Fabric Registry no zookeeper.password
Registry TimeoutRegistry connection timeout in Seconds, used for Fabric metadata collection yes zookeeper.timeout
JBoss Fuse Container TypeJBoss Fuse Container Type based on underlying product install yes container.type
JBoss Fuse Container NameJBoss Fuse Container name, same as Karaf name yes karaf.name
Fabric Container Git RepositoryFabric Container Git repository location yes git.root
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

NameTypeDescriptionInternal Name
JBoss Fuse Container VersiontraitJBoss Fuse Profile Version used by this Containercontainer.version
JBoss Fuse ProfilestraitJBoss Fuse Profiles referenced directly by this Containerprofiles
JBoss Fuse Parent ProfilestraitJBoss Fuse parent Profiles indirectly referenced by this ContainerparentProfiles
MQ ClusterstraitJBoss Fuse MQ Clusters where this Container exports ActiveMQ Connection DetailsmqClusters
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

NameDescription
StartStart the server by invoking its start script
RestartRestart the server by shutting it down and then invoking its start script
StopStop the server.

Package Types

none

5.1.2. Fabric Service (JBossFuse)

Description:Fabric Service
Singleton: no
Plugin:JBossFuse

Parent Resource Types

  • JBoss Fuse Container Platform

Child Resource Types

none

Connection Properties

NameDescriptionRequiredInternal Name
Object Name  yes objectName
Name Template  yes nameTemplate
Description Template  yes descriptionTemplate
Skip unknown object name propertiesSkip object names with unknown properties yes skipUnknownProps
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

NameTypeDescriptionInternal Name
Default VersiontraitDefault Container VersionDefaultVersion
Maven Repo URItraitFabric Maven Repo URIMavenRepoURI
Maven Repo Upload URItraitFabric Maven Repo upload URIMavenRepoUploadURI
Zookeeper UrltraitFabric ZooKeeper URLZookeeperUrl
Current Container NametraitCurrent container name from Fabric agentCurrentContainerName
Default Jvm OptionstraitContainer default JVM optionsDefaultJvmOptions
Default RepotraitDefault Maven repoDefaultRepo
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

NameDescription
Scale ProfileScale a profile up or down

Package Types

none

Chapter 6. Fabric Managed Resources

Abstract

Fabric metrics are collected for fabrics deployed in Red Hat JBoss Fuse.

6.1. Agent Metric Collectors

Abstract

The main service entry, which collects the required metrics, is Fabric Container.

6.1.1. Fabric Container Server (Fabric)

Overview

Description:Fabric Container Process
Singleton: no
Plugin:Fabric

Parent Resource Types

  • Managed Platforms

Child Resource Types

  • Fabric Container JVM Server

Autodiscovery Process Scans

NameQuery
${processScan.name}
process|basename|match=^java.*,arg|-Dkaraf.home|match=.*,arg|
-Dkaraf.base|match=.*,arg|*|match=org\.apache\.karaf\.(main|shell\.wrapper)\.Main

Connection Properties

NameDescriptionRequiredInternal Name
Log Event SourcesThe list of log files that can be tracked yes logEventSources
Fabric Container HomeFabric Container Home Directory yes karaf.home
Fabric Container BaseFabric Container Base Directory yes karaf.base
Server Resource KeyJava system property that uniquely identifies this Server yes resourceKey
Version File PatternFile name with Server version yes versionFile
Home DirectorySystem property for home directory yes homeProperty
Log FileLog File to track yes logFile
Connector AddressJMX Service URL no connectorAddress
PrincipalJMX login principal/username no principal
CredentialsJMX login credentials/password no credentials
Fabric Registry URLURL to use to connect to the Fabric Registry, required for Fabric managed Containers no zookeeper.url
Fabric Registry PasswordPassword to use to connect to the Fabric Registry no zookeeper.password
Registry TimeoutRegistry connection timeout in Seconds, used for Fabric metadata collection yes zookeeper.timeout
Fuse Container TypeFuse Container Type based on underlying product install yes container.type
Fabric Container NameFabric Container name, same as Karaf name yes karaf.name
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

NameTypeDescriptionInternal Name
Fabric Container VersiontraitFabric Profile Version used by this Containercontainer.version
Fabric ProfilestraitFabric Profiles referenced directly by this Containerprofiles
Fabric Parent ProfilestraitFabric parent Profiles indirectly referenced by this ContainerparentProfiles
MQ ClusterstraitFabric MQ Clusters where this Container exports ActiveMQ Connection DetailsmqClusters
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

none

Package Types

none

Legal Notice

Trademark Disclaimer

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Apache, ServiceMix, Camel, CXF, and ActiveMQ are trademarks of Apache Software Foundation. Any other names contained herein may be trademarks of their respective owners.