Skip to main content

Custom logs

Custom logs allow you to see the contents of the log output from the original process. Logs should be prepared in the original process as {logger msg1=$json msg2=$output msg3=$smarty.request msg4='test4'}.

Accessing the screen

In the left sidebar menu, click [Operation] -> [Log management].
Image from Gyazo

Click [Log management] above the page title, and select [API request log] in the dropdown menu.
Image from Gyazo

Field descriptions

Image from Gyazo

Filter conditions

You can filter the logs easily using the keywords search and log date/time, advanced search functions.

Image from Gyazo

Enter the search keyword in the [Keyword] text box and click [Search] to filter logs that contain the specified keyword.

Image from Gyazo

Select the date and time range for the timestamp and click [Search].   The designated logging period is 35 days. When specifying past log dates, please make sure to specify within the 35-day range.

You can create refinements by clicking the "Advanced Search" button and setting different filter conditions.
Image from Gyazo

The following option is available:

FieldDescriptionSpecifiable conditions
HostSite accessed.Available search operations
Log levelLog level indicating the importance of the message.Available search operations
Message[1]-[4]Supplemental information about the log.Available search operations
URIURI of the request endpoint.Available search operations
Client IP addressIP address of the user making the request.Available search operations
Member IDMember ID of the user who attempted the access.Available search operations
Application request IDUnique request ID used by Kuroco.Available search operations
User agentUser agent of the browser used for the access.Available search operations

The advanced search function allows you to concatenate multiple conditions using AND or OR.

  • AND: Returns only data matching all the specified conditions in your search.
  • OR: Returns data matching any of your specified conditions.
Available search operations

You can specify the following operations in the search conditions:

OperationInput typeReturned data
containsText stringEntries matching part of the search term.
not containsText stringEntries not matching any part of the search term.
=Alphanumeric stringEntries exactly matching the search term.
!=Alphanumeric stringEntries not exactly matching the search term.
<Alphanumeric stringEntries less than the search term.
>Alphanumeric stringEntries greater than the search term.
<=Alphanumeric stringEntries less than or equal to the search term.
>=Alphanumeric stringEntries greater than or equal to the search term.
starts withText stringEntries beginning with the search term.
not starts withText stringEntries not beginning with the search term.  
ends withText stringEntries ending with the search term.
not ends withText stringEntries not ending with the search term.
inAlphanumeric stringEntries matching any of the search terms (for multiple search terms only).
not inAlphanumeric stringEntries not matching any of the search terms (for multiple search terms only).
Sort

Under "Sort", you can specify the sort key and display order of the search results.

  • ASC: Ascending, from oldest to newest.
  • DESC: Descending, from newest to oldest.

Log entries

The columns displayed for the log entries are as follows:

ColumnDescription
TimestampDate and time the log was recorded.
HostSite accessed.
Log levelLog level indicating the importance of the message. See: Log levels below for details.
Message[1]-[4]Supplemental information about the log.
URIURI of the request endpoint.
Client IP addressIP address of the user making the request.
Member IDMember ID of the user who attempted the access.
Application request IDUnique request ID used by Kuroco.
User agentUser agent of the browser used for the access.

Log levels

Logs can be categorized into the 9 levels below, listed in order of increasing importance:

  • Default
  • Debug
  • Info
  • Notice
  • Warning
  • Error
  • Critical
  • Alert
  • Emergency

Buttons

Image from Gyazo

ButtonDescription 
SearchSearch based on the above settings.  
DownloadDownload a list of the displayed logs.
DeleteDelete a list of the displayed logs.

Log list download

Image from Gyazo

After click [Download] button, the download settings will open. Image from Gyazo

Field(s)Description 
CharsetCharacter encoding of the output CSV file.
CancelCancel downloading.
DownloadExecute downloading.

Support

If you have any other questions, please contact us or check out Our Slack Community.