How to use the analytics API to query EUM data from Events Service with or without an analytics license

[Mayuresh.Kshirsagar]

AppDynamics Events Service is the on-premise data storage facility for unstructured data generated by Application Analytics, Database Visibility, and End User Monitoring (EUM) deployments.

To configure EUM to push raw data to Events Service, edit the eum.properties file to reflect the following properties:

analytics.enabled=true
analytics.serverScheme=http
analytics.serverHost=events.service.hostname
analytics.port=9080
analytics.accountAccessKey=1a59d1ac-4c35-4df1-9c5d-5fc191003441

Note: EUM will push EUM data to Events Service with or without an explicit analytics license.

How to query EUM data with an analytics license 

To query the EUM data from Events Service using the analytics API, follow the directions in our analytics API documentation (version 4.3).

How to query EUM data with no explicit analytics license 

When there is no explicit analytics license, you will need to change the authentication method outlined in the analytics API documentation.

For this authentication, use the EUM account name and EUM license key which can be found on the license page by clicking on the gear menu in the upper-right corner of the controller UI, and then clicking on License.

 

Authenticate with curl

One option is to use the following curl syntax for authentication:

curl --user "<eum_account_name>:<eum_license_key>".....

Authenticate with base64 encoding

Another option is to use the following base64 encoding syntax for authentication:

base64accountname=<eum_account_name>
base64licensekey=<eum_license_key>
base64auth=`echo "$base64accountname:$base64licensekey" | base64 -b 0` 

echo $base64auth
QXBwRHluYW1pY3MteHh4eHg6OWJhOWJkM2IteHh4eAo=

curl -H"Authorization: Basic $base64auth"....

Types of queries 

After choosing the method of authentication, you can make queries to Events Service for the following types of data:

Event Type	Events Service Table Name
Browser Records	browser_records
Mobile Records	mobile_snapshots
Mobile Crash Reports	mobile_crash_reports
Browser Sessions	web_session_records
Mobile Sessions	mobile_session_records

 

API example

With the chosen authentication method and chosen Events Service endpoint, use the following API script to make your query:

curl --user "<EUM_Account_Name>:<EuM_License_Key>" -H"Content-type: application/vnd.appd.events+json;v=2" http://<events_service_endpoint>:9080/events/query -d '
select * from browser_records
'

or

curl -H"Authorization: Basic $base64auth" -H"Content-type: application/vnd.appd.events+json;v=2" http://<events_service_endpoint>:9080/events/query -d '
select * from browser_records
'

Note:

In some on-premise deployments, the EUM account license key may have changed in a license renewal which can cause authorization to fail. If the on-premise Events Service node(s) have  ad.es.node.http.enabled=true  configured in the events-service-api-store.properties file then the following cURL command can be used to find the correct EUM license key value. Please update the $ES_NODE variable to use the IP address or hostname of an/the Events Service node.

Example:

$ ES_NODE="192.168.102.171"
$ curl -s "http:/${ES_NODE}:9200/appdynamics_accounts_v2/_search" | sed $'s/,/\\\n/g'| grep "eumAccountName" -B 3 | head -2
"accountName":"test-eum-account-XXXXXXXXX-1518596264712"
"accessKey":"52218919-ddbb-XXXX-XXXX-edec188e4b73"

Additional parameters

For additional information, such as start and end parameters, follow the analytics API documentation.