How do I use the insights application?

This article will show you how to access the insights application, and provides a summary of the features that are available on the website for viewing your request and access logs

The insights application allows you to view the activity taking place within your LUSID domain. The logs available within insights application allow you to:

  • Understand how your LUSID domain is being utilised by your users.
  • Search, identify and troubleshoot issues with specific requests. 

The logs you can view will depend on what insights features your administrator has granted your role.

In this article you will learn:

  1. How to access the insights application
  2. How to use the insights application
  3. How to drill into specific request logs

1. Accessing the insights application

You can access the insights application either via: 1) the navigation panel on the top left corner, or 2) the app tray on the top right corner.

2. Using the insights application

The insights application has two sections:

  • Request logs:  The request logs show the API calls that have been made to the various applications within the LUSID system.
  • Access logs: The access logs show the API calls that have been made to our access control system to check if users have the appropriate permissions to access LUSID resources and features. 

Log activity graphs

Both sections have a similar layout, with a bar graph that shows the count of activity over time. You can adjust the time period at the top left of the chart, either by selecting the pre-populated time buckets (e.g. last 30 minutes, last hour etc.), or by setting a "from" and "to" time bucket manually.


 

You can also use the bar graph to filter logs in the table by selecting the area on the chart you wish to review in more detail. This will automatically set a "from" and "to" filter. Clicking "back" on your browser will take you back to the previous time filter.

Request log table

The request log table shows a list of the historical API calls to the various applications within the LUSID system. The column headings can be used to filter or sort logs as required. 

We have summarised the key fields below:

Field Description
Date and Time The date and time that the API call was invoked
Source Application The application that was used to invoke the API call
Application The application that API call was made to
RequestID The unique identifier for API call
Verb The HTTP method for the action performed by API call
Operation Short description of the action performed by the API call
UserId The unique identifier of the user that invoked the API
URL The URL of the API that was invoked
Status The outcome of the API call (e.g. completed, failed)
Duration (ms) The duration of the API call in milliseconds
HTTP Status Code The HTTP status code returned by the API call 
Error Code The error code (if any) returned by the API call. Please see our API documentation for a list of error codes.

Access log table

The access log table shows a list of the historical API calls made to our access control system to check if users have the appropriate permissions to access LUSID resources and features. The column headings can be used to filter or sort logs as required. 

We have summarised the key fields below:

Field Description
Date and Time The date and time that the access check was initiated
RequestID The unique identifier for API call
Application The application that API call was made to
Result The outcome of the access check (e.g. success etc.)
ResourceType The type of resource for which access was attempted 
Resource The resource for which access was attempted 
UserId The unique identifier of the user that invoked the API
Action The action for which access was attempted
User type The type of user (e.g. personal / service)
Authoritative Role ID The role against which access was granted 
Authoritative Policy ID The policy against which access was granted 

3. Drilling into specific request logs

For request logs, you can get detailed information on the Request details and Response details for the API call.

To view more information about a specific request, within the request log table click the "view" icon at the end of the row.

This will take you to a new view for that specific API request. On the left hand side of the screen, you can find a summary of the key fields for each request:

On the right hand side of the screen, you can also view the Request details and Response details. Clicking on the "download" icon will allow you save the json file. You can also copy specific parts of the response.