com.splunk.mint

Class Mint

java.lang.Object

com.splunk.mint.Mint

public final class Mint
extends java.lang.Object

The Mint class represents the main class for the Splunk MINT SDK for Android.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	appEnvironmentDevelopment
static java.lang.String	appEnvironmentRelease
static java.lang.String	appEnvironmentStaging
static java.lang.String	appEnvironmentTesting
static java.lang.String	appEnvironmentUserAcceptanceTesting
static java.lang.String	XSplunkMintSessionIdHeader The header name to use for HTTP.
static java.lang.String	XSplunkMintUuidHeader The header name to use for HTTP.

Constructor Summary

Constructors

Constructor and Description
Mint()

Method Summary

Modifier and Type	Method and Description
static void	addExtraData(java.lang.String key, java.lang.String value) Adds a key-value pair to the extra data.
static void	addURLToBlackList(java.lang.String url) Adds a URL to the network monitoring blacklist.
static void	clearExtraData() Clears all extra data.
static void	clearTotalCrashesNum() Clears the total number of crashes.
static void	closeSession(android.app.Application app) Closes the active session.
static void	disableAutoFlash() disable auto flush, should be called before SDK initialization.
static void	disableCrashMonitoring() Disables crash monitoring.
static void	disableMemoryPressureMonitoring() Disables Memory Pressure monitoring.
static void	disableNetworkMonitoring() Disables network monitoring.
static void	enableDebugLog() Enables the display of debug messages. **Note** You should turn this feature off in production.
static void	enableLogging(boolean enable) Enables LogCat logging.
static void	flush() Flushes all saved data.
static org.json.JSONObject	getDevSettings() Gets the developer settings from the remote settings.
static java.util.HashMap<java.lang.String,java.lang.Object>	getExtraData() Gets the extra data map.
static java.lang.String	getLastCrashID() Gets the error hash of the last crash.
static java.lang.String	getMintUUID() Returns the MINT universally unique identifier (UUID), which uniquely identifies a specific user.
static java.lang.String	getSessionId() Returns the current session ID.
static int	getTotalCrashesNum() Returns the total number of crashes.
static void	initAndStartSession(android.app.Application app, java.lang.String apiKey) Use this constructor to initialize and start the session for the MINT Data Collector environment.
static void	initAndStartSessionHEC(android.app.Application app, java.lang.String url, java.lang.String token) Use this constructor to initialize and start the session for the HTTP Event Collector (HEC) environment.
static void	leaveBreadcrumb(java.lang.String breadcrumb) Leaves a breadcrumb at a point of interest in your code.
static void	logEvent(java.lang.String eventName) Logs an event and uses the default log level `Verbose`.
static void	logEvent(java.lang.String eventName, MintLogLevel logLevel) Logs an event with a specific log level.
static void	logEvent(java.lang.String eventName, MintLogLevel logLevel, java.util.HashMap<java.lang.String,java.lang.Object> customData) Logs an event with a specific log level.
static void	logEvent(java.lang.String eventName, MintLogLevel logLevel, java.lang.String keyName, java.lang.String keyValue) Logs an event with a specific log level.
static void	logException(java.lang.Exception ex) Submits a handled exception (if inside a `try-catch` block) and a map of custom data.
static void	logException(java.util.HashMap<java.lang.String,java.lang.Object> customData, java.lang.Exception exception) Submits a handled exception (if inside a `try-catch` block) and a map of custom data.
static void	logException(java.lang.String key, java.lang.String value, java.lang.Exception exception) Submits a handled exception (if inside a `try-catch` block) and a custom key-value pair.
static void	logNetworkEvent(java.lang.String url, java.lang.String protocol, long startTime, long endTime, int httpStatusCode, long requestLength, long responseLength, java.lang.String serverException, java.util.HashMap<java.lang.String,java.lang.Object> customData) Logs a network event as Splunk data type.
static void	logView(java.lang.String view) Logs a specific view as a Splunk data type.
static void	logView(java.lang.String view, java.util.HashMap<java.lang.String,java.lang.Object> extraData) Logs a specific view as a Splunk data type.
static void	logView(java.lang.String view, java.lang.String key, java.lang.String value) Logs a specific view as a Splunk data type.
static void	removeExtraData(java.lang.String key) Removes a specific key-value pair from the extra data.
static void	setApplicationEnvironment(java.lang.String environment) Sets the application environment.
static void	setAutoFlushMinimumInterval(int interval) Set the minimum interval of auto flush.
static void	setFlushOnlyOverWiFi(boolean enabled) Enables MINT to flush data only when there is a WiFi connection. **Note** Be sure to add the ACCESS_NETWORK_STATE permission to your AndroidManifest.xml file.
static void	setLocation(android.location.Location location) Sets the location
static void	setLogging(int lines) Restricts the number of lines in the LogCat output.
static void	setLogging(int lines, java.lang.String filter) Restricts the number of lines in the LogCat output and sets a LogCat filter string.
static void	setLogging(java.lang.String filter) Sets a LogCat filter string.
static void	setMintCallback(MintCallback mintCallback) Sets a Mint callback interface, which is used for the **lastBreath** callback, the **netSaverResponse** callback, and the **dataSaverResponse** callback.
static void	setSessionInterval(int timeInSecs) Sets the session interval time.
static void	setUserIdentifier(java.lang.String userIdentifier) Sets an identifier for the current user.
static void	setUserOptOut(boolean optedOut) Indicates whether to prevent MINT from saving or sending any data for the user.
static void	startANRMonitoring(int timeout, boolean ignoreDebugger) Starts Application Not Responding (ANR) monitoring.
static void	startSession(android.app.Application app) Starts a new session.
static java.lang.String	timerStart(java.lang.String name) Starts a timer.
static void	timerStop(java.lang.String id) Stops a timer.
static void	transactionCancel(java.lang.String id, java.lang.String reason) Cancels a transaction.
static void	transactionCancel(java.lang.String id, java.lang.String reason, java.util.HashMap<java.lang.String,java.lang.Object> customData) Cancels a transaction.
static void	transactionCancel(java.lang.String id, java.lang.String reason, java.lang.String keyName, java.lang.String keyValue) Cancels a transaction.
static java.lang.String	transactionStart(java.lang.String name) Starts a transaction.
static java.lang.String	transactionStart(java.lang.String name, java.util.HashMap<java.lang.String,java.lang.Object> customData) Starts a transaction.
static java.lang.String	transactionStart(java.lang.String name, java.lang.String keyName, java.lang.String keyValue) Starts a transaction.
static void	transactionStop(java.lang.String id) Stops a transaction.
static void	transactionStop(java.lang.String id, java.util.HashMap<java.lang.String,java.lang.Object> customData) Stops a transaction.
static void	transactionStop(java.lang.String id, java.lang.String keyName, java.lang.String keyValue) Stops a transaction.
static void	xamarinException(java.lang.Exception exception, boolean handled, java.util.HashMap<java.lang.String,java.lang.Object> customData) Submits a exception from Xamarin.

