Package com.tccc.kos.core.service.analytics

Interface AnalyticsService

public interface AnalyticsService
Interface for the analytics service which is used to record analytic events for classification and exporting off device. In a multi-node device, the implementation of this service differs in the following way:
  • secondary nodes: Records analytic events and periodically transfers them to the server running on the primary node. AnalyticsClient has configuration settings related to how this transfer takes place.
  • primary node: Records analytic events from all nodes in the device. Events are split into channels using user provided classifiers and channel data is exported via user provided exporters. Classifiers and exporters are managed using AnalyticeServer.
While this interface can be autowired like any service, it may also be accessed using the KosCore.getAnalytics() static accessor. This avoids the need to inject this interface in difficult to reach code paths that want to record events.
Since:
1.0
Version:
2024-03-12

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    record(AnalyticsEvent event)
    Record an analytics event.
    default void
    record(AnalyticsPriority priority, String type, Object data, Class<?> view)
    Record an analytics event with the specified settings.
    void
    recordAsync(AnalyticsEvent event)
    Record an analytics event by putting it into a queue so that a background thread can perform data serialization and database writes decoupled from the calling thread.
    default void
    recordAsync(AnalyticsPriority priority, String type, Object data, Class<?> view)
    Asynchronously record an analytics event with the specified settings.
    default void
    recordHigh(String type, Object data)
    Record an analytics event with HIGH priority and default AnalyticsEvent.View json view to serialize data.
    default void
    recordHigh(String type, Object data, Class<?> view)
    Record an analytics event with HIGH priority
    default void
    recordLow(String type, Object data)
    Record an analytics event with LOW priority and default AnalyticsEvent.View json view to serialize data.
    default void
    recordLow(String type, Object data, Class<?> view)
    Record an analytics event with LOW priority
    default void
    recordMedium(String type, Object data)
    Record an analytics event with MEDIUM priority and default AnalyiticsEvent.View json view to serialize data.
    default void
    recordMedium(String type, Object data, Class<?> view)
    Record an analytics event with MEDIUM priority

  • Method Details

    • record

      void record(AnalyticsEvent event)
      Record an analytics event. This will perform all event processing in the calling thread. Normally this is nominal overhead, but for particularly time sensitive use cases use recordAsync() which queues the event to be recorded by a background thread.
      Parameters:
      event - the event to record

    • recordAsync

      void recordAsync(AnalyticsEvent event)
      Record an analytics event by putting it into a queue so that a background thread can perform data serialization and database writes decoupled from the calling thread. Care should be taken when providing live data as it can change between the call to queue the data and when the background thread serializes it. This method is intended for low latency code paths.
      Parameters:
      event - the event to record

    • record

      default void record(AnalyticsPriority priority, String type, Object data, Class<?> view)
      Record an analytics event with the specified settings.
      Parameters:
      priority - priority of the event
      type - event type
      data - data for the event
      view - json view class for data serialization

    • recordAsync

      default void recordAsync(AnalyticsPriority priority, String type, Object data, Class<?> view)
      Asynchronously record an analytics event with the specified settings.
      Parameters:
      priority - priority of the event
      type - event type
      data - data for the event
      view - json view class for data serialization

    • recordHigh

      default void recordHigh(String type, Object data, Class<?> view)
      Record an analytics event with HIGH priority
      Parameters:
      type - event type
      data - data for the event
      view - json view class for data serialization

    • recordHigh

      default void recordHigh(String type, Object data)
      Record an analytics event with HIGH priority and default AnalyticsEvent.View json view to serialize data.
      Parameters:
      type - event type
      data - data for the event

    • recordMedium

      default void recordMedium(String type, Object data, Class<?> view)
      Record an analytics event with MEDIUM priority
      Parameters:
      type - event type
      data - data for the event
      view - json view class for data serialization

    • recordMedium

      default void recordMedium(String type, Object data)
      Record an analytics event with MEDIUM priority and default AnalyiticsEvent.View json view to serialize data.
      Parameters:
      type - event type
      data - data for the event

    • recordLow

      default void recordLow(String type, Object data, Class<?> view)
      Record an analytics event with LOW priority
      Parameters:
      type - event type
      data - data for the event
      view - json view class for data serialization

    • recordLow

      default void recordLow(String type, Object data)
      Record an analytics event with LOW priority and default AnalyticsEvent.View json view to serialize data.
      Parameters:
      type - event type
      data - data for the event