Package io.micrometer.observation

Interface Observation.Scope

All Superinterfaces:
AutoCloseable
Enclosing interface:
Observation
public static interface Observation.Scope extends AutoCloseable
Scope represent an action within which certain resources (e.g. tracing context) are put in scope (e.g. in a ThreadLocal). When the scope is closed the resources will be removed from the scope.
Since:
1.10.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Observation.Scope
    NOOP
    No-op scope.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    Clears the current scope and notifies the handlers that the scope was closed.
    Observation
    getCurrentObservation()
    Current observation available within this scope.
    default boolean
    isNoop()
    Checks whether this Observation.Scope is no-op.
    void
    reset()
    Clears the current scope and notifies the handlers that the scope was reset.

  • Field Details

  • Method Details

    • getCurrentObservation

      Observation getCurrentObservation()
      Current observation available within this scope.
      Returns:
      current observation that this scope was created by

    • close

      void close()
      Clears the current scope and notifies the handlers that the scope was closed. You don't need to call this method manually. If you use try-with-resource, it will call this for you. Please only call this method if you know what you are doing and your use-case demands the usage of it.
      Specified by:
      close in interface AutoCloseable

    • reset

      void reset()
      Clears the current scope and notifies the handlers that the scope was reset. You don't need to call this method in most of the cases. Please only call this method if you know what you are doing and your use-case demands the usage of it.
      Since:
      1.10.4

    • isNoop

      default boolean isNoop()
      Checks whether this Observation.Scope is no-op.
      Returns:
      true when this is a no-op scope