About the contents of the operation log (SysLogs table)
Overview¶
Pleasanter records the results of user operations as system logs in the SysLogs table of the database (Implem.Pleasanter). You can display and export the recorded logs on the "System Log Management Function" screen. This page describes the items displayed on that screen.
Displayed Items¶
The items displayed in the list of the System Log Management screen are the same as the exported items.
- "Column" is the name of the column in the SysLogs table.
- Items marked "○" in "Filter" can be specified as "Filter" conditions.
- "SysLogsSchemaVersion" lists the values of the "SysLogsSchemaVersion" parameter in "Rds.json" with which the item is displayed. To change the value, see "System Log Extended Function".
| Screen label | Column | Filter | SysLogsSchemaVersion | Content |
|---|---|---|---|---|
| Log ID | SysLogId | ○ | 1, 2, 3 | The ID that uniquely identifies the log. |
| Log type | SysLogType | ○ | 1, 2, 3 | The type of the log. See "Log Type Values" below for the values. |
| Machine name | MachineName | ○ | 1, 2, 3 | The host name and OS of the Pleasanter web server, in the format "host name:OS". |
| Class | Class | ○ | 1, 2, 3 | The name of the controller requested by the user (part of the URL). |
| Method | Method | ○ | 1, 2, 3 | The name of the action requested by the user (part of the URL). |
| API | Api | ○ | 2, 3 | Whether the request came from the API. |
| Site ID | SiteId | - | 2, 3 | The site ID of the reference. |
| Reference ID | ReferenceId | - | 2, 3 | The site ID if the reference is a table, or the record ID if it is a record. |
| Reference type | ReferenceType | ○ | 2, 3 | One of "Sites", "Issues", "Results", or "Wikis", according to the reference type. |
| Status | Status | ○ | 2, 3 | The HTTP status code. See "Status Code and Details" in "System Log Extended Function" for the values and examples. In the filter, you can select multiple status codes. |
| Description | Description | ○ | 2, 3 | "Class name.method name:line line number:message displayed on screen" in the source code. |
| Request data | RequestData | ○ | 1, 2, 3 | The encoded string of the form data sent by the user. |
| Http method | HttpMethod | ○ | 1, 2, 3 | The HTTP method sent by the user. |
| Request size | RequestSize | - | 1, 2, 3 | The size of the POSTed data. |
| Response size | ResponseSize | - | 1, 2, 3 | The size of the data returned from the server. |
| Elapsed time | Elapsed | - | 1, 2, 3 | The time (in milliseconds) the server took to process the request. |
| Url | Url | ○ | 1, 2, 3 | The URL requested by the user. |
| Referer | UrlReferer | ○ | 1, 2, 3 | The URL of the page the user had open just before. |
| User host name | UserHostName | ○ | 1, 2, 3 | The IP address of the access source. If the access goes through a proxy or similar, it may be the same IP address.※ |
| User address | UserHostAddress | ○ | 1, 2, 3 | The IP address of the access source. Up to the first 16 characters are recorded when "SysLogsSchemaVersion" is "1" or "2", and up to 50 characters when it is "3", so IPv6 addresses are recorded without truncation only when it is "3".※ |
| User language | UserLanguage | ○ | 1, 2, 3 | The user's language. |
| User agent | UserAgent | ○ | 1, 2, 3 | The user's browser. |
| Error message | ErrMessage | ○ | 1, 2, 3 | The message when an error occurs. |
| Error stack trace | ErrStackTrace | ○ | 1, 2, 3 | The stack trace when an error occurs. |
| Assembly version | AssemblyVersion | - | 1, 2, 3 | The version of Pleasanter. |
| Tenant ID | TenantId | ○ | 3 | The ID of the tenant being accessed: the tenant of the logged-in user, or, for access to a published site or form without logging in, the tenant of that site. For other access without logging in (such as displaying the login screen), "0" is recorded. Logs recorded before "SysLogsSchemaVersion" was changed to "3" also have "0". The filter is displayed only for privileged users of the protected tenant. For details, see "Differences in Displayed Logs by Tenant" in "System Log Management Function". |
| Created by | Creator | ○ | 1, 2, 3 | The logged-in user. |
| Created on | CreatedTime | ○ | 1, 2, 3 | The date and time the log was recorded. |
※For direct access, UserHostName and UserHostAddress are set to the same source IP address. When the access goes through a proxy or load balancer, they may have different values.
Log Type Values¶
| Log type | Value recorded in the SysLogs table |
|---|---|
| Info | 10 |
| Warning | 50 |
| UserError | 60 |
| SystemError | 80 |
| Exception | 90 |