Methods inherited from class java.lang.Object

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

Field Detail

appEnvironmentRelease

public static final java.lang.String appEnvironmentRelease

See Also:

Constant Field Values

appEnvironmentStaging

public static final java.lang.String appEnvironmentStaging

See Also:

Constant Field Values

appEnvironmentUserAcceptanceTesting

public static final java.lang.String appEnvironmentUserAcceptanceTesting

See Also:

Constant Field Values

appEnvironmentTesting

public static final java.lang.String appEnvironmentTesting

See Also:

Constant Field Values

appEnvironmentDevelopment

public static final java.lang.String appEnvironmentDevelopment

See Also:

Constant Field Values

XSplunkMintSessionIdHeader

public static final java.lang.String XSplunkMintSessionIdHeader

The header name to use for HTTP.

See Also:

Constant Field Values

XSplunkMintUuidHeader

public static final java.lang.String XSplunkMintUuidHeader

The header name to use for HTTP.

See Also:

Constant Field Values

Constructor Detail

Mint

public Mint()

Method Detail

initAndStartSession

public static void initAndStartSession(android.app.Application app,
                                       java.lang.String apiKey)

Use this constructor to initialize and start the session for the MINT Data Collector environment. This constructor validates the API key, initializes the plugin environment, installs the exception handler, and sends a PING request or a PING_WITH_SETTINGS request to receive new remote settings.

Parameters:

app - The Application instance.

apiKey - The API key you received for the project.

initAndStartSessionHEC

public static void initAndStartSessionHEC(android.app.Application app,
                                          java.lang.String url,
                                          java.lang.String token)

