Package wt.servlet

Interface RequestHistogrammerMBean

All Superinterfaces:
SelfEmailingMBean
All Known Implementing Classes:
RequestHistogrammer
public interface RequestHistogrammerMBean extends SelfEmailingMBean
Produce histogram statistics for servlet requests.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addURIGroupingExpression(int index, String uriGroupingExpression)
    Add to URIGroupingExpressions list; see URIGroupingExpressions for more information

    Supported API: true
    void
    addURIGroupingExpression(String uriGroupingExpression)
    Add to URIGroupingExpressions list; see URIGroupingExpressions for more information

    Supported API: true
    int
    getAutoResetIntervalSeconds()
    Interval (in seconds) between automatic calls to resetData() operation

    Supported API: true
    CompositeData
    getData()
    Histogram data for servlet requests as structured CompositeData

    Supported API: true
    String[]
    getDataAsStrings()
    Histogram data for servlet requests as array of strings

    Supported API: true
    String
    getLoggerName()
    Name of logger this MBean uses for normal logging of data and errors; data output to this logger is controlled by the LogOnReset attribute

    Supported API: true
    String
    getName()
    Name of this MBean

    Supported API: true
    String
    getStructuredDataLoggerName()
    Name of logger this MBean uses for structured data logging; structured data logging is only performed when the verbosity level of this logger is at least INFO
    String[]
    getURIGroupingExpressions()
    Regular expressions under which requests with matching context relative URIs are grouped; expressions containing "/?" are matched against the context relative request URL instead

    Supported API: true
    boolean
    isLogOnReset()
    Whether data is logged (to logger indicated by LoggerName attribute) on invocations of resetData() operation

    Supported API: true
    void
    removeURIGroupingExpression(String uriGroupingExpression)
    Remove entry from URIGroupingExpressions list; see URIGroupingExpressions for more information

    Supported API: true
    void
    resetData()
    Reset collected data, starting aggregation of data afresh.
    void
    setAutoResetIntervalSeconds(int autoResetIntervalSeconds)
    Interval (in seconds) between automatic calls to resetData() operation

    Supported API: true
    void
    setLogOnReset(boolean logOnReset)
    Whether data is logged (to logger indicated by LoggerName attribute) on invocations of resetData() operation

    Supported API: true

    Methods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean

    emailThisMBean

  • Method Details

    • getName

      String getName()
      Name of this MBean

      Supported API: true

    • getAutoResetIntervalSeconds

      int getAutoResetIntervalSeconds()
      Interval (in seconds) between automatic calls to resetData() operation

      Supported API: true

    • setAutoResetIntervalSeconds

      void setAutoResetIntervalSeconds(int autoResetIntervalSeconds)
      Interval (in seconds) between automatic calls to resetData() operation

      Supported API: true

    • isLogOnReset

      boolean isLogOnReset()
      Whether data is logged (to logger indicated by LoggerName attribute) on invocations of resetData() operation

      Supported API: true

    • setLogOnReset

      void setLogOnReset(boolean logOnReset)
      Whether data is logged (to logger indicated by LoggerName attribute) on invocations of resetData() operation

      Supported API: true

    • getLoggerName

      String getLoggerName()
      Name of logger this MBean uses for normal logging of data and errors; data output to this logger is controlled by the LogOnReset attribute

      Supported API: true

    • getStructuredDataLoggerName

      String getStructuredDataLoggerName()
      Name of logger this MBean uses for structured data logging; structured data logging is only performed when the verbosity level of this logger is at least INFO

      For use by advanced log4j appenders and layouts like AsyncJDBCAppender and TSVLayout.

      Supported API: true

    • getData

      CompositeData getData() throws OpenDataException
      Histogram data for servlet requests as structured CompositeData

      Supported API: true
      Throws:
      OpenDataException

    • getDataAsStrings

      String[] getDataAsStrings()
      Histogram data for servlet requests as array of strings

      Supported API: true

    • getURIGroupingExpressions

      String[] getURIGroupingExpressions()
      Regular expressions under which requests with matching context relative URIs are grouped; expressions containing "/?" are matched against the context relative request URL instead

      Supported API: true

    • addURIGroupingExpression

      @MBeanOperationImpact(1) void addURIGroupingExpression(String uriGroupingExpression)
      Add to URIGroupingExpressions list; see URIGroupingExpressions for more information

      Supported API: true
      Parameters:
      uriGroupingExpression - Regular expression to add to URIGroupingExpressions attribute

    • addURIGroupingExpression

      @MBeanOperationImpact(1) void addURIGroupingExpression(int index, String uriGroupingExpression)
      Add to URIGroupingExpressions list; see URIGroupingExpressions for more information

      Supported API: true
      Parameters:
      index - Zero-based index at which the regular expression is to be inserted
      uriGroupingExpression - Regular expression to add to URIGroupingExpressions attribute

    • removeURIGroupingExpression

      @MBeanOperationImpact(1) void removeURIGroupingExpression(String uriGroupingExpression)
      Remove entry from URIGroupingExpressions list; see URIGroupingExpressions for more information

      Supported API: true
      Parameters:
      uriGroupingExpression - Regular expression to remove from URIGroupingExpressions attribute

    • resetData

      @MBeanOperationImpact(1) void resetData()
      Reset collected data, starting aggregation of data afresh. Logs data collected to this point when LogOnReset is true.

      Supported API: true