Event Logs
Overview
This API has been available since 1.6.0
The Event Log contains messages that are not easy to convey to user at runtime - logs and errors from asynchronous code execution. These messages include:
-
SMTP transport errors
-
Lambda execution exceptions
-
Lambda execution console logs
-
SAML IdP integration errors and debug
-
Webhook event errors
-
Runtime exceptions due to email template rendering issues
This page contains the APIs that are used to retrieve Event Logs. Here are the APIs:
Retrieve an Event Log
Request
GET /api/system/event-log/{logId}
Request Parameters
- logId [Long] Required
-
The unique Id of the Event Log to retrieve.
Response
Code | Description |
---|---|
200 |
The request was successful. The response will contain a JSON body. |
400 |
The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
401 |
You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
404 |
The object you requested doesn’t exist. The response will be empty. |
500 |
There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
503 |
The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body. |
Response Body
- eventLog.id [Long]
-
The event Log unique Id.
- eventLog.insertInstant [Long]
-
The instant when the Event Log was created.
- eventLog.message [String]
-
The message of the event Log.
- eventLog.type [String]
-
The type of the Event Log. Possible values are:
-
Information
-
Debug
-
Error
-
{
"eventLog": {
"id": 1,
"insertInstant": 1562797978088,
"message": "Lambda invocation result.\n\nId: 41f40266-52f9-4593-8907-3e214ae10eb9\nName: foo\n\nHello World!\n",
"type": "Information"
}
}
Search Event Logs
Request
Searches the Event Logs using the given search criteria
GET /api/system/event-log/search?message={message}&start={start}&end={end}&type={type}
When calling the API using a GET
request you will send the search criteria on the URL using request parameters. In order to simplify the example URL above, not every possible parameter is shown, however using the provided pattern you may add any of the documented request parameters to the URL.
Request Parameters
- end [Long] Optional
-
The end instant of the date/time range to search within.
- message [String] Optional
-
The string to search in the Event Log message for. This can contain wildcards using the asterisk or percent characters (* or %).
- numberOfResults [Integer] Optional defaults to
25
-
The number of results to return from the search.
- orderBy [String] Optional defaults to
insertInstant DESC
-
The database column to order the search results on plus the order direction.
The possible values are:
-
insertInstant
- the instant when the Event Log was created -
insertUser
- the user that create the Event Log -
message
- the message of the Event Log -
type
- the type of the Event LogFor example, to order the results by the insert instant in a descending order, the value would be provided as
insertInstant DESC
. The final string is optional can be set toASC
orDESC
.
-
- start [Long] Optional
-
The start instant of the date/time range to search within.
- startRow [Integer] Optional defaults to
0
-
The offset row to return results from. If the search has 200 records in it and this is 50, it starts with row 50.
- type [String] Optional
-
The type of Event Logs to return. Only one type may be provided. If omitted, all types will be returned.
The possible values are:
-
Information
-
Debug
-
Error
-
Searches the Event Logs using the given search criteria
POST /api/system/event-log/search
When calling the API using a POST
request you will send the search criteria in a JSON request body.
Request Body
- search.end [Long] Optional
-
The end instant of the date/time range to search within.
- search.message [String] Optional
-
The string to search in the Event Log message for. This can contain wildcards using the asterisk or percent characters (* or %).
- search.numberOfResults [Integer] Optional defaults to
25
-
The number of results to return from the search.
- search.orderBy [String] Optional defaults to
insertInstant DESC
-
The database column to order the search results on plus the order direction.
The columns you can use for this are:
-
insertInstant
- the instant when the Event Log was created -
insertUser
- the user that create the Event Log -
message
- the message of the Event LogFor example, to order the results by the insert instant in a descending order, the value would be provided as
insertInstant DESC
. The final string is optional can be set toASC
orDESC
.
-
- search.start [Long] Optional
-
The start instant of the date/time range to search within.
- search.startRow [Integer] Optional defaults to
0
-
The offset row to return results from. If the search has 200 records in it and this is 50, it starts with row 50.
- search.type [String] Optional
-
The type of Event Logs to return. Only one type may be provided. If omitted, all types will be returned.
The possible values are:
-
Information
-
Debug
-
Error
-
{
"search": {
"end": "1655242262478",
"message": "*",
"numberOfResults": 50,
"start": "1655242262370",
"type": "Information"
}
}
Response
The response for this API contains the Event Logs matching the search criteria in paginated format.
Code | Description |
---|---|
200 |
The request was successful. The response will contain a JSON body. |
400 |
The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
401 |
You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
404 |
The object you requested doesn’t exist. The response will be empty. |
500 |
There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
503 |
The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body. |
Response Body
- eventLogs [Array]
-
The list of Event Logs returned by the search.
- eventLogs
[x]
.id [Long] -
The Event Log unique Id.
- eventLogs
[x]
.insertInstant [Long] -
The instant when the Event Log was created.
- eventLogs
[x]
.message [String] -
The message of the Event Log.
- eventLogs
[x]
.type [String] -
The type of the Event Log. Possible values are:
-
Information
-
Debug
-
Error
-
- total [Integer]
-
The total number of Event Logs matching the search criteria. Use this value along with the numberOfResults and startRow in the Search request to perform pagination.
{
"eventLogs": [
{
"id": 1,
"insertInstant": 1562797978088,
"message": "Lambda invocation result.\n\nId: 41f40266-52f9-4593-8907-3e214ae10eb9\nName: foo\n\nHello World!\n",
"type": "Information"
}
],
"total": 1
}
Feedback
How helpful was this page?
See a problem?
File an issue in our docs repo
Have a question or comment to share?
Visit the FusionAuth community forum.