Package de.espirit.firstspirit.agency

Interface TrackingAgent

public interface TrackingAgent

Agent providing means to gather and collect statistical, timing and usage information. Track how often was something called, how long did a call take or was a code digit even run through. If a new feature is used or if the usage is decreasing

Note: Usage-Tracking is not Profiling or Tracing This also means - many calls per second or millisecond can affect the overall performance of the system.

Since:
5.2.200705

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final SpecialistType<TrackingAgent>
    TYPE
    Agent providing means to gather and collect statistical, timing and usage information.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    track(@NotNull UUID uuid, @NotNull String label, @NotNull String value, @Nullable String categoryName, @Nullable String explanation)
    Tracking of usages.
    void
    track(@NotNull UUID uuid, @NotNull String label, @Nullable String categoryName)
    Tracking of usages.

  • Field Details

    • TYPE

      static final SpecialistType<TrackingAgent> TYPE
      Agent providing means to gather and collect statistical, timing and usage information.
      Since:
      5.2.200705

  • Method Details

    • track

      void track(@NotNull @NotNull UUID uuid, @NotNull @NotNull String label, @Nullable @Nullable String categoryName) throws IllegalArgumentException
      Tracking of usages. Use this for simply counting usages of calls.
      *
      Note: Usage-Tracking is not Profiling or Tracing This also means - many calls per second or millisecond can affect the overall performance of the system.

      Usage: track(B07A3797-A265-43FC-BB86-97C2062D4D98, "1234", "com.mycompany.ModuleName-Preview")
      Parameters:
      uuid - the UUID
      label - an identifying label - a really identifying, meaningful label
      categoryName - use the same category name where necessary - useful to group by
      Throws:
      IllegalArgumentException - if @{UUID uuid} is invalid or any NotNull argument is null
      Since:
      5.2.200705

    • track

      void track(@NotNull @NotNull UUID uuid, @NotNull @NotNull String label, @NotNull @NotNull String value, @Nullable @Nullable String categoryName, @Nullable @Nullable String explanation) throws IllegalArgumentException
      Tracking of usages. Use this for simply counting usages of calls and track an additional value - for example a duration in milliseconds to visualize this in a graph.

      Note: Usage-Tracking is not Profiling or Tracing. This also means - many calls per second or millisecond can affect the overall performance of the system.

      Usage: track(B07A3797-A265-43FC-BB86-97C2062D4D98, "Preview time", "1234", "com.mycompany.ModuleName-Preview", "How long the preview generation takes. Includes not the browser rendering.")
      Parameters:
      uuid - the UUID
      label - an identifying label
      value - e.g. milliseconds
      categoryName - categoryName use the same category name where necessary - useful to group by
      explanation - extended meaningful description referred to the value
      Throws:
      IllegalArgumentException - if @{UUID uuid} is invalid or any NotNull argument is null
      Since:
      5.2.200705