Use this constructor to initialize and start the session for the HTTP Event Collector (HEC) environment. This constructor validates the HEC token, initializes the plugin environment, installs the exception handler, and sends a PING request.

Parameters:

app - The Application instance.

url - The URL of the HEC MINT endpoint.

token - The token of the HEC input.

startSession

public static void startSession(android.app.Application app)

Starts a new session. This method checks the sent time of the last PING request and creates a new one if more than 60 seconds have passed.

Parameters:

app - The Application instance.

closeSession

public static void closeSession(android.app.Application app)

Closes the active session.

Parameters:

app - The Application instance.

flush

public static void flush()

Flushes all saved data.

startANRMonitoring

public static final void startANRMonitoring(int timeout,
                                            boolean ignoreDebugger)

Starts Application Not Responding (ANR) monitoring.

Parameters:

timeout - The timeout, in milliseconds. A suggested value is 5000.

ignoreDebugger - `true` to ignore ANRs when the debugger is attached. The suggested value is `true`.

setSessionInterval

public static void setSessionInterval(int timeInSecs)

Sets the session interval time. This value should be more than 30 seconds and less than a day.

Parameters:

timeInSecs - The session interval time, in seconds.

setUserOptOut

public static void setUserOptOut(boolean optedOut)

Indicates whether to prevent MINT from saving or sending any data for the user.

Parameters:

optedOut - `true` to enable user opt-out, `false` to disable it.

disableNetworkMonitoring

public static void disableNetworkMonitoring()

Disables network monitoring. You must call this before the **initAndStartSession** or **initAndStartSessionHEC** method.

disableCrashMonitoring

public static void disableCrashMonitoring()

Disables crash monitoring. You must call this before the **initAndStartSession** or **initAndStartSessionHEC** method.

setMintCallback

public static final void setMintCallback(MintCallback mintCallback)

Sets a Mint callback interface, which is used for the **lastBreath** callback, the **netSaverResponse** callback, and the **dataSaverResponse** callback.

Parameters:

mintCallback - The Mint callback interface.

leaveBreadcrumb

public static void leaveBreadcrumb(java.lang.String breadcrumb)

Leaves a breadcrumb at a point of interest in your code.

Parameters:

breadcrumb - The name of the breadcrumb.

logView

public static void logView(java.lang.String view)

Logs a specific view as a Splunk data type.

Parameters:

view - The name of the view.

logView

public static void logView(java.lang.String view,
                           java.lang.String key,
                           java.lang.String value)

Logs a specific view as a Splunk data type.

Parameters:

view - The name of the view.

key - Extra data key.

value - Extra data value.

logView

public static void logView(java.lang.String view,
                           java.util.HashMap<java.lang.String,java.lang.Object> extraData)

Logs a specific view as a Splunk data type.

Parameters:

extraData - Extra data.

view - The name of the view.

logEvent

public static void logEvent(java.lang.String eventName)

Logs an event and uses the default log level `Verbose`.

Parameters:

eventName - The name of the event.

logEvent

public static void logEvent(java.lang.String eventName,
                            MintLogLevel logLevel)

Logs an event with a specific log level.

Parameters:

eventName - The name of the event.

logLevel - The log level of the event.

logEvent

public static void logEvent(java.lang.String eventName,
                            MintLogLevel logLevel,
                            java.util.HashMap<java.lang.String,java.lang.Object> customData)

Logs an event with a specific log level.

Parameters:

eventName - The name of the event.

logLevel - The log level of the event.

customData - The HashMap containing custom data.

logEvent

public static void logEvent(java.lang.String eventName,
                            MintLogLevel logLevel,
                            java.lang.String keyName,
                            java.lang.String keyValue)

Logs an event with a specific log level.

Parameters:

eventName - The name of the event.

logLevel - The log level of the event.

keyName - The key name for extra data.

keyValue - The value of extra data.

setUserIdentifier

public static void setUserIdentifier(java.lang.String userIdentifier)

Sets an identifier for the current user.

Parameters:

userIdentifier - The user identifier, such as a random ID, an email address, or a user name.

setApplicationEnvironment

public static void setApplicationEnvironment(java.lang.String environment)

Sets the application environment. Use a custom string or one of the following suggested environments:

• appEnvironmentRelease
• appEnvironmentStaging
• appEnvironmentUserAcceptanceTesting
• appEnvironmentTesting
• appEnvironmentDevelopment

