Interface SourceInfo

All Known Implementing Classes:
NoSourceInfo, StackTraceSourceInfo

public interface SourceInfo
An interface that can be used to record the (runtime) source of registered metrics in the sdk.

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SourceInfo
    Constructs source information form the current stack.
    Returns a multi-line debugging string to report where a given metric was registered.
    static SourceInfo
    Returns a source info that asks the user to register information.
    Returns a debugging string to report where a given metric was registered.
  • Method Details

    • shortDebugString

      String shortDebugString()
      Returns a debugging string to report where a given metric was registered.

      Example: MyFile.java:15

    • multiLineDebugString

      String multiLineDebugString()
      Returns a multi-line debugging string to report where a given metric was registered.

      Example:

         at full.package.name.method MyFile.java:15
         at full.packae.name.otherMethod MyOtherFile.java:10
       
    • noSourceInfo

      static SourceInfo noSourceInfo()
      Returns a source info that asks the user to register information.
    • fromCurrentStack

      static SourceInfo fromCurrentStack()
      Constructs source information form the current stack.

      This will attempt to ignore SDK classes.