How to download My Logs
- Andrew (Deactivated)
This page details the process of how to access your Sandbox logs.
Prerequisite
The user is registered with CDR Sandbox Portal.
Refer to CDR Sandbox Portal
The user is logged into the CDR Sandbox Portal.
Overview
“My Logs” assists Sandbox users to trace errors that may not be available or apparent in standard API responses. Users are able to download a log file in CSV format containing up to 1,000 records of API calls done in the environment within the last 24 hours.
Accessing the “My Logs” page
From the CDR Sandbox Dashboard, you can access “My Logs” via the left hand menu.
Selecting “My Logs” presents the “My Logs” page within the CDR Sandbox Portal.
Selecting a Time Range
Using the Log Time Range drop down menu you can select up-to the last 24 hours of logging to be downloaded. The Log Time Range defaults to the last 5 Minutes.
Downloading “My Logs”
You can download your logs by selecting the “Download” button. Return to the Dashboard by selecting the “Cancel” button.
The logfile is downloaded in CSV format and named with a prefix of “sb-logfile-“ followed by a timestamp in the format of YYYYMMDD-HHMMSS and file extension “.csv".
For example sb-logfile-20220825-144023.csv
“My Logs” Content
Based on your selection of the log time range, the logfile will contain up to 1,000 records of calls made to, and responses for, certain API end points (as per section API End Points Logged) conducted in the Sandbox environment related to you.
Which API End Points can be returned in “My Logs”
This section lists the API end points that can be returned in the “My Logs” file.
Data Holder API End Points
Category | API End Point |
|---|---|
Common - Security Profile - Security Endpoint | GET connect/authorize |
Common - Security Profile - Security Endpoint | POST connect/token |
Common - Security Profile - Security Endpoint | GET /connect/userinfo |
Common - Security Profile - Security Endpoint | GET /connect/introspect |
Common - Security Profile - Security Endpoint | GET /connect/revocation |
Common - Security Profile - CDR Security Endpoint | GET /connect/arrangements/revoke |
Common - Security Profile | POST /par |
Common - Security Profile | GET /connect/register |
Common | GET /cds-au/v1/common/customer |
Banking | GET /cds-au/v1/banking/accounts |
Banking | GET /banking/accounts/{accountId}/transactions |
Energy | GET /energy/accounts |
Energy | GET /energy/accounts/{accountId}/concessions |
Mock Register API End Points
Category | API End Point |
|---|---|
Client Authentication | POST /token |
Register APIs | GET /cdr-register/v1/{industry}/data-holders/brands |
Register APIs | GET /cdr-register/v1/{industry}/data-recipients/brands/{dataRecipientBrandId}/software-products/{softwareProductId}/ssa |
Mock Data Recipient API End Points
Category | API End Point |
|---|---|
Security Endpoints | /revocation |
DCR APIs | POST /register |
DCR APIs | GET /register/{ClientId} |
DCR APIs | PUT /register/{ClientId} |
DCR APIs | DELETE /register/{ClientId} |
“My Logs” Structure
The logfile is structured as follows:
Header | Description | Format |
|---|---|---|
Id | Record Id; Internal unique Log ID. | Number |
Message | Method, API endpoint , Response. | String |
Level | Error level. | String |
TimeStamp | Time stamp from the original log file. | DateTime format: YYYY-MM-DDTHH:MM:SS.sss |
Exception | Exception message from the logging middle ware. | String |
SourceContext | Project that generated the log entry. | String |
ClientId | The client ID of the bearer. Client ID is from the Data Holder authorisation server. | String |
SoftwareId | Software Product ID, a unique identifier assigned by the Register and used by registration endpoints to identify the software product to be dynamically registered. | String |
DataHolderBrandId | Unique id of the Data Holder Brand issued by the CDR Register. | String |
x-fapi-interaction-id | FAPI Interaction Id specified in the x-fapi-interaction-id header in a request or response header. | String (UUID) |
RequestMethod | HTTP request method. | String |
RequestBody | Body of the HTTP request message. | String |
RequestHeaders | Headers of the HTTP request message. | String |
RequestPath | Request path. | String |
RequestQueryString | Request query string parameter. | String |
StatusCode | Status code of the response. | Number |
ElapsedTime | Time taken to process the request in milliseconds. | Number |
RequestHost | Host’s name and port. | String |
ClientIPAddress | Client IP address. | String |
ResponseHeaders | Headers of the response message. | String |
ResponseBody | Body of the response message. | String |