Parameters:

environment - The application environment.

enableDebugLog

public static void enableDebugLog()

Enables the display of debug messages.
**Note** You should turn this feature off in production.

setFlushOnlyOverWiFi

public static void setFlushOnlyOverWiFi(boolean enabled)

Enables MINT to flush data only when there is a WiFi connection.
**Note** Be sure to add the ACCESS_NETWORK_STATE permission to your AndroidManifest.xml file.

Parameters:

enabled - `true` to enable sending date over WiFi only, `false` to disable it.

setAutoFlushMinimumInterval

public static void setAutoFlushMinimumInterval(int interval)

Set the minimum interval of auto flush.

Parameters:

interval - the minimum interval of auto flush, in milliseconds.

disableAutoFlash

public static void disableAutoFlash()

disable auto flush, should be called before SDK initialization.

transactionStart

public static java.lang.String transactionStart(java.lang.String name)

Starts a transaction.

Parameters:

name - The name of the transaction.

Returns:

The transaction ID.

transactionStart

public static java.lang.String transactionStart(java.lang.String name,
                                                java.util.HashMap<java.lang.String,java.lang.Object> customData)

Starts a transaction.

Parameters:

name - The name of the transaction.

customData - The HashMap containing custom data.

Returns:

The transaction ID.

transactionStart

public static java.lang.String transactionStart(java.lang.String name,
                                                java.lang.String keyName,
                                                java.lang.String keyValue)

Starts a transaction.

Parameters:

name - The name of the transaction.

keyName - The key name for extra data.

keyValue - The value of extra data.

Returns:

The transaction ID.

transactionStop

public static void transactionStop(java.lang.String id)

Stops a transaction.

Parameters:

id - The ID of the transaction.

transactionStop

public static void transactionStop(java.lang.String id,
                                   java.util.HashMap<java.lang.String,java.lang.Object> customData)

Stops a transaction.

Parameters:

id - The ID of the transaction.

customData - The HashMap containing custom data.

transactionStop

public static void transactionStop(java.lang.String id,
                                   java.lang.String keyName,
                                   java.lang.String keyValue)

Stops a transaction.

Parameters:

id - The ID of the transaction.

keyName - The key name for extra data.

keyValue - The value of extra data.

transactionCancel

public static void transactionCancel(java.lang.String id,
                                     java.lang.String reason)

Cancels a transaction.

Parameters:

id - The ID of the transaction.

reason - The reason for canceling the transaction. This value can be `null` or empty.

transactionCancel

public static void transactionCancel(java.lang.String id,
                                     java.lang.String reason,
                                     java.util.HashMap<java.lang.String,java.lang.Object> customData)

Cancels a transaction.

Parameters:

id - The ID of the transaction.

reason - The reason for canceling the transaction. This value can be `null` or empty.

customData - The HashMap containing custom data.

transactionCancel

public static void transactionCancel(java.lang.String id,
                                     java.lang.String reason,
                                     java.lang.String keyName,
                                     java.lang.String keyValue)

Cancels a transaction.

Parameters:

id - The ID of the transaction.

reason - The reason for canceling the transaction. This value can be `null` or empty.

keyName - The key name for extra data.

keyValue - The value of extra data.

timerStart

public static java.lang.String timerStart(java.lang.String name)

Starts a timer.

Parameters:

name - The name of the timer.

Returns:

The timer ID.

timerStop

public static void timerStop(java.lang.String id)

Stops a timer.

Parameters:

id - The timer ID.

getExtraData

public static java.util.HashMap<java.lang.String,java.lang.Object> getExtraData()

Gets the extra data map. Returns a clone of the extra data HashMap

Returns:

The cloned map of the extra data.

addExtraData

public static void addExtraData(java.lang.String key,
                                java.lang.String value)

Adds a key-value pair to the extra data.

Parameters:

key - The key.

value - The value.

removeExtraData

public static void removeExtraData(java.lang.String key)

Removes a specific key-value pair from the extra data.

Parameters:

key - The key to remove.

clearExtraData

public static void clearExtraData()

Clears all extra data.

getTotalCrashesNum

public static int getTotalCrashesNum()

Returns the total number of crashes.

Returns:

An integer indicating the number of crashes.

clearTotalCrashesNum

public static void clearTotalCrashesNum()

