-
- All Implemented Interfaces:
-
backtraceio.library.interfaces.Metrics
public final class BacktraceMetrics implements Metrics
-
-
Field Summary
Fields Modifier and Type Field Description public final static int
defaultTimeIntervalInMin
public final static long
defaultTimeIntervalMs
public final static int
maxNumberOfAttempts
public final static int
defaultTimeBetweenRetriesMs
public final static int
maxTimeBetweenRetriesMs
public final static String
defaultBaseUrl
public final String
defaultUniqueEventName
public UniqueEventsHandler
uniqueEventsHandler
public SummedEventsHandler
summedEventsHandler
private final Context
context
private String
startupUniqueEventName
private int
maximumNumberOfEvents
-
Constructor Summary
Constructors Constructor Description BacktraceMetrics(Context context, Map<String, Object> customReportAttributes, Api backtraceApi, BacktraceCredentials credentials)
Create new Backtrace metrics instance
-
Method Summary
Modifier and Type Method Description Context
getContext()
void
setStartupUniqueEventName(String startupUniqueEventName)
void
setMaximumNumberOfEvents(int maximumNumberOfEvents)
Set the maximum number of events to store. void
enable()
Enables metrics with BacktraceClient's credentials. void
enable(String defaultUniqueEventName)
Enables metrics with BacktraceClient's credentials and overrides default unique event name. void
enable(BacktraceMetricsSettings settings)
Enable metrics void
enable(BacktraceMetricsSettings settings, String uniqueEventName)
Enable metrics String
getBaseUrl()
void
sendStartupEvent()
Send startup event to Backtrace void
send()
Send all outgoing messages (unique and summed) currently queued boolean
addUniqueEvent(String attributeName)
Add a unique event to the next Backtrace Metrics request boolean
addUniqueEvent(String attributeName, Map<String, Object> attributes)
Add a unique event to the next Backtrace Metrics request int
count()
Get number of stored events boolean
addSummedEvent(String metricGroupName)
Add a summed event to the next Backtrace Metrics request boolean
addSummedEvent(String metricGroupName, Map<String, Object> attributes)
Add a summed event to the next Backtrace Metrics request ConcurrentLinkedDeque<UniqueEvent>
getUniqueEvents()
Get the pending list of unique events ConcurrentLinkedDeque<SummedEvent>
getSummedEvents()
Get the pending list of summed events void
setUniqueEventsRequestHandler(EventsRequestHandler eventsRequestHandler)
Custom request handler for sending Backtrace unique events to server void
setSummedEventsRequestHandler(EventsRequestHandler eventsRequestHandler)
Custom request handler for sending Backtrace summed events to server void
setUniqueEventsOnServerResponse(EventsOnServerResponseEventListener callback)
Custom callback to be executed on server response to a unique events submission request void
setSummedEventsOnServerResponse(EventsOnServerResponseEventListener callback)
Custom callback to be executed on server response to a summed events submission request -
-
Constructor Detail
-
BacktraceMetrics
BacktraceMetrics(Context context, Map<String, Object> customReportAttributes, Api backtraceApi, BacktraceCredentials credentials)
Create new Backtrace metrics instance- Parameters:
context
- Application contextcustomReportAttributes
- Backtrace client custom report attributes (must be nonnull)backtraceApi
- Backtrace API for metrics sending
-
-
Method Detail
-
getContext
Context getContext()
-
setStartupUniqueEventName
void setStartupUniqueEventName(String startupUniqueEventName)
-
setMaximumNumberOfEvents
void setMaximumNumberOfEvents(int maximumNumberOfEvents)
Set the maximum number of events to store. Once the maximum is hit we will send events tothe API
- Parameters:
maximumNumberOfEvents
- Maximum number of events to store before sending events tothe API
-
enable
void enable()
Enables metrics with BacktraceClient's credentials.
-
enable
void enable(String defaultUniqueEventName)
Enables metrics with BacktraceClient's credentials and overrides default unique event name.
-
enable
void enable(BacktraceMetricsSettings settings)
Enable metrics
- Parameters:
settings
- for Backtrace metrics
-
enable
void enable(BacktraceMetricsSettings settings, String uniqueEventName)
Enable metrics
- Parameters:
settings
- for Backtrace metrics
-
getBaseUrl
String getBaseUrl()
-
sendStartupEvent
void sendStartupEvent()
Send startup event to Backtrace
-
send
void send()
Send all outgoing messages (unique and summed) currently queued
-
addUniqueEvent
boolean addUniqueEvent(String attributeName)
Add a unique event to the next Backtrace Metrics request
- Parameters:
attributeName
- Attribute name
-
addUniqueEvent
boolean addUniqueEvent(String attributeName, Map<String, Object> attributes)
Add a unique event to the next Backtrace Metrics request
- Parameters:
attributeName
- Attribute nameattributes
- Event attributes
-
count
int count()
Get number of stored events
-
addSummedEvent
boolean addSummedEvent(String metricGroupName)
Add a summed event to the next Backtrace Metrics request
- Parameters:
metricGroupName
- name of the metrics group
-
addSummedEvent
boolean addSummedEvent(String metricGroupName, Map<String, Object> attributes)
Add a summed event to the next Backtrace Metrics request
- Parameters:
metricGroupName
- name of the metrics groupattributes
- metrics attributes
-
getUniqueEvents
ConcurrentLinkedDeque<UniqueEvent> getUniqueEvents()
Get the pending list of unique events
-
getSummedEvents
ConcurrentLinkedDeque<SummedEvent> getSummedEvents()
Get the pending list of summed events
-
setUniqueEventsRequestHandler
void setUniqueEventsRequestHandler(EventsRequestHandler eventsRequestHandler)
Custom request handler for sending Backtrace unique events to server
- Parameters:
eventsRequestHandler
- object with method which will be executed
-
setSummedEventsRequestHandler
void setSummedEventsRequestHandler(EventsRequestHandler eventsRequestHandler)
Custom request handler for sending Backtrace summed events to server
- Parameters:
eventsRequestHandler
- object with method which will be executed
-
setUniqueEventsOnServerResponse
void setUniqueEventsOnServerResponse(EventsOnServerResponseEventListener callback)
Custom callback to be executed on server response to a unique events submission request
- Parameters:
callback
- object with method which will be executed
-
setSummedEventsOnServerResponse
void setSummedEventsOnServerResponse(EventsOnServerResponseEventListener callback)
Custom callback to be executed on server response to a summed events submission request
- Parameters:
callback
- object with method which will be executed
-
-
-
-