Package com.atlassian.diagnostics.ipd.api

Interface IpdLoggingService

public interface IpdLoggingService
Service for logging IPD metrics.
Since:
2.2.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    forceLogMetric(IpdMeter meter, Instant timestamp)
    Logs the given meter with a the provided timestamp.
    void
    logMetric(IpdMeter meter)
    Logs the given meter with the current timestamp.
    void
    logMetric(IpdMeter meter, Instant timestamp)
    Logs the given meter with a the provided timestamp.

  • Method Details

    • logMetric

      void logMetric(IpdMeter meter)
      Logs the given meter with the current timestamp.
      Meter value is logged only if its configuration allows it. That is, if the meter is enabled, visible in JMX and the logging condition is met.
      Parameters:
      meter - the meter to log

    • logMetric

      void logMetric(IpdMeter meter, Instant timestamp)
      Logs the given meter with a the provided timestamp. Useful for logging manny meters with exactly the same timestamp.
      Meter value is logged only if its configuration allows it. That is, if the meter is enabled, visible in JMX and the logging condition is met.
      Parameters:
      meter - the meter to log

    • forceLogMetric

      void forceLogMetric(IpdMeter meter, Instant timestamp)
      Logs the given meter with a the provided timestamp. Useful for logging manny meters with exactly the same timestamp.
      Meter is unconditionally logged, regardless of its configuration.
      Parameters:
      meter - the meter to log
      Since:
      5.0.0