Interface Timers


  • public interface Timers
    Timers measure the amount of time an operation took to complete, in milliseconds.
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void recordExecutionTime​(java.lang.String bucket, long timeInMs)
      Records an execution time in milliseconds for the specified named operation.
      void recordExecutionTime​(java.lang.String bucket, long timeInMs, double sampleRate)
      Records an execution time in milliseconds for the specified named operation.
      void recordExecutionTime​(java.lang.String bucket, long timeInMs, double sampleRate, java.util.Map<java.lang.String,​java.lang.String> tags)
      Records an execution time in milliseconds for the specified named operation.
      void recordExecutionTime​(java.lang.String bucket, long timeInMs, java.util.Map<java.lang.String,​java.lang.String> tags)
      Records an execution time in milliseconds for the specified named operation.
      default void time​(java.lang.String bucket, long timeInMs)
      Convenience method equivalent to recordExecutionTime(String, long).
      default void time​(java.lang.String bucket, long timeInMs, double sampleRate)
      Convenience method equivalent to recordExecutionTime(String, long, double).
      default void time​(java.lang.String bucket, long timeInMs, double sampleRate, java.util.Map<java.lang.String,​java.lang.String> tags)
      Convenience method equivalent to recordExecutionTime(String, long, double, Map).
      default void time​(java.lang.String bucket, long timeInMs, java.util.Map<java.lang.String,​java.lang.String> tags)
      Convenience method equivalent to recordExecutionTime(String, long, Map).
    • Method Detail

      • recordExecutionTime

        void recordExecutionTime​(java.lang.String bucket,
                                 long timeInMs)
        Records an execution time in milliseconds for the specified named operation.
        Parameters:
        bucket - name of the timed operation
        timeInMs - time in milliseconds
      • recordExecutionTime

        void recordExecutionTime​(java.lang.String bucket,
                                 long timeInMs,
                                 double sampleRate)
        Records an execution time in milliseconds for the specified named operation.
        Parameters:
        bucket - name of the timed operation
        timeInMs - time in milliseconds
        sampleRate - percentage of time metric to be sent
      • recordExecutionTime

        void recordExecutionTime​(java.lang.String bucket,
                                 long timeInMs,
                                 java.util.Map<java.lang.String,​java.lang.String> tags)
        Records an execution time in milliseconds for the specified named operation.
        Parameters:
        bucket - name of the timed operation
        timeInMs - time in milliseconds
        tags - map of tags to be added to the data
      • recordExecutionTime

        void recordExecutionTime​(java.lang.String bucket,
                                 long timeInMs,
                                 double sampleRate,
                                 java.util.Map<java.lang.String,​java.lang.String> tags)
        Records an execution time in milliseconds for the specified named operation.
        Parameters:
        bucket - name of the timed operation
        timeInMs - time in milliseconds
        sampleRate - percentage of time metric to be sent
        tags - map of tags to be added to the data
      • time

        default void time​(java.lang.String bucket,
                          long timeInMs)
        Convenience method equivalent to recordExecutionTime(String, long). Records an execution time in milliseconds for the specified named operation.
        Parameters:
        bucket - name of the timed operation
        timeInMs - time in milliseconds
      • time

        default void time​(java.lang.String bucket,
                          long timeInMs,
                          double sampleRate)
        Convenience method equivalent to recordExecutionTime(String, long, double). Records an execution time in milliseconds for the specified named operation.
        Parameters:
        bucket - name of the timed operation
        timeInMs - time in milliseconds
        sampleRate - percentage of time metric to be sent
      • time

        default void time​(java.lang.String bucket,
                          long timeInMs,
                          java.util.Map<java.lang.String,​java.lang.String> tags)
        Convenience method equivalent to recordExecutionTime(String, long, Map). Records an execution time in milliseconds for the specified named operation.
        Parameters:
        bucket - name of the timed operation
        timeInMs - time in milliseconds
        tags - map of tags to be added to the data
      • time

        default void time​(java.lang.String bucket,
                          long timeInMs,
                          double sampleRate,
                          java.util.Map<java.lang.String,​java.lang.String> tags)
        Convenience method equivalent to recordExecutionTime(String, long, double, Map). Records an execution time in milliseconds for the specified named operation.
        Parameters:
        bucket - name of the timed operation
        timeInMs - time in milliseconds
        sampleRate - percentage of time metric to be sent
        tags - map of tags to be added to the data