-
Language:
English
-
Language:
English
Red Hat Training
A Red Hat training course is available for Red Hat Fuse
Performance Metrics Reference
Red Hat JBoss Fuse
Fuse Plugin Pack for JBoss ON
Red Hat
Version 6.0
Copyright © 2013 Red Hat, Inc. and/or its affiliates.
13 Oct 2017
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.
Important
The Fuse Plugin Pack for JBoss ON 3.1.2 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 the
Fuse Plugin Pack for JBoss ON 3.1.2
:
- Navigate to the Red Hat Customer Portal>Downloads>JBoss Enterprise Middleware>Downloads page.
- Select JBoss ON for Fuse under FuseSource in the sidebar menu.
- Click Download next to Fuse Plugin Pack for JBoss ON 3.1.2 .
- Unzip the plugin package (
JON-3.1.2-Fuse/jon-plugin-pack-fuse-3.1.2.GA.zip
) in the/installDir/server/
directory. - Install the jar files in one of two ways:
- Hot DeployCopy the unpacked jar files into the JON
/installDir/server/plugins/
directory. For details, see the JBoss Operations Network Installation Guide. - JON Server UIFor details, see the JBoss Operations Network Installation Guide, or watch the video Installing JBoss Operations Network - Part 4, Installing JON Agent Plugins.
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
- Apache ServiceMix 3.x managed resources
- Apache ServiceMix 4.x managed resources
- JBoss Fuse managed resources
- Fuse Fabric managed resources
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
Icon | State | Description |
---|---|---|
| Available (Up) | Resource is running and responding to availability checks. |
| Down | Resource is not responding to availability checks. |
| 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.
|
| 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.
|
| 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
3.1. Overview
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.2. 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.3. Camel Context Service
Overview
Description: | Camel Context |
Singleton: | no |
Plugin: | Camel |
Parent Resource Types
- JMX Server Platform
- Servicemix3 Server Platform
- Servicemix4 Server Platform
- Fabric Container Platform
- JBoss Fuse Container Platform
- JBossAS Server Platform
Child Resource Types
Connection Properties
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Name | Description | Required | Internal Name |
---|---|---|---|
Camel Id | The name of the Camel component | yes | ComponentName |
Camel Version | The Camel version | yes | CamelVersion |
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Context | The name of the Camel Context | yes | context |
Name | Name | yes | name |
Metrics
none
Configuration Properties
none
Operations
You can invoke control operations to avoid or correct throughput and performance problems.
Name | Description |
---|---|
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.4. 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.
Name | Description | Required | Internal Name |
---|---|---|---|
Component Name | The name of the Camel component | yes | ComponentName |
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Name | yes | name |
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.5. 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.
Name | Description | Required | Internal Name |
---|---|---|---|
Endpoint Uri | The uri of the Camel consumer endpoint | yes | EndpointUri |
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Name | yes | name |
Metrics
none
Configuration Properties
none
Operations
none
Package Types
none
3.6. 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.
Name | Description | Required | Internal Name |
---|---|---|---|
Route Id | The name of the Camel route | yes | RouteId |
Processor Id | The name of the processor in the Camel Route | yes | ProcessorId |
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Name | yes | name |
Metrics
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Name | Type | Description | Internal Name |
---|---|---|---|
Exchanges Completed | measurement | Indicates the total number of exchanges the selected processor has processed successfully since processor start-up or the last reset operation. | ExchangesCompleted |
Exchanges Completed Per Minute | measurement | Indicates the total number of exchanges the selected processor has processed successfully per minute since processor start-up or the last reset operation. | ExchangesCompleted |
Exchanges Failed | measurement | Indicates 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 Minute | measurement | Indicates 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 Total | measurement | Indicates 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 Minute | measurement | Indicates 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 Time | measurement | Indicates the shortest time, in milliseconds, to process an exchange since processor start-up or the last reset operation. | MinProcessingTime |
Mean Processing Time | measurement | Indicates the average processing time, in milliseconds, for all exchanges processed since processor start-up or the last reset operation. | MeanProcessingTime |
Max Processing Time | measurement | Indicates the longest time, in milliseconds, to process an exchange since processor start-up or the last reset operation. | MaxProcessingTime |
Total Processing Time | measurement | Indicates the total processing time, in milliseconds, of all exchanges processed since processor start-up or the last reset operation. | TotalProcessingTime |
Last Processing Time | measurement | Indicates the time, in milliseconds, it took the selected processor to process the last exchange. | LastProcessingTime |
Configuration Properties
none
Operations
You can invoke control operations to avoid or correct throughput and performance problems.
Name | Description |
---|---|
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.7. 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.
Name | Description | Required | Internal Name |
---|---|---|---|
Route Id | The name of the Camel route | yes | RouteId |
Endpoint Uri | The uri of the consumer endpoint in the Camel route | yes | EndpointUri |
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Name | yes | name |
Metrics
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Name | Type | Description | Internal Name |
---|---|---|---|
Exchanges Completed | measurement | Indicates the total number of exchanges the route has processed successfully since route start-up or the last reset operation. | ExchangesCompleted |
Exchanges Completed Per Minute | measurement | Indicates the total number of exchanges the route has processed successfully per minute since route start-up or the last reset operation. | ExchangesCompleted |
Exchanges Failed | measurement | Indicates 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 Minute | measurement | Indicates 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 Total | measurement | Indicates 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 Minute | measurement | Indicates 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 Exchanges | measurement | Indicates the number of exchanges currently transiting the route. | InflightExchanges |
Inflight Exchanges Per Minute | measurement | Indicates the number of exchanges currently transiting the route per minute. | InflightExchanges |
Min Processing Time | measurement | Indicates the shortest time, in milliseconds, to process an exchange since route start-up or the last reset operation. | MinProcessingTime |
Mean Processing Time | measurement | Indicates the average processing time, in milliseconds, for all exchanges processed since route start-up or the last reset operation. | MeanProcessingTime |
Max Processing Time | measurement | Indicates the longest time, in milliseconds, to process an exchange since route start-up or the last reset operation. | MaxProcessingTime |
Total ProcessingTime | measurement | Indicates the total processing time, in milliseconds, of all exchanges processed since route start-up or the last reset operation. | TotalProcessingTime |
Last Processing Time | measurement | Indicates the time, in milliseconds, it took the route to process the last exchange. | LastProcessingTime |
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.
Name | Description |
---|---|
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
4.1. Overview
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.2. 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.3. 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
Name | Query |
---|---|
${processScan.name} |
process|basename|match=^java.*,arg|-Dcxf.home|match=.*,arg|
-Dcxf.config.file|match=.*
|
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
CXF Home | CXF Process Home Directory | yes | cxf.home |
Server Resource Key | Java system property that uniquely identifies this Server | yes | resourceKey |
Version File Pattern | File name with Server version | yes | versionFile |
Home Directory | System property for home directory | yes | homeProperty |
Connector Address | JMX Service URL | no | connectorAddress |
Principal | JMX login principal/username | no | principal |
Credentials | JMX 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.4. Bus Service (CXF)
Overview
Description: | CXF Bus |
Singleton: | no |
Plugin: | CXF |
Parent Resource Types
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Bus ID | CXF Bus ID | yes | bus.id |
Avoid Custom Object Names | Avoid 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
Name | Description |
---|---|
Start | Start the CXF bus. |
Stop | Stop the CXF bus. |
Package Types
none
4.5. WorkQueueManager Service (CXF)
Overview
Description: | CXF WorkQueueManager |
Singleton: | no |
Plugin: | CXF |
Parent Resource Types
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Bus ID | CXF Bus ID | yes | bus.id |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Avoid Custom Object Names | Avoid 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
Name | Description |
---|---|
Shutdown | Shut down the Work Queue Manager. |
Package Types
none
4.6. WorkQueue Service (CXF)
Overview
Description: | CXF WorkQueue |
Singleton: | no |
Plugin: | CXF |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Avoid Custom Object Names | Avoid Custom JMX Object Names | yes | skipUnknownProps |
Bus ID | CXF Bus ID | yes | bus.id |
Name | Workqueue 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.7. CXF Endpoint Service (CXF)
Overview
Description: | CXF Endpoint |
Singleton: | no |
Plugin: | CXF |
Parent Resource Types
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Address | Endpoint Address | no | Address |
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Bus ID | CXF Bus ID | yes | bus.id |
Avoid Custom Object Names | Avoid Custom JMX Object Names | yes | skipUnknownProps |
Service | Service QName | yes | service |
Port | Port 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
Name | Description |
---|---|
Start | Start a CXF endpoint. |
Stop | Stop a CXF endpoint. |
Package Types
none
4.8. ClientServiceCounter Service (CXF)
Overview
Description: | CXF Client Service Counter |
Singleton: | no |
Plugin: | CXF |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Avoid Custom Object Names | Avoid Custom JMX Object Names | yes | skipUnknownProps |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Average Response Time | measurement | Average Response Time | AvgResponseTime |
Min Response Time | measurement | Minimum Response Time | MinResponseTime |
Max Response Time | measurement | Maximum Response Time | MaxResponseTime |
Invocation Count | measurement | Number of Operation invocations | NumInvocations |
Invocation Count per Minute | measurement | Number of Operation invocations per minute | NumInvocations |
Checked Application Faults | measurement | Number of checked application faults thrown | NumCheckedApplicationFaults |
Checked Application Faults per Minute | measurement | Number of checked application faults thrown per minute | NumCheckedApplicationFaults |
UnChecked Application Faults | measurement | Number of unchecked application faults thrown | NumUnCheckedApplicationFaults |
UnChecked Application Faults per Minute | measurement | Number of unchecked application faults thrown per minute | NumUnCheckedApplicationFaults |
Logical Runtime Faults | measurement | Number of logical runtime faults thrown | NumLogicalRuntimeFaults |
Logical Runtime Faults per Minute | measurement | Number of logical runtime faults thrown per minute | NumLogicalRuntimeFaults |
Runtime Faults | measurement | Number of runtime faults thrown | NumRuntimeFaults |
Runtime Faults per Minute | measurement | Number of runtime faults thrown per minute | NumRuntimeFaults |
Total Handling Time | measurement | Total processing time | TotalHandlingTime |
Total Handling Time per Minute | measurement | Total processing time per minute | TotalHandlingTime |
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. ClientOperationCounter Service (CXF)
Overview
Description: | CXF Client Operation Counter |
Singleton: | no |
Plugin: | CXF |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Operation | Operation Name | yes | operation |
Avoid Custom Object Names | Avoid Custom JMX Object Names | yes | skipUnknownProps |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Average Response Time | measurement | Average Response Time | AvgResponseTime |
Min Response Time | measurement | Minimum Response Time | MinResponseTime |
Max Response Time | measurement | Maximum Response Time | MaxResponseTime |
Invocation Count | measurement | Number of Operation invocations | NumInvocations |
Invocation Count per Minute | measurement | Number of Operation invocations per minute | NumInvocations |
Checked Application Faults | measurement | Number of checked application faults thrown | NumCheckedApplicationFaults |
Checked Application Faults per Minute | measurement | Number of checked application faults thrown per minute | NumCheckedApplicationFaults |
UnChecked Application Faults | measurement | Number of unchecked application faults thrown | NumUnCheckedApplicationFaults |
UnChecked Application Faults per Minute | measurement | Number of unchecked application faults thrown per minute | NumUnCheckedApplicationFaults |
Logical Runtime Faults | measurement | Number of logical runtime faults thrown | NumLogicalRuntimeFaults |
Logical Runtime Faults per Minute | measurement | Number of logical runtime faults thrown per minute | NumLogicalRuntimeFaults |
Runtime Faults | measurement | Number of runtime faults thrown | NumRuntimeFaults |
Runtime Faults per Minute | measurement | Number of runtime faults thrown per minute | NumRuntimeFaults |
Total Handling Time | measurement | Total processing time | TotalHandlingTime |
Total Handling Time per Minute | measurement | Total processing time per minute | TotalHandlingTime |
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. ServerServiceCounter Service (CXF)
Overview
Description: | CXF Server Service Counter |
Singleton: | no |
Plugin: | CXF |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Avoid Custom Object Names | Avoid Custom JMX Object Names | yes | skipUnknownProps |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Average Response Time | measurement | Average Response Time | AvgResponseTime |
Min Response Time | measurement | Minimum Response Time | MinResponseTime |
Max Response Time | measurement | Maximum Response Time | MaxResponseTime |
Invocation Count | measurement | Number of Operation invocations | NumInvocations |
Invocation Count per Minute | measurement | Number of Operation invocations per minute | NumInvocations |
Checked Application Faults | measurement | Number of checked application faults thrown | NumCheckedApplicationFaults |
Checked Application Faults per Minute | measurement | Number of checked application faults thrown per minute | NumCheckedApplicationFaults |
UnChecked Application Faults | measurement | Number of unchecked application faults thrown | NumUnCheckedApplicationFaults |
UnChecked Application Faults per Minute | measurement | Number of unchecked application faults thrown per minute | NumUnCheckedApplicationFaults |
Logical Runtime Faults | measurement | Number of logical runtime faults thrown | NumLogicalRuntimeFaults |
Logical Runtime Faults per Minute | measurement | Number of logical runtime faults thrown per minute | NumLogicalRuntimeFaults |
Runtime Faults | measurement | Number of runtime faults thrown | NumRuntimeFaults |
Runtime Faults per Minute | measurement | Number of runtime faults thrown per minute | NumRuntimeFaults |
Total Handling Time | measurement | Total processing time | TotalHandlingTime |
Total Handling Time per Minute | measurement | Total processing time per minute | TotalHandlingTime |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
4.11. ServerOperationCounter Service (CXF)
Overview
Description: | CXF Server Operation Counter |
Singleton: | no |
Plugin: | CXF |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Operation | Operation Name | yes | operation |
Avoid Custom Object Names | Avoid Custom JMX Object Names | yes | skipUnknownProps |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Average Response Time | measurement | Average Response Time | AvgResponseTime |
Min Response Time | measurement | Minimum Response Time | MinResponseTime |
Max Response Time | measurement | Maximum Response Time | MaxResponseTime |
Invocation Count | measurement | Number of Operation invocations | NumInvocations |
Invocation Count per Minute | measurement | Number of Operation invocations per minute | NumInvocations |
Checked Application Faults | measurement | Number of checked application faults thrown | NumCheckedApplicationFaults |
Checked Application Faults per Minute | measurement | Number of checked application faults thrown per minute | NumCheckedApplicationFaults |
UnChecked Application Faults | measurement | Number of unchecked application faults thrown | NumUnCheckedApplicationFaults |
UnChecked Application Faults per Minute | measurement | Number of unchecked application faults thrown per minute | NumUnCheckedApplicationFaults |
Logical Runtime Faults | measurement | Number of logical runtime faults thrown | NumLogicalRuntimeFaults |
Logical Runtime Faults per Minute | measurement | Number of logical runtime faults thrown per minute | NumLogicalRuntimeFaults |
Runtime Faults | measurement | Number of runtime faults thrown | NumRuntimeFaults |
Runtime Faults per Minute | measurement | Number of runtime faults thrown per minute | NumRuntimeFaults |
Total Handling Time | measurement | Total processing time | TotalHandlingTime |
Total Handling Time per Minute | measurement | Total processing time per minute | TotalHandlingTime |
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. Apache ServiceMix3 Managed Resources
5.1. Overview
Apache ServiceMix3 metrics are collected for JBoss ON managed ServiceMix 3.x platforms. Based on a resource's metrics, you can invoke Control Operations on the resource to avoid or correct throughput and performance problems.
5.2. Agent Metric Collectors
The main service entries, which collect the required metrics, are:
- ServiceMix3 Server
- ServiceMix3 Container
- ServiceMix3 Component
- ServiceMix3 Endpoint
- ServiceMix3 JBI Admin Commands
- ServiceMix3 Service Assembly
- ServiceMix3 Shared Library
Note
By default, Availability status is collected on all ServiceMix3 services. Only the ServiceMix3 Component and Endpoint services collect additional metrics.
5.3. Servicemix3 Server (Servicemix3)
Overview
Description: | Servicemix3 Server Process |
Singleton: | no |
Plugin: | Servicemix3 |
Parent Resource Types
- Managed Platforms
Child Resource Types
- Servicemix3 Server JVM Server
Autodiscovery Process Scans
Name | Query |
---|---|
${processScan.name} | process|basename|match=^java.*,arg|-Dservicemix.home|match=.* |
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Log Event Sources | The list of log files that can be tracked | yes | logEventSources |
Servicemix Home | Servicemix Server Home Directory | yes | servicemix.home |
Server Resource Key | Java system property that uniquely identifies this Server | yes | resourceKey |
Version File Pattern | File name with Server version | yes | versionFile |
Home Directory | System property for home directory | yes | homeProperty |
Log File | Log File to track | yes | logFile |
Connector Address | JMX Service URL | no | connectorAddress |
Principal | JMX login principal/username | no | principal |
Credentials | JMX 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
5.4. Container Service (Servicemix3)
Overview
Description: | Servicemix Container |
Singleton: | no |
Plugin: | Servicemix3 |
Parent Resource Types
Child Resource Types
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Container Name | Container Name | yes | containerName |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Name | Description |
---|---|
Start | Start a container. |
Stop | Stop a container. |
Shut Down | Shut down a container. |
Package Types
none
5.5. Component Service (Servicemix3)
Overview
Description: | Servicemix Component |
Singleton: | no |
Plugin: | Servicemix3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Stats Object Name | yes | statsObjectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Component Name | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Inbound Exchange Count | measurement | Count of inbound Exchanges | inboundExchangeCount |
Inbound Exchange Count per Minute | measurement | Count of inbound Exchanges | inboundExchangeCount |
Inbound Exchange Rate | measurement | Rate of inbound Exchanges per second | inboundExchangeRate |
Outbound Exchange Count | measurement | Count of outbound Exchanges | outboundExchangeCount |
Outbound Exchange Count per Minute | measurement | Count of outbound Exchanges | outboundExchangeCount |
Outbound Exchange Rate | measurement | Rate of outbound Exchanges per second | outboundExchangeRate |
Inbound Queue Size | measurement | Size of the inbound Queue | inboundQueueSize |
Inbound Queue Size per Minute | measurement | Size of the inbound Queue | inboundQueueSize |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Name | Description |
---|---|
Start | Start a component. |
Stop | Stop a component. |
Shut Down | Shut down a component. |
Package Types
none
5.6. Endpoint Service (Servicemix3)
Overview
Description: | Servicemix Endpoint |
Singleton: | no |
Plugin: | Servicemix3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Endpoint Name | yes | name |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Inbound Exchange Count | measurement | Count of inbound Exchanges | inboundExchangeCount |
Inbound Exchange Count per Minute | measurement | Count of inbound Exchanges | inboundExchangeCount |
Inbound Exchange Rate | measurement | Rate of inbound Exchanges per second | inboundExchangeRate |
Outbound Exchange Count | measurement | Count of outbound Exchanges | outboundExchangeCount |
Outbound Exchange Count per Minute | measurement | Count of outbound Exchanges | outboundExchangeCount |
Outbound Exchange Rate | measurement | Rate of outbound Exchanges per second | outboundExchangeRate |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
5.7. JBI Admin Commands Service (Servicemix3)
Overview
Description: | Servicemix JBI Admin Commands Service |
Singleton: | no |
Plugin: | Servicemix3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
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
none
Configuration Properties
none
Operations
Name | Description |
---|---|
Uninstall Component | Uninstall a component. |
List Components | List all installed components. |
Start Component | Start a component. |
Stop Component | Stop a component. |
Shutdown Component | Shut down a component. |
Install Shared Library | Install a shared library. |
Uninstall Shared Library | Uninstall a shared library. |
List Shared Libraries | List all installed shared libraries. |
Deploy Service Assembly | Deploy a service assembly. |
Undeploy Service Assembly | Undeploy a service assembly. |
Start Service Assembly | Start a service assembly. |
Stop Service Assembly | Stop a service assembly. |
Shutdown Service Assembly | Shut down a service assembly. |
List Service Assemblies | List all installed shared libraries. |
Package Types
none
5.8. Service Assembly Service (Servicemix3)
Overview
Description: | Servicemix Service Assembly |
Singleton: | no |
Plugin: | Servicemix3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Service Assembly 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
Name | Description |
---|---|
Start | Start the service assembly. |
Stop | Stop the service assembly. |
Shut Down | Shut down the service assembly. |
Package Types
none
5.9. Shared Library Service (Servicemix3)
Overview
Description: | Servicemix Shared Library |
Singleton: | no |
Plugin: | Servicemix3 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Shared Library 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
Chapter 6. Apache ServiceMix4 Managed Resources
6.1. Overview
Apache ServiceMix4 metrics are collected for JBoss ON managed ServiceMix 4.x Server platforms. Based on a resource's metrics, you can invoke Control Operations on the resource to avoid or correct throughput and performance problems.
6.2. Agent Metric Collectors
The main service entries, which collect the required metrics, are:
- ServiceMix4 Server
- Apache Karaf Admin
- Apache Karaf Features
- OSGi Compendium Configuration Management
- OSGi Compendium Permission Management
- OSGi Core Bundle State
- OSGi Core Framework
- OSGi Core Package State
- OSGi Core Service State
- ServiceMix4 Shared Library
- ServiceMix4 Component
- ServiceMix4 Service Assembly
- ServiceMix4 Endpoint
- ServiceMix4 JBI Admin Commands
Note
By default, Availability status is collected on all ServiceMix4 services. Only the ServiceMix4 OSGi Core FrameWork and Endponit services collect additional metrics.
6.3. Servicemix4 Server (Servicemix4)
Overview
Description: | Servicemix4 Server Process |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
- Managed Platforms
Child Resource Types
- Servicemix4 Server JVM Server
Autodiscovery Process Scans
Name | Query |
---|---|
${processScan.name} |
process|basename|match=^java.*,arg|-Dkaraf.home|match=.*,arg|
-Dkaraf.base|match=.*,arg|org.apache.karaf.main.Main|match=.*
|
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Log Event Sources | The list of log files that can be tracked | yes | logEventSources |
Servicemix Home | Servicemix Server Home Directory | yes | karaf.home |
Servicemix Base | Servicemix Server Base Directory | yes | karaf.base |
Server Resource Key | Java system property that uniquely identifies this Server | yes | resourceKey |
Version File Pattern | File name with Server version | yes | versionFile |
Home Directory | System property for home directory | yes | homeProperty |
Log File | Log File to track | yes | logFile |
Connector Address | JMX Service URL | no | connectorAddress |
Principal | JMX login principal/username | no | principal |
Credentials | JMX 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
6.4. Karaf Admin Service (Servicemix4)
Overview
Description: | Karaf Admin |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Karaf Container 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
Name | Description |
---|---|
Create Instance | Create a Karaf child instance. |
Destroy Instance | Destroy a Karaf child instance. |
Change Ssh Port | Change the SSH port of a Karaf child instance. |
Start Instance | Start a Karaf child instance. |
Stop Instance | Stop a Karaf child instance. |
Package Types
none
6.5. Karaf Features Service (Servicemix4)
Overview
Description: | Karaf Features |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Karaf Features 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
Name | Description |
---|---|
Add Repository | Add a feature repository. |
Uninstall Feature | Uninstall a feature. |
Install Feature | Install a feature. |
Remove Repository | Remove a feature repository. |
Package Types
none
6.6. Component Service (Servicemix4)
Overview
Description: | Servicemix Component |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Component 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
Name | Description |
---|---|
Start | Start a component. |
Stop | Stop a component. |
Shut Down | Shutdown a component. |
Package Types
none
6.7. Endpoint Service (Servicemix4)
Overview
Description: | Servicemix Endpoint |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Name | Endpoint Name | yes | Name |
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Id | Endpoint Id | yes | id |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Inbound Exchange Count | measurement | Count of inbound Exchanges | InboundExchangeCount |
Inbound Exchange Count per Minute | measurement | Count of inbound Exchanges | InboundExchangeCount |
Inbound Exchange Rate | measurement | Rate of inbound Exchanges per second | InboundExchangeRate |
Outbound Exchange Count | measurement | Count of outbound Exchanges | OutboundExchangeCount |
Outbound Exchange Count per Minute | measurement | Count of outbound Exchanges | OutboundExchangeCount |
Outbound Exchange Rate | measurement | Rate of outbound Exchanges per second | OutboundExchangeRate |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
6.8. JBI Admin Commands Service (Servicemix4)
Overview
Description: | Servicemix JBI Admin Commands Service |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
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
none
Configuration Properties
none
Operations
Name | Description |
---|---|
Uninstall Component | Uninstall a component. |
List Components | List all installed components. |
Start Component | Start a component. |
Stop Component | Stop a component. |
Shutdown Component | Shut down a component. |
Install Shared Library | Install a shared library. |
Uninstall Shared Library | Uninstall a shared library. |
List Shared Libraries | List all installed shared libraries. |
Deploy Service Assembly | Deploy a service assembly. |
Undeploy Service Assembly | Undeploy a service assembly. |
Start Service Assembly | Start a service assembly. |
Stop Service Assembly | Stop a service assembly. |
Shutdown Service Assembly | Shut down a service assembly. |
List Service Assemblies | List all installed service assemblies. |
Package Types
none
6.9. Service Assembly Service (Servicemix4)
Overview
Description: | Servicemix Service Assembly |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Service Assembly 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
Name | Description |
---|---|
Start | Start a service assembly. |
Stop | Stop a service assembly. |
Shut Down | Shut down a service assembly. |
Package Types
none
6.10. Shared Library Service (Servicemix4)
Overview
Description: | Servicemix Shared Library |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
Name | Shared Library Name | yes | name |
Version | Shared Library Version | yes | version |
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
6.11. Osgi Compendium Configuration Management Service (Servicemix4)
Overview
Description: | Osgi Compendium Configuration Management |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
OSGi Version | OSGi Service Version | yes | osgiVersion |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Name | Description |
---|---|
Delete | Delete configuration properties. |
Delete For Location | Delete configuration properties for location. |
Create Factory Configuration | Create a factory configuration. |
Create Factory Configuration For Location | Create a factory configuration for location. |
Get Factory Pid | Get a factory PID. |
Get Factory Pid For Location | Get the factory PID for location. |
Get Bundle Location | Get the location of a bundle. |
Set Bundle Location | Set the location of a bundle. |
Delete Configurations | Delete configurations. |
Package Types
none
6.12. Osgi Core Bundle State Service (Servicemix4)
Overview
Description: | Osgi Core Bundle State |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
OSGi Version | OSGi Service Version | yes | osgiVersion |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Name | Description |
---|---|
Get State | Get the state of a bundle. |
Get Last Modified | Get the date a bundle was last modified. |
Get Symbolic Name | Get the symbolic name of a bundle. |
Is Fragment | Discover whether a bundle is a fragment. |
Get Start Level | Get the start level of a bundle. |
Is Removal Pending | Discover whether removal of a bundle is pending. |
Is Required | Discover whether a bundle is required. |
Is Persistently Started | Discover whether a bundle is persistently started. |
Package Types
none
6.13. Osgi Core Framework Service (Servicemix4)
Overview
Description: | Osgi Core Framework |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
OSGi Version | OSGi Service Version | yes | osgiVersion |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
Name | Type | Description | Internal Name |
---|---|---|---|
Initial Bundle Start Level | trait | Feature Initial Bundle Start Level | InitialBundleStartLevel |
Framework Start Level | trait | Feature Framework Start Level | FrameworkStartLevel |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
Name | Description |
---|---|
Install Bundle | Install a bundle. |
Set Bundle Start Level | Set the start level of a bundle. |
Uninstall Bundle | Uninstall a bundle. |
Update Bundle | Update a bundle. |
Resolve Bundle | Resolve a bundle. |
Restart Framework | Restart the OSGi framework. |
Shutdown Framework | Shut down the OSGi framework. |
Start Bundle | Start a bundle. |
Stop Bundle | Stop a bundle. |
Update Framework | Update the OSGi framework. |
Package Types
none
6.14. Osgi Core Package State Service (Servicemix4)
Overview
Description: | Osgi Core Package State |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
OSGi Version | OSGi Service Version | yes | osgiVersion |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Name | Description |
---|---|
Is Removal Pending | Discover whether removal of a package is pending. |
Package Types
none
6.15. Osgi Core Service State Service (Servicemix4)
Overview
Description: | Osgi Core Service State |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
OSGi Version | OSGi Service Version | yes | osgiVersion |
Note
You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics
none
Configuration Properties
none
Operations
Name | Description |
---|---|
Get Bundle Identifier | Get the identifier of a bundle. |
Package Types
none
6.16. Osgi Compendium Permission Management Service (Servicemix4)
Overview
Description: | Osgi Compendium Permission Management |
Singleton: | no |
Plugin: | Servicemix4 |
Parent Resource Types
Child Resource Types
none
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Object Name | yes | objectName | |
Name Template | yes | nameTemplate | |
Description Template | yes | descriptionTemplate | |
OSGi Version | OSGi Service Version | yes | osgiVersion |
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
Chapter 7. JBoss Fuse Managed Resources
7.1. Overview
JBoss Fuse metrics are collected for Red Hat JBoss Fuse containers.
7.2. Agent Metric Collectors
The main service entry, which collects the required metrics, is JBoss Fuse Container.
7.3. 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
Name | Query |
---|---|
${processScan.name} |
process|basename|match=^java.*,arg|-Dkaraf.home|match=.*,arg|
-Dkaraf.base|match=.*,arg|org.apache.karaf.main.Main|match=.*
|
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Log Event Sources | The list of log files that can be tracked | yes | logEventSources |
JBoss Fuse Container Home | JBoss Fuse Container Home Directory | yes | karaf.home |
JBoss Fuse Container Base | JBoss Fuse Container Base Directory | yes | karaf.base |
Server Resource Key | Java system property that uniquely identifies this Server | yes | resourceKey |
Version File Pattern | File name with Server version | yes | versionFile |
Home Directory | System property for home directory | yes | homeProperty |
Log File | Log File to track | yes | logFile |
Connector Address | JMX Service URL | no | connectorAddress |
Principal | JMX login principal/username | no | principal |
Credentials | JMX login credentials/password | no | credentials |
Fabric Registry URL | URL to use to connect to the Fabric Registry, required for Fabric managed Containers | no | zookeeper.url |
Fabric Registry Password | Password to use to connect to the Fabric Registry | no | zookeeper.password |
Registry Timeout | Registry connection timeout in Seconds, used for Fabric metadata collection | yes | zookeeper.timeout |
JBoss Fuse Container Type | JBoss Fuse Container Type based on underlying product install | yes | container.type |
JBoss Fuse Container Name | JBoss Fuse 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
Name | Type | Description | Internal Name |
---|---|---|---|
JBoss Fuse Container Version | trait | JBoss Fuse Profile Version used by this Container | container.version |
JBoss Fuse Profiles | trait | JBoss Fuse Profiles referenced directly by this Container | profiles |
JBoss Fuse Parent Profiles | trait | JBoss Fuse parent Profiles indirectly referenced by this Container | parentProfiles |
MQ Clusters | trait | JBoss Fuse MQ Clusters where this Container exports ActiveMQ Connection Details | mqClusters |
Note
You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none
Chapter 8. Fabric Managed Resources
8.1. Overview
Fabric metrics are collected for fabrics deployed in Red Hat JBoss Fuse.
8.2. Agent Metric Collectors
The main service entry, which collects the required metrics, is Fabric Container.
8.3. 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
Name | Query |
---|---|
${processScan.name} |
process|basename|match=^java.*,arg|-Dkaraf.home|match=.*,arg|
-Dkaraf.base|match=.*,arg|org.apache.karaf.main.Main|match=.*
|
Connection Properties
Name | Description | Required | Internal Name |
---|---|---|---|
Log Event Sources | The list of log files that can be tracked | yes | logEventSources |
Fabric Container Home | Fabric Container Home Directory | yes | karaf.home |
Fabric Container Base | Fabric Container Base Directory | yes | karaf.base |
Server Resource Key | Java system property that uniquely identifies this Server | yes | resourceKey |
Version File Pattern | File name with Server version | yes | versionFile |
Home Directory | System property for home directory | yes | homeProperty |
Log File | Log File to track | yes | logFile |
Connector Address | JMX Service URL | no | connectorAddress |
Principal | JMX login principal/username | no | principal |
Credentials | JMX login credentials/password | no | credentials |
Fabric Registry URL | URL to use to connect to the Fabric Registry, required for Fabric managed Containers | no | zookeeper.url |
Fabric Registry Password | Password to use to connect to the Fabric Registry | no | zookeeper.password |
Registry Timeout | Registry connection timeout in Seconds, used for Fabric metadata collection | yes | zookeeper.timeout |
Fuse Container Type | Fuse Container Type based on underlying product install | yes | container.type |
Fabric Container Name | Fabric 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
Name | Type | Description | Internal Name |
---|---|---|---|
Fabric Container Version | trait | Fabric Profile Version used by this Container | container.version |
Fabric Profiles | trait | Fabric Profiles referenced directly by this Container | profiles |
Fabric Parent Profiles | trait | Fabric parent Profiles indirectly referenced by this Container | parentProfiles |
MQ Clusters | trait | Fabric MQ Clusters where this Container exports ActiveMQ Connection Details | mqClusters |
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.