net.openhft.chronicle.core.analytics

Interface AnalyticsFacade

public interface AnalyticsFacade

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 by 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	AnalyticsFacade.Builder

Method Summary

Modifier and Type	Method and Description
static @NotNull AnalyticsFacade.Builder	builder(@NotNull String measurementId, @NotNull String apiSecret) Creates and returns a new empty Builder that can be used to create an Analytic instance.
static boolean	isEnabled() Returns if Analytics is enabled.
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.
static Map<String,String>	standardAdditionalProperties() Creates and returns a new map of standard user properties.
static @NotNull AnalyticsFacade.Builder	standardBuilder(@NotNull String measurementId, @NotNull String apiSecret, @NotNull String appVersion) Creates and returns a new Builder that can be used to create an Analytic instance with standard Chronicle settings including pre-configuration as per standardEventParameters(String) and standardUserProperties().
static @NotNull Map<String,String>	standardEventParameters(@NotNull String appVersion) Creates and returns a new map of standard event parameters.
static @NotNull Map<String,String>	standardUserProperties() Creates and returns a new map of standard user properties.

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.

isEnabled

static boolean isEnabled()

Returns if Analytics is enabled.

Returns:

if Analytics is enabled

builder

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

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

The builder can only create one single Analytic instance.

If isEnabled() returns false, then a NOP builder is returned.

Parameters:

measurementId - to use for reporting

apiSecret - to use for reporting

Returns:

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

standardBuilder

@NotNull
static @NotNull AnalyticsFacade.Builder standardBuilder(@NotNull
                                                                 @NotNull String measurementId,
                                                                 @NotNull
                                                                 @NotNull String apiSecret,
                                                                 @NotNull
                                                                 @NotNull String appVersion)

Creates and returns a new Builder that can be used to create an Analytic instance with standard Chronicle settings including pre-configuration as per standardEventParameters(String) and standardUserProperties().

The builder can only create one single Analytic instance.

Parameters:

measurementId - to use for reporting

apiSecret - to use for reporting

appVersion - to add to the event parameters

Returns:

a new Builder that can be used to create an Analytic instance with standard Chronicle settings including pre-configuration as per standardEventParameters(String) and standardUserProperties()

See Also:

(), standardUserProperties()

standardEventParameters

@NotNull
static @NotNull Map<String,String> standardEventParameters(@NotNull
                                                                    @NotNull String appVersion)

Creates and returns a new map of standard event parameters. The map may contain properties like:

• app_version

Parameters:

appVersion - to include in the map

Returns:

a new map of standard event parameters

standardUserProperties

@NotNull
static @NotNull Map<String,String> standardUserProperties()

Creates and returns a new map of standard user properties.

The map may contain properties like:

• java_runtime_name
• java_runtime_version
• os_name
• os_arch
• os_version
• timezone_default
• available_processors
• max_memory_gib
• java_major_version
• max_direct_memory_gib

Returns:

a new map of standard user properties

standardAdditionalProperties

static Map<String,String> standardAdditionalProperties()

Creates and returns a new map of standard user properties.

The map may contain package names.