Skip to main content

System Logs

System logs are used to query GatewayRuntime's backend runtime, user operation records, RPC call records (records of external system gateway calls), SQL execution records (database execution records), and security audit records (login and permission records). When troubleshooting, usually first check the backend logs to confirm runtime anomalies, then combine them with operation logs or RPC logs to identify who and when the operation was triggered.

First, look at the terminology

TerminologyOn-site understanding
Backend logsGateway program runtime logs, Used to check service start-stop, plugin loading, exceptions, and error stacks.
Operation LogsRecords of user actions such as adding, editing, deleting, starting/stopping, importing, and exporting on a web page.
RPC LogsRecords of external system or protocol entry points initiating write, read, control, and other calls to the gateway.
SQL logsdatabase execution records, used to troubleshoot issues such as import failures, slow queries, and slow exports.
Audit LogsLogin, permission, and account security records, suitable for checking who has logged in and whether permissions have been adjusted.
Trace / Debug / Info / Warning / Errorlog detail. Trace and Debug are the most detailed; after joint debugging, they should be restored to the Info or configured according to on-site requirements.

Function Entry

After logging into GatewayRuntime Web, click the "System Management → System Logs" menu on the left.

System Log Page

Log Tab

TabPurpose
Background LogsView runtime logs such as service start/stop, plugin loading, running exceptions, and error stacks.
Operation LogsView records of additions, edits, deletions, start-stops, and other operations performed by users on web pages.
RPC LogsView records of write, read, control, and other calls initiated by external systems through interfaces or protocol entries.
SQL LogsView the SQL execution status of the database, execution time, execution results, and error messages.
Audit LogsView login audits, permission audits, and user security audit records; This tab requires audit log permissions.
Prompt

Channel and device logs are available from Collection Configuration. Select the device, click More Functions, and open the Channel Log or Device Log tab.

Troubleshooting Order

There are many logs, so it's not recommended to start a global search from the start. First, locate the log type by fault phenomenon, then narrow down the time range.

Fault PhenomenaPrioritize viewing
Offline devices, variable valuesCollect channel logs and device logs in configuration, then look at the backend logs.
Data not forwardedThe forwarding target logs and group logs on the forwarding page are then checked in the backend.
Page operation failureOperation log, then check the backend log for the same period of anomaly.
External system writes failedRPC logs; if necessary, check device logs and background logs.
Login, permission, or account anomaliesAudit logs, operation logs.
Database is slow or export failsSQL logs, background logs.

Background Logs

Background Logs are used to check the GatewayRuntime itself.

Operation ItemsDescription
Log LevelBy Trace, Debug, Info, Warning, Error, and Critical level filtering.
Time RangeLimit the time when the log occurred.
KeywordsSearch by log content or anomalous information.
Query/ResetQuery by condition or restore the default filter conditions.
ExportExport logs within the current query range.
Automatic RefreshContinuously update the log list according to the refresh interval provided by the page.
DetailsOpen the log details to view the full log content and anomalies.
columnExplanation
timelog occurrence time.
LevelLog Level.
SourceLog source.
Log ContentLog Messages.
Exception informationDetails of the exception stack or error.

Operation Log

Operation log is used to track business operations performed by users on web pages.

Operation Log Page

Filter ItemsDescription
Operation CategoriesFilter by function category, such as configuration, permissions, operation control, etc.
Operation NameFilter by specific operation name.
Operating AccountsFilter by the login account that performs the operation.
Run StatusFilter for success or failure records.
Time RangeLimit the time when operations occur.
columnDescription:
timeoperation occurrence time.
Category / NameThe category to which the operation belongs and the operation name.
MethodName of the method called by the operation.
Operating AccountUser performing the operation.
IP addressuser's access source address.
StatusOperation successful or failed.
MessageExplanation of operation results.

Click "Details" to view the request method, address, parameters, processing results, and error messages. For issues involving account, permission, or configuration adjustments, the details of the operation log should be saved first.

RPC Log

RPC log is used to view calls initiated by external systems to the gateway.

RPC log page

FilterDescription
Search keywordsSearch by call source, device, object, method, or message.
StatusFilter for successful or failed calls.
Time RangeLimit call times.
columnExplain the
timethe time the call occurred.
Source of OperationsSource of call, such as external systems, protocol entry, or interface callers.
Operate the deviceCall the associated device.
Operation ObjectThe Object being Invoked.
Operation MethodsWrite, read, or other calling methods.
StateWhether the call was successful.
MessageInvocation result or failure reason.

SQL Logs

SQL logs are used to troubleshoot database access issues and slow queries.

SQL Log Page

Filter ItemsDescription
SQL KeywordsSearch by SQL Statement Content.
StatusFilter successful or failed SQL files.
Time RangeLimit SQL execution time.
columnDescribes
timeSQL execution time.
StatusExecution successful or failed.
Execution DurationSQL execution time is time.
SQL statementsexecuted SQL content.
Error messagesError explanations on failure.

Click "Details" to view SQL parameters, execution time, number of affected rows, database configuration, and complete error messages.

Audit Logs

Audit logs are used to track logins, permission adjustments, and user security events.

Audit Log Page

Audit TypeDescription
Login AuditQuery login username, login type, success status, failure reason, IP address, and User-Agent.
Permission AuditingQuery role permission changes, including before, after, and operator changes.
User Security AuditQuery security actions related to user locking, unlocking, session revocation, and passwords.

Troubleshooting Recommendations

PhenomenaRecommendations to Check
Page Operation FailuresFirst check the failure message in the operation log, then check if the backend log has an exception stack.
External system write failureReview RPC logs to confirm the source of operations, target devices, methods, and cause of failure.
Slow database responseCheck the execution duration of SQL logs and SQL statements.
Account Abnormal LoginView Login Audit and User Security Audit in the Audit Log.