Red Hat Training

A Red Hat training course is available for Red Hat Fuse

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