TIBCO Hawk Microagent Methods
TIBCO BusinessEvents Monitoring and Management component is the preferred way to deploy, monitor, and manage TIBCO BusinessEvents applications.
You can also use TIBCO Administrator for deployment and for many monitoring and management functions. To augment the monitoring and management functions in TIBCO Administrator, the TIBCO BusinessEvents engine is instrumented with a TIBCO Hawk microagent that can be used to perform many administrative functions.
The provided methods have the following purpose:
- To enable TIBCO Administrator to perform certain actions, for example, GetExecInfo(), stopApplicationInstance(), getHostInformation()
- To provide information about what is happening in the TIBCO BusinessEvents engine, for example, getRules(), getDestinations(), getTotalNumberRulesFired()
- To make certain changes in the TIBCO BusinessEvents engine without stopping it, for example, activateRule(), reconnectChannels().
TIBCO BusinessEvents embeds a TIBCO Hawk microagent whose methods enable you to monitor and manage deployed TIBCO BusinessEvents applications. You can use TIBCO Hawk or the Hawk Console in TIBCO Administrator.
For more information, see:
- TIBCO Administrator Server Configuration Guide has more details on working with microagents and methods using TIBCO Administrator.
- TIBCO Hawk Methods Reference provides detailed documentation about TIBCO Hawk microagents and methods.
The provided methods are:
- activateRule()
- deactivateRule()
- execute()
- getChannels()
- getCacheRecoveryInfo()
- getDestinations()
- getEvent()
- GetExecInfo()
- getHostInformation()
- getInstance()
- getJoinTable
- GetLoggerNamesWithLevels()
- getMemoryUsage()
- getNumberOfEvents()
- getNumberOfInstances()
- getOMInfo()
- getRule()
- getRules()
- getScorecard()
- getScorecards()
- getSessionInputDestinations()
- getSessions()
- getStatus()
- getTotalNumberRulesFired()
- getTraceSinks()
- reconnectChannels()
- resetTotalNumberRulesFired()
- resumeChannels()
- resumeDestinations()
- resumeRuleServiceProvider()
- setLogLevel()
- startFileBasedProfiler()
- stopFileBasedProfiler()
- suspendRuleServiceProvider ()
- Enabling the TIBCO Hawk Microagent
Before using Hawk methods, enable the TIBCO Hawk microagent in the TIBCO BusinessEvents engine property file BE_HOME/bin/be-engine.tra. - activateRule()
Activate a RuleSet in the Session. - deactivateRule()
Deactivate a RuleSet in the Session - execute()
Runs a special command. - getChannels()
Retrieves Channel Info. - getCacheRecoveryInfo()
Gets the Cache recovery information. - getDestinations()
Retrieves Destination Info. - getEvent()
Retrieves an Event from a Session. - GetExecInfo()
Gets engine execution information - getHostInformation()
Gets host information properties. - getInstance()
Retrieves an Instance from the Session. - getJoinTable
Retrieves a join table from the Session(s). - GetLoggerNamesWithLevels()
Gets the list of registered loggers with their current log level. - getMemoryUsage()
Gets engine memory usage information. - getNumberOfEvents()
Gets the total number of events existing in a Session. - getNumberOfInstances()
Gets the total number of instances existing in a Session. - getOMInfo()
Retrieves Object Store information of a Session. - getRule()
Retrieves the Rules of a given RuleSet. - getRules()
Retrieves Rulesets from the Session. - getScorecard()
Retrieves a Scorecard of a Session. - getScorecards()
Retrieves all the Scorecards of a Session. - getSessionInputDestinations()
Retrieves destinations enabled for input. - getSessions()
Retrieves session names. - getStatus()
Retrieves basic status information about the engine. - getTotalNumberRulesFired()
Retrieves the total number of rules fired. - getTraceSinks()
Gets information about trace sinks. - reconnectChannels()
Restarts all channels or a single channel. - resetTotalNumberRulesFired()
Resets the total number of rules fired to zero. - resumeChannels()
Resumes channels. - resumeDestinations()
Resumes Destinations. - resumeRuleServiceProvider()
Resumes the RuleServiceProvider. - setLogLevel()
Sets a specific logger to a specific log level. 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. - SetLogLevel(Stringnameorpattern String Level)
This API can be used to set a specific logger to a specific level, such as SetLogLevel("as.kit", "debug") will set "as.kit" to debug where as SetLogLevel("as*", "debug") will set all loggers starting with "as" to debug. - startFileBasedProfiler()
Turns on BusinessEvents Profiler and starts collecting data for a specified duration. - stopApplicationInstance()
Shuts down the engine. All checkpoint files will be preserved and the engine’s operating system process will exit. - stopFileBasedProfiler()
Turns off the BusinessEvents Profiler and writes the profile data into a file specified when the Profiler was turned on. - suspendChannels()
Suspends channels. - suspendDestinations()
Suspends Destinations. - suspendRuleServiceProvider ()
Suspends the RleServiceProvider.