Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# TIBCO BusinessEvents JMX Methods

TIBCO BusinessEvents supports JMX-based management and monitoring of deployed applications by using the Mbean methods that are exposed through JMX. You can use tools such as JConsole to view these exposed MBean methods.

Note: JMX and JConsole are available in the JDK and not in the JRE provided with TIBCO BusinessEvents. A separate installation of the JDK is required.

The provided Mbean methods and operations are as follows:

- `com.tibco.be > Methods > Channels`

  - GetChannels()

  - GetDestinations()

  - GetSessionInputDestinations()

  - ReconnectChannels()

  - ResumeDestinations()

  - SuspendDestinations()

- `com.tibco.be > Methods > Engine`

  - GetHostInformation()

  - GetLoggerNamesWithLevels()

  - GetMemoryUsage()

  - GetNumberOfEvents()

  - GetNumberOfInstances()

  - GetVersionInfo()

  - SetLogLevel()

  - StopEngine()

- `com.tibco.be > Methods > WorkingMemory`

  - ActivateRule()

  - DeactivateRule()

  - GetRule()

  - GetRules()

  - GetRuleSessions()

  - GetTotalNumberRulesFired()

  - ResetTotalNumberRulesFired()

## GetChannels()

Retrieves channel Information.

## Type

INFO

## Parameters

Name | Description
--- | ---
`URI` | URI of the channel (optional)

## Returns

Type | Description
--- | ---
`Line` | Row number.
`Channel URI` | URI of the channel.
`State` | Current state of the channel.

## GetDestinations()

Retrieves destination Information.

## Type

INFO

## Parameters

Name | Description
--- | ---
`Channel URI` | URI of the channel (optional)
`Destination Name` | Name of the destination (optional)

## Returns

Type | Description
--- | ---
`Line` | Row number
`Channel URI` | URI of the channel
`Destination URI` | URI of the destination
`Num Events Received` | Number of events received at the destination
`Received Events Rate` | Received events rate at the destination
`Num Events Sent` | Number of events sent out from the destination
`Received Events Rate in last stats interval` | Received events rate at the destination in last stats interval
`Suspended` | Is the destination suspended

## GetSessionInputDestinations()

Retrieves destinations enabled for input.

## Type

INFO

## Parameters

Name | Description
--- | ---
`Session` | Name of the session.

## Returns

Type | Description
--- | ---
`Line` | Row number.
`Destination` | Destination URI.
`Preprocessor` | Destination preprocessor URI.

## ReconnectChannels()

Restarts all channels or a single channel.

## Type

ACTION

## Parameters

Name | Description
--- | ---
`URI` | URI of the channel to restart (all channels are restarted if no URI is provided).

## Returns

Nothing.

## ResumeDestinations()

Resumes all destinations or a given destination.

## Type

ACTION

## Parameters

Name | Description
--- | ---
`Channel URI` | URI of the channel that contains the destination
`Destination Name` | Name of the destination (optional)

## Returns

Nothing.

## SuspendDestinations()

Suspends all destinations or a given destination.

## Type

ACTION

## Parameters

Name | Description
--- | ---
`Channel URI` | URI of the channel that contains the destination
`Destination Name` | Name of the destination (optional)

## Returns

Nothing.

## GetHostInformation()

Retrieves the host information properties.

## Type

INFO

## Parameters

Name | Description
--- | ---
`Name` | Name of the host information property that you want to retrieve (optional).

## Returns

Type | Description
--- | ---
`Name` | Property name
`Value` | Property value

## GetLoggerNamesWithLevels()

Retrieves the list of registered loggers with their current log level.

## Type

INFO

## Parameters

None

## Returns

A MAP of the registered logger names with their current log level.

## GetMemoryUsage()

Retrieves the engine memory usage information.

## Type

INFO

## Parameters

None.

## Returns

Type | Description
--- | ---
`Max` | Maximum memory size of the JVM in bytes.
`Free` | Estimate of the free memory available to the JVM in bytes.
`Used` | Estimate of the memory used in the JVM in bytes.
`PercentUsed` | Estimate of the percentage of memory used.

