Event Types

There can be a range of events generated on either the front end or the back end. Every event is a JSON object and can have a variety of fields depending on the event type and name.

Card events

Events of this type are triggered when there's interaction with Now Assistant cards.

event_type
cardaction
card_id
Id of the referenced card Integer
event_name
generated
this event is triggered for every card which is generated or updated. This event allows to monitor the load generated by each card. String
shown
this event is triggered when a card is shown on the client. String
pin
this event is triggered when the user pins a card to the workplace. String
unpin
this event is triggered when the user unpins a card from the workplace. String
subscribe
this event is triggered when the user subscribes to Now notifications for a card. String
unsubscribe
this event is triggered when the user unsubscribes from Now notifications for a card. String
link
this event is triggered when the user clicks on a link. String
dismiss
this event is triggered when the user dismisses a card. String
approved
this event is triggered when the user approves an approval card. String
rejected
this event is triggered when the user rejects an approval card. String
card_title
label of the card that triggered the event. String
url
the Url of an opened link. String
label
the label of an opened link. String
user_name
name of the user for whom the event occurred. String
user_id
user's unique ID. Integer

Example:

{
  "_index": "exampleIndex",
  "_type": "http-bulk",
  "_id": "AV7w0qCeG1qNL-P3aOed",
  "_score": null,
  "_source": {
    "server_name": "serverName",
    "user_name": "admin",
    "type": "http-bulk",
    "process_time": 15,
    "card_id": 116,
    "tags": [
      "_logz_http_bulk_json_8070"
    ],
    "@timestamp": "2017-10-06T08:34:49.118+0000",
    "event_type": "cardaction",
    "card_title": "Helpdesk Cases",
    "user_id": 222,
    "event_date": "2017-10-06T08:35:01.7237930Z",
    "event_name": "generated"
  }
}

Search events

Events of this type are triggered when the user starts a search.

event_type
search
query
query term entered by the user. String
intent_name
name of the recognized intent (empty when no intent was recognized). String
entity_name
name of the recognized entity (empty when no entity was recognized). String
response_card_name
comma separated list of cards shown as a search response (might be empty if no intent is assigned). String

Example:

{
  "_index": "exampleIndex",
  "_type": "http-bulk",
  "_id": "AV7w3QriwF0J5JwWlZ6A",
  "_score": null,
  "_source": {
    "server_name": "serverName",
    "user_name": "admin",
    "query": "What are the latest news in finance?",
    "type": "http-bulk",
    "tags": [
      "_logz_http_bulk_json_8070"
    ],
    "@timestamp": "2017-10-06T08:46:11.682+0000",
    "event_type": "search",
    "event_date": "2017-10-06T08:46:24.5630774Z",
    "response_card_name": "news,graph"
  }
}

Application events

event_type
app
event_name
start
triggered when the user starts the client app. String
launch
triggered when a micro application is started. String
user_agent
browser client used to start application. This can be used to analyze device type and browser version in use. String
url
the Url of the launcher. String
name
name of the started micro service. String
total_time
the total perceived time in milliseconds taken to load the page. Integer
dom_load_time
time taken to load the DOM in milliseconds. Integer
download_time
time taken to download all the files when loading the page in milliseconds. Integer
load_time
time taken for content to fully load on the page in milliseconds. Integer
user_name
name of the user for whom the event occurred. String
user_id
user's unique ID. Integer

Example:

{
  "_index": "exampleIndex",
  "_type": "http-bulk",
  "_id": "AV7w_OCHglZzvdI6r_PQ",
  "_score": null,
  "_source": {
    "dom_load_time": 924,
    "server_name": "serverName",
    "download_time": 176,
    "user_name": "admin",
    "type": "http-bulk",
    "url": "http://app.company.com/start-now",
    "tags": [
      "_logz_http_bulk_json_8070"
    ],
    "@timestamp": "2017-10-06T09:20:57.990+0000",
    "event_type": "app",
    "load_time": 1022,
    "user_id": 2,
    "event_date": "2017-10-06T09:21:11.7358746Z",
    "event_name": "start",
    "total_time": 2122,
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/61.0.3163.100 Safari/537.36"
  }
}

Web request events

event_type
webrequest
event_name
api
triggered when the user accesses a connected web API. This allows to measure API utilization and API response time. String
site
triggered when a non API request is made e.g. fetching a static file. String
url
Url of the requested resource. String
user_name
name of the user for whom the event occurred. String
user_id
user's unique ID. Integer
process_time
time taken to process the request in milliseconds. Integer

Example

{
  "_index": "exampleIndex",
  "_type": "http-bulk",
  "_id": "AV7w_fm5glZzvdI6x1er",
  "_score": null,
  "_source": {
    "server_name": "serverName",
    "user_name": "admin",
    "type": "http-bulk",
    "process_time": 2,
    "url": "/api/Users/Connected",
    "tags": [
      "_logz_http_bulk_json_8070"
    ],
    "@timestamp": "2017-10-06T09:22:09.976+0000",
    "event_type": "webrequest",
    "user_id": 2,
    "event_date": "2017-10-06T09:22:23.7503270Z",
    "event_name": "api"
  }
}

Exception events

event_type
exception
event_name
error
triggered when an error in Now Assistant occurs. String
warn
triggered when a warning message is emitted in Now Assistant. String
host
the IP address of the event origin. String
message
exception message if present. String
source
source class of the exception if present. String
Url
the Url of exception's origin. String
exception
the error stack trace String

Example

{
  "_index": "exampleIndex",
  "_type": "http-bulk",
  "_id": "AV7w_fm5glZzvdI6x1er",
  "_score": null,
  "_source": {
    "server_name": "serverName",
    "user_name": "admin",
    "type": "http-bulk",
    "process_time": 2,
    "tags": [
      "_logz_http_bulk_json_8070"
    ],
    "event_type": "exception",
    "@timestamp": "2017-11-15T11:17:29.489Z",
    "event_date": "2017-11-15T11:17:28.5545291Z",
    "host": "127.0.0.1",
    "event_name": "error",
    "source": "adenin.GateKeeper.Services.NodeJsService",
    "message": "Activity Id 5, User admin, Error 500: getaddrinfo ENOTFOUND httpbin.org httpbin.org:80",
    "Url": "http://win-6337jr7ckk0/api/adenin.GateKeeper.Service/Proxy/5"
  }
}

Last updated: Sun 08 Oct, 2017