Send usage data to Splunk
The Splunk MINT App includes the opt-in ability to send anonymized usage data to Splunk to help improve the app in future releases.
How data is collected
If you opt in, the app enables an internal library to track basic usage and crash information. The library uses browser cookies to track app user visitor uniqueness and sessions and sends events to Splunk using XHR in JSON format.
What data is collected
If enabled, the Splunk MINT App sends the following events to Splunk.
Event | Source Type | Description | Data sent includes common fields, plus | ||
---|---|---|---|---|---|
Field | Type | Description | |||
Session start | mint:ping
|
Each ping event indicates that a new session has started. | fsEncrypted
|
N/A | Not used, always "NA" |
rooted
|
N/A | Not used, always false | |||
Session end | mint:gnip
|
Each gnip event indicates that a session has ended. | ses_duration
|
int | How long the session lasted |
Page views | mint:view
|
Triggered once per page view in the app. | current
|
string | The URL of the current web page, without the hostname. |
currentView
|
string | Not used. Hardcoded to 'examples'. | |||
domProcessingTime
|
int | Time spent to process the domain. | |||
domLookupTime
|
int | Time spent to look up the domain name. | |||
elapsedTime
|
int | Time spent to render the page. | |||
host
|
string | The hostname in the URL. | |||
loadTime
|
int | Time spent to load the page. | |||
previous
|
string | The referrer URL. | |||
serverTime
|
int | Time spent to get a response from the server. | |||
App performance and configuration |
mint:log
|
Usage and performance logs for the Splunk MINT App that track dashboard memory usage, dashboard loading times, the number of accounts, inputs, and regions configured in the app, and non-sensitive input configuration parameters (for example, SQS queue names and S3 bucket names are not collected.) | level
|
int | Log level. For example, 60 means 'error'. |
log_name
|
any | Log content. | |||
API calls | mint:network
|
XMLHTTPRequest calls, usually HTTP API calls from client side (browser) to the Splunk server. | failed
|
boolean | Indicates if the request failed or not. |
latency
|
int | Time spent before response received. | |||
protocol
|
string | Network protocol: either http or https. | |||
requestLength
|
string | N/A. Not used. | |||
responseLength
|
int | The size of the response. | |||
statusCode
|
string | HTTP response code. | |||
url
|
string | The request URL, without the hostname. | |||
Transaction start | mint:trstart
|
Specific transactions were created inside the app to track the user workflow inside the app to indicate the usage of certain features. This event is generated when a transaction is started. | transaction_id
|
string | Randomly-generated transaction ID. |
tr_name
|
string | Name of the transaction. | |||
Transaction stop | mint:trstop
|
This event is generated when a transaction has ended or been cancelled. | reason
|
string | Why the transaction ended. |
status
|
string | Status of the transaction when it ended. | |||
tr_duration
|
int | Duration of the transaction. |
Common fields
The data that the Splunk MINT App sends to Splunk, if enabled, includes the following common fields. This set of fields includes several fields that are disabled or deliberately not used for the Splunk MINT App for purposes of anonymization.
Field | Type | Description | Example value |
---|---|---|---|
apiKey
|
string | MINT API key for the Splunk MINT App | 4t2fk73n |
appRunningState
|
Field is not used. Shows a value of "NA" in all events. | ||
appVersionCode
|
Field is not used. Shows a value of "NA" in all events. | ||
appVersionName
|
string | The version name of the app sending data. | 4.1.0 |
browser
|
string | The browser name. | Chrome |
browserVersion
|
string | The browser version. | 47.0.2526.111 |
carrier
|
Field is not used. Shows a value of "NA" in all events. | ||
connection
|
Field is not used. Shows a value of "NA" in all events. | ||
device
|
string | The device making the request. | MacIntel |
extraData
|
JSON object | This field stores custom information for the app. This app uses extraData.splunk_version to store the version number of the Splunk platform instance.
|
6.3.1511 |
locale
|
string | The user locale set in the browser. | en-US |
osVersion
|
string | The version code of the underlying operating system. | OS X 10.11.2 |
packageName
|
string | The package name of the Splunk MINT App. | splunk_app_mint |
platform
|
Not used for the Splunk MINT App. Shows a value of "web" in all events. | ||
remoteIP
|
Not used for the Splunk MINT App. Shows a value of "3.0.0.0" in all events. | ||
sdkVersion
|
string | The version of the SDK. | 4.3 |
screenOrientation
|
Field is unused. Shows a value of "NA" in all events. | ||
session_id
|
string | A unique string to identify a session. | a5026251 |
state
|
string | Indicator of whether the browser is online or not. Can be either CONNECTED or DISCONNECTED. | CONNECTED |
uuid
|
UUID | A random identifier to track the user's uniqueness | 837227ea-4569-4675-9a17-ccb39ca69505 |
What data is not collected
The following kinds of data are not collected:
- Sensitive data, such as usernames or passwords.
- Identifying information, such as addresses, phone numbers, IP addresses, and hostnames.
- Indexed data on your Splunk platform instance.
No data is collected that is not explicitly described above.
How to opt in or out
The Splunk MINT App presents an opt-in request on the final page of the configuration wizard, which runs the first time you start the app:
- To opt in, select the check box under Help us make MINT better!
You can also change your opt-in setting at any time after you have configured the app:
- On the Splunk MINT App home page, click Settings.
- Select or clear the check box under Help us make MINT better!, and then click Save. If you opt out after having previously opted in, the app immediately stops sending data to MINT Cloud.
For more information about how Splunk collects and uses data, see the Splunk Privacy Policy.
The MINT data model | What's new |
This documentation applies to the following versions of Splunk MINT™ App (Legacy): 2.1.0, 2.2.0, 2.2.1, 3.0.0, 3.0.1, 3.0.2
Feedback submitted, thanks!