To inspect a limiter, use the following rhino-console command or related MBean operations.

On this page...

Console command

getlimiterinfo

Command

 
getlimiterinfo <limitername> [-c]
   Displays the current configuration settings of the specified limiter.
   If the -c flag is provided, all stored default and per node settings for the limiter are listed.
   Otherwise the current configuration of all event routing nodes (as derived from the stored settings) is listed.
Note

The first variant of this command, using the -c flag (or the LimiterMBean.getConfigSummary method) displays all configuration properties stored for the limiter.

The second variant, without the -c flag (or the LimiterMBean.getInfoSummarymethod) displays the effective configuration for the limiter as derived from the stored configuration properties. This variant of the command lists information for all event-routing nodes, whereas the MBean method lets you specify which nodes you’re interested in. (You can get a list of all event-routing nodes from RhinoHousekeepingMBean.getEventRouterNodes()).

Examples

To view all configuration properties stored for a limiter SystemInput:

$ ./rhino-console getlimiterinfo SystemInput -c
limiter-name   node-id    bypassed   depth   maxrate   parent            time-unit   type
-------------  ---------  ---------  ------  --------  ----------------  ----------  -----
  SystemInput   defaults       true     1.0       0.0   QueueSaturation     SECONDS   RATE
          n/a        101      false       *     100.0               n/a         n/a    n/a
2 rows

'*' means no value set
'n/a' means setting not configurable per node

NOTE: Ramp up of SystemInput limiter is currently disabled

To view the effective configuration for limiter SystemInput, as derived from the stored configuration properties:

$ ./rhino-console getlimiterinfo SystemInput
limiter-name   node-id   bypassed   depth   maxrate   parent            time-unit   type
-------------  --------  ---------  ------  --------  ----------------  ----------  -----
  SystemInput       101      false     1.0     100.0   QueueSaturation     SECONDS   RATE
1 rows

'*' means no value set


NOTE: Ramp up of SystemInput limiter is currently disabled

MBean operations

Limiter MBean operations

Operation Usage

getConfigSummary

 
TabularData getConfigSummary();

getInfoSummary

 
TabularData getInfoSummary(int[] nodeIDs)
      throws NullPointerException, ConfigurationException, InvalidArgumentException;

getChildLimiters

 
String[] getChildLimiters()
      throws ConfigurationException;

getConnectedEndPoints

 
String[] getConnectedEndPoints()
      throws ConfigurationException;

getName

 
String getName()
      throws ConfigurationException;

getParent

 
String getParent()
      throws ConfigurationException;

getType

 
String getType()
      throws ConfigurationException;

isBypassedDefault

 
boolean isBypassedDefault()
      throws ConfigurationException;

isBypassedForNode

 
boolean[] isBypassedForNode(int[] nodeIDs)
      throws NullPointerException, ConfigurationException, InvalidArgumentException;

RateLimiter MBean operations

Operation Usage

getDepthDefault

 
double getDepthDefault()
      throws ConfigurationException;

getDepthForNode

 
double[] getDepthForNode(int[] nodeIDs)
      throws ConfigurationException, NullPointerException, InvalidArgumentException;

getMaxRateDefault

 
double getMaxRateDefault()
      throws ConfigurationException;

getMaxRateForNode

 
double[] getMaxRateForNode(int[] nodeIDs)
      throws ConfigurationException, NullPointerException, InvalidArgumentException;

getTimeUnit

 
double getTimeUnit()
      throws ConfigurationException;

SaturationLimiter MBean operations

Operation Usage

getMaxSaturationDefault

 
double getMaxSaturationDefault()
      throws ConfigurationException;

getMaxSaturationForNode

 
double[] getMaxSaturationForNode(int[] nodeIDs)
      throws ConfigurationException, NullPointerException, InvalidArgumentException;
Previous page Next page
Rhino Version 2.5.0