Logs ViewUpdated 11/12/2019
Two different Log Views are accessible inside Hull:
- The Kibana Logs View which is accessible from the
Logtab in the Dashboard or in theLogtab inside each of the connector's page. - The Logs View on the User and Account Profiles
Logs are a powerful and precise way to understand your exact data flow and surface the potential issues in great detail.
Connector logs display the data flows in and out of the given connector. The Logs accessible from the nav bar of the Dashboard display data flows from the whole organisation.
The logs view on the User and Account display data flow on a precise User or Account.
How to use the Kibana logs in the Dashboard and Connector view
The logs display a Kibana view of the data flow.
Filtering logs
On the top, you can find a search bar in which you will be able to filter the logs that you want to display. You have several ways of using that research bar:
- by writing queries in plain text: this will filter the "type of message" that you want to display (the second column starting from the left in the table showing the logs)
- by using Kibana Query Language. To do so, click on the Options button on the very right of the Search bar and enable the toggle button called
Turn on query features. This will allow you to use a simple syntax. For example, filter results byconnector_nameusing the following command in the search bar:connector_name: hubspot
- by using the filtering feature right under the search bar. To do so, click on the
Add a filterbutton and fill in your query. Below you will find the following query:connector_name is hubspot
You can also filter logs by date. On the top right corner you can select the time range from which you want to query the results:
⚠️ Warning ⚠️
The logs disappear after 7 days. So despite the fact that you can filter with Last 30 days or more, we won't be able to access the logs after 7 days.
Logs graph
Below the search bar, you will see two graphs being displayed. The graph on the left displays the count of logs per time. This will allow you to see what are the Users or Accounts who just entered or left the connector. Note that one colour accounts for a log type (see below in the Logs for Incoming Notifications and Logs for Outgoing Notifications sections)
The other graph on the right surfaces the top Users in terms of Log Volume. These are the Users who received the most changes during the selected time range. Once again, logs types are sorted by colors
Logs data
Sometimes you want to understand why a given User was not sent out to a third party tool. This is a classical use case in which you will have to analyze logs data. Logs data are directly accessible by clicking on the corresponding record inside the log table. There are accessible under the format of a table or under a JSON object.
The main attributes are displayed in the columns. For example, user_email (see below). In the data column, you will be able to see the full payload that is sent or received from or in the connector.
It can sometimes display errors which are often very valuable to understand the reason for which a User has not been synched for instance.
How to use the logs inside the User and Account profiles
Logs are also accessible on the User and Account levels. To access those logs, go to a User or Account profile inside the User or Account tab. Then, click on the Logs tab next to the Timeline. You will be able to see the full history of the given User or Account with the connector involved inside the column called Any column, the log type inside the Any output column (see Log types in the following sections) and the date that log has been processed inside the date column.
Note that you can also filter each of these columns to select the connector logs of a given connector, a given log type or a time range.
Logs for Incoming Notifications
To help you get attuned to the Logs, here is the full list of Log Types and their Description for incoming data. They are logged with the incoming.{entity}.{status} format.
| Log type | Description |
|---|---|
| incoming.user.success | User Attributes have been updated successfully |
| incoming.user.error | User Attributes have not been updated successfully |
| incoming.user.skip | User update was skipped |
| incoming.account.success | Account Attributes have been updated successfully |
| incoming.account.error | Account update was skipped |
| incoming.account.skip | Account was skipped by the Connector and not sent to the service |
| incoming.event.success | Event was successfully ingested |
| incoming.event.error | Event was not successfully ingested |
| incoming.event.skip | Event was skipped |
All logs feature an identifier to associate Users and Accounts with the logs. For outgoing notifications these include:
| Identifier | Description |
|---|---|
| user_id | Hull User ID |
| user_email | User email |
| user_external_id | External ID on the User |
| user_anonymous_id | Identifier from the external service or anonymous ID from web sessions |
| account_id | ID on the Account |
| account_external_id | External ID on the Account |
| account_domain | Account domain |
All data sent out through Connectors is logged and queryable by:
| Connector identifier | Description |
|---|---|
| connector_name | Reference name of the connector (ex. salesforce or processor) |
| connector_id | ID of the connector |
Logs for Outgoing Notifications
Here is the full list of Log Types and their Description for outgoing data. They are logged with the outgoing.{entity}.{status} format.
Note
For verbosity reasons, not every connector logs skip and success actions, and some log "Aggregated" logs that report reasons for Skipping for many customers at once. If you search for a User's Hull ID in the Search bar (as opposed to using the user_id filter), you should be able to see those aggregated results. If you need help finding the right message, contact your customer success manager so he help.
| Log type | Description |
|---|---|
| outgoing.user.success | User was successfully sent to the service |
| outgoing.user.error | User was not successfully sent to the service |
| outgoing.user.skip | User was skipped by the Connector and not sent to the service |
| outgoing.account.success | Account was successfully sent to the service |
| outgoing.account.error | Account was not successfully sent to the service |
| outgoing.account.skip | Account was skipped by the Connector and not sent to the service |
| outgoing.event.success | Event was successfully sent to the service |
| outgoing.event.error | Event was not successfully sent to the service |
| outgoing.event.skip | Event was skipped by the Connector and not sent to the service |
All logs feature an identifier to associate Users and Accounts with the logs. For outgoing notifications these include:
| Identifier | Description |
|---|---|
| user_id | ID on the User |
| user_external_id | External ID from the user |
| user_email | User email |
| user_anonymous_id | User Anonymous ID (cookie,...) |
| account_id | ID on the Account |
| account_external_id | External ID on the Account |
| account_domain | Account domain |
All data sent out through Connectors is logged and queryable by:
| Connector identifier | Description |
|---|---|
| connector_name | Reference name of the connector (ex. salesforce or processor) |
| connector_id | ID of the connector |