Clears the total number of crashes.

getLastCrashID

public static java.lang.String getLastCrashID()

Gets the error hash of the last crash.

Returns:

The error hash of the last crash, or `null` if no crash.

logException

public static void logException(java.util.HashMap<java.lang.String,java.lang.Object> customData,
                                java.lang.Exception exception)

Submits a handled exception (if inside a `try-catch` block) and a map of custom data.

Parameters:

customData - The HashMap containing custom data.

exception - The handled exception.

logException

public static void logException(java.lang.Exception ex)

Submits a handled exception (if inside a `try-catch` block) and a map of custom data.

Parameters:

ex - The handled exception.

logException

public static void logException(java.lang.String key,
                                java.lang.String value,
                                java.lang.Exception exception)

Submits a handled exception (if inside a `try-catch` block) and a custom key-value pair.

Parameters:

key - The key.

value - The value.

exception - The handled exception.

xamarinException

public static void xamarinException(java.lang.Exception exception,
                                    boolean handled,
                                    java.util.HashMap<java.lang.String,java.lang.Object> customData)

Submits a exception from Xamarin.

Parameters:

exception - The exception.

handled - Handled flag. true - handled, false - unhandled.

customData - Optional custom data. Please pass null if you don't have custom data.

enableLogging

public static void enableLogging(boolean enable)

Enables LogCat logging.

Parameters:

enable - `true` to enable LogCat logging, `false` to disable it.

setLogging

public static void setLogging(int lines)

Restricts the number of lines in the LogCat output.

Parameters:

lines - The number of lines to report.

setLogging

public static void setLogging(java.lang.String filter)

Sets a LogCat filter string.

Parameters:

filter - The filter expression. For more information, see [ Filtering Log Output](http://developer.android.com/tools/debugging/debugging -log.html#filteringOutput) on the Android Developers website.

setLogging

public static void setLogging(int lines,
                              java.lang.String filter)

Restricts the number of lines in the LogCat output and sets a LogCat filter string.

Parameters:

lines - The number of lines to report.

filter - The filter expression. For more information, see [ Filtering Log Output](http://developer.android.com/tools/debugging/debugging -log.html#filteringOutput) on the Android Developers website.

getDevSettings

public static org.json.JSONObject getDevSettings()

Gets the developer settings from the remote settings.

Returns:

The names and values for each setting.

addURLToBlackList

public static void addURLToBlackList(java.lang.String url)

Adds a URL to the network monitoring blacklist. Network calls with this URL are ignored.

Parameters:

url - The URL to ignore.

disableMemoryPressureMonitoring

public static void disableMemoryPressureMonitoring()

Disables Memory Pressure monitoring. You must call this before the **initAndStartSession** or **initAndStartSessionHEC** method.

getSessionId

public static final java.lang.String getSessionId()

Returns the current session ID.

Returns:

The session ID.

getMintUUID

public static final java.lang.String getMintUUID()

Returns the MINT universally unique identifier (UUID), which uniquely identifies a specific user.

Returns:

The UUID of the user.

setLocation

public static void setLocation(android.location.Location location)

Sets the location

Parameters:

location - Location instance.

logNetworkEvent

public static void logNetworkEvent(java.lang.String url,
                                   java.lang.String protocol,
                                   long startTime,
                                   long endTime,
                                   int httpStatusCode,
                                   long requestLength,
                                   long responseLength,
                                   java.lang.String serverException,
                                   java.util.HashMap<java.lang.String,java.lang.Object> customData)

Logs a network event as Splunk data type.

Parameters:

url - The URL of the network request.

protocol - The network protocol of the request. Usually HTTP/S.

startTime - The start timestamp of the request in milliseconds. Usually obtained by calling System.currentTimeMillis() before starting the network request.

endTime - The end timestamp of the request in milliseconds. Usually obtained by calling System.currentTimeMillis() after the request ends.

httpStatusCode - The HTTP status code as received from the network library. If your request failed before establishing an HTTP connection, this value should be zero.

requestLength - The request length in bytes.

responseLength - The response length in bytes. If your request failed before receiving a server response, this value should be zero.

serverException - Sometimes when the server returns an HTTP error code, the HTTP response will contain more details about the server side error. serverException can be called to pass this error to a Splunk data type. If your request failed before receiving a server response, this value should be null.

customData - The HashMap containing custom data.