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

package com.tccc.kos.core.service.analytics
The analytics package provides the services, data structures, and extension points used to record, classify, and export analytics data in KOS. Analytics are structured data intended for business and operational insights.

Analytic events are objects that carry a type and data payload. By default, event data is serialized using the AnalyticsEvent.View JSON view, but developers may override the view to control which fields are included.

Events are recorded through the AnalyticsService. Once recorded, they are classified into channels by AnalyticsClassifier instances. Channels determine how events are exported. By default, all events are sent to AnalyticsServer.DEFAULT_CHANNEL, but custom classifiers can be added to copy subsets of events into different channels. Each channel is paired with an AnalyticsExporter that delivers the data to a destination such as a cloud service. Events can be given a priority of low, medium, or high, which controls how quickly the associated exporter is called. Every channel should have an associated exporter; otherwise, the channel will accumulate and purge data by size and date without the data ever being used.

On multi-node devices, analytics recorded on secondary nodes are transferred to the primary node. The primary node aggregates its own data with that from the secondaries, classifies the events into channels, and manages export through the configured exporters.

Since:
1.0
Version:
2022-10-21