com.atakmap.android.metrics

Class MetricsApi

java.lang.Object

com.atakmap.android.metrics.MetricsApi

public class MetricsApi
extends java.lang.Object

Simple interface for tools and plugins to log metrics records. Implementation for metrics collection and handling should be done as a plugin so that it not adversely effect system performance.

Constructor Summary

Constructors

Constructor and Description
MetricsApi()

Method Summary

Modifier and Type	Method and Description
static void	init(LocalBroadcastManager lbm) Must be called only once by the AtakBroadcast class.
static void	record(android.content.Intent intent) Used to record an nonnull intent event.
static void	record(java.lang.String category, android.os.Bundle b) Used to record a category and a bundle, this call will pass the bundle onto passive listeners that implement the MetricApi.METRIC_INTENT broadcast receiver.
static void	register(android.content.BroadcastReceiver receiver) Call to register a BroadcastReceiver that will obtain metric information.
static boolean	shouldRecordMetric() Should be called prior to calling record metric in order to make sure that the recording will be used.
static void	unregister(android.content.BroadcastReceiver receiver) Call to unregister a BroadcastReceiver that will obtain metric information.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsApi

public MetricsApi()

Method Detail

init

public static void init(LocalBroadcastManager lbm)

Must be called only once by the AtakBroadcast class. Prevent future reinitialization.

Parameters:

lbm - the local broadcast manager in use by the metrics api.

register

public static void register(android.content.BroadcastReceiver receiver)

Call to register a BroadcastReceiver that will obtain metric information.

unregister

public static void unregister(android.content.BroadcastReceiver receiver)

Call to unregister a BroadcastReceiver that will obtain metric information.

shouldRecordMetric

public static boolean shouldRecordMetric()

Should be called prior to calling record metric in order to make sure that the recording will be used.

record

public static void record(android.content.Intent intent)

Used to record an nonnull intent event. This call will accurately capture all attributes related to the intent and pass them onto passive listeners that implement MetricApi.METRIC_INTENT broadcast receiver.

Parameters:

intent - either a local or system intent.

record

public static void record(java.lang.String category,
                          android.os.Bundle b)

Used to record a category and a bundle, this call will pass the bundle onto passive listeners that implement the MetricApi.METRIC_INTENT broadcast receiver.

Parameters:

category - is the category used to bin the bundle

b - the name value pairs passed in as a bundle