Package com.atlassian.jira.monitoring.jmx

Interface JmxMetricsExposer

All Known Implementing Classes:
JmxMetricsExposerImpl
@PublicApi public interface JmxMetricsExposer
Exposes metrics to JMX; usually about the state of the Jira instance, the environment being run within, and the larger system (e.g DB connection, Tomcat thread pool).
Since:
7.6

  • Method Details

    • startExposing

      void startExposing()
      Collects currently available metrics and exposes them through JMX. Generates an analytics event.

    • stopExposing

      void stopExposing()
      Unregisters currently registered metrics from JMX. Generates an analytics event.

    • publishRefreshMessage

      void publishRefreshMessage()
      Publishes a cluster-wide message to refresh JMX state. This method should be called if it is desired to start or stop exposing metrics in other nodes.

    • getExposedMetricNames

      List<String> getExposedMetricNames()
      Returns:
      List of currently available metrics.

    • isJmxEnabled

      boolean isJmxEnabled()
      Returns:
      boolean True if currently available metrics are registered to JMX, false otherwise.

    • init

      void init()
      Initializes the service.