## GetNumberOfEvents()

Retrieves the total number of events existing in a session.

## Type

INFO

## Parameters

Name | Description
--- | ---
`Session` | Name of the session

## Returns

Type | Description
--- | ---
`Line` | Row number
`Session` | Name of the session
`Number of Events` | Total number of events

## GetNumberOfInstances()

Retrieves the total number of instances existing in a session.

## Type

INFO

## Parameters

Name | Description
--- | ---
`Session` | Name of the session

## Returns

Type | Description
--- | ---
`Line` | Row number
`Session` | Name of the session
`Number of Instances` | Total number of Instances

## GetVersionInfo()

Fetches the application name, version and TIBCO BusinessEvents engine version.

## Type

INFO

## Parameters

None.

## Returns

Type | Description
--- | ---
`Application Name` | Name of an application
`Application Version` | Version of an application
`Engine Version` | Version of the TIBCO BusinessEvents engine

## SetLogLevel()

Sets a specific log level for a specific logger. When setting the log level, the system runs through all the log level configurations and the last match supersedes all previous log level configurations. The wildcard character, an asterisk (*), can be used to select all or a pattern to match the logger names.

## Type

ACTION

## Parameters

Name | Description
--- | ---
`Name or Pattern` | Name of the logger or pattern to match the logger name
`Log Level` | Sets the log level to one of the following: FATAL, ERROR, WARN, INFO, DEBUG, ALL, or OFF

## Returns

Nothing.

## StopEngine()

Triggers the engine to shutdown.

## Type

ACTION

## Parameters

None

## Returns

Nothing

## ActivateRule()

Activates a RulesSet in a session.

## Type

ACTION

## Parameters

Name | Description
--- | ---
`Session` | Name of the session (optional)
`URI` | URI of the RulesSet

## Returns

Type | Description
--- | ---
`Session` | Name of the session
`URI` | URI of the RulesSet
`Activated` | Returns true if the RuleSet is activated.

## DeactivateRule()

Deactivates a RulesSet in a session.

## Type

ACTION

## Parameters

Name | Description
--- | ---
`Session` | Name of the session (optional)
`URI` | URI of the RulesSet

## Returns

Type | Description
--- | ---
`Session` | Name of the session
`URI` | URI of the rulesset
`Deactivated` | Returns true if the RuleSet is deactivated.

## GetRule()

Retrieves the rules of a given RulesSet.

## Type

INFO

## Parameters

Name | Description
--- | ---
`Session` | Name of the session
`URI` | URI of the RulesSet

## Returns

Type | Description
--- | ---
`Internal ID` | Internal ID number of the rule
`Priority` | Priority of the rule
`Line` | Row number
`Session` | Name of the session
`URI` | URI of the RuleSet

## GetRules()

Retrieves RulesRets from the session.

## Type

INFO

## Parameters

Name | Description
--- | ---
`Session` | Name of the session

## Returns

Type | Description
--- | ---
`Activated` | Is the RulesSet activated
`Line` | Row number
`Rule Fired Count` | Total number of rules fired in the RulesSet
`Session` | Name of the session
`URI` | URI of the RulesSet

## GetRuleSessions()

Fetches the rule session name(s) from the engine.

## Type

INFO

## Parameters

None.

## Returns

Type | Description
--- | ---
`Line` | Row number
`Session` | Name of the session

## GetTotalNumberRulesFired()

Retrieves the total number of rules fired.

## Type

INFO

## Parameters

Name | Description
--- | ---
`Session` | Name of the session

## Returns

Type | Description
--- | ---
`Line` | Row number.
`Session` | Name of the session.
`Number of Rules Fired` | Total number of rules fired since the last reset.

## ResetTotalNumberRulesFired()

Resets the total number of rules fired to zero.

## Type

ACTION

## Parameters

Name | Description
--- | ---
`Session` | Name of the session

## Returns

Nothing.

Did you find this helpful?

YesNo
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO BusinessEvents® Enterprise Edition

Copyright © 2004-2024. Cloud Software Group, Inc. All Rights Reserved.