net.openhft.chronicle.analytics

Interface Analytics

public interface Analytics

Provides means for libraries to report analytics to an upstream receiver.

Analytics instances only provides a best-effort to propagate events to the upstream receiver.

Analytics can be turned off buy setting the system property "chronicle.analytics.disable=true" prior to acquiring any Analytics instances.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Analytics.Builder

Method Summary

Modifier and Type	Method and Description
static @NotNull Analytics.Builder	builder(@NotNull String measurementId, @NotNull String apiSecret) Creates and returns a new Builder that can be used to create an Analytic instance.
default void	sendEvent(@NotNull String name) Sends an event to Google Analytics as identified by the provided event name.
void	sendEvent(@NotNull String name, @NotNull Map<String,String> additionalEventParameters) Sends an event to Google Analytics as identified by the provided event name including the provided additionalEventParameters in the event.

Method Detail

sendEvent

default void sendEvent(@NotNull
                       @NotNull String name)

Sends an event to Google Analytics as identified by the provided event name.

Depending on settings and other conditions, the event may or may not be sent upstream. For example, some implementations may send a limited number of upstream events per time unit.

sendEvent

void sendEvent(@NotNull
               @NotNull String name,
               @NotNull
               @NotNull Map<String,String> additionalEventParameters)

Sends an event to Google Analytics as identified by the provided event name including the provided additionalEventParameters in the event.

Depending on settings and other conditions, the event may or may not be sent upstream. For example, some implementations may send a limited number of upstream events per time unit.

builder

@NotNull
static @NotNull Analytics.Builder builder(@NotNull
                                                   @NotNull String measurementId,
                                                   @NotNull
                                                   @NotNull String apiSecret)

Creates and returns a new Builder that can be used to create an Analytic instance.

The builder can only create one single Analytic instance.

Parameters:

measurementId - to use for reporting

apiSecret - to use for reporting

Returns:

a new Builder that can be used to create an Analytic instance