Logs
The Logs page contains a search panel, a file directory panel, and a content panel. The content panel either displays log content or search results.
|
Due to IP address blocking, an error message may appear if you have an ad blocker installed on your browser. Please turn off your ad blocker when using Admin Portal. |
Open a log file from the file directory
In the file directory panel, all machines will be listed in a tree structure. Click a machine ID to show the components, and click again to show log files and folders.
Choose one single log file by clicking on it, and the content will be shown in the display panel.
The title will show the machine ID and the path of the opened log file. To the right, there is a download button 
for downloading the selected log file.
Loaded log lines will add to the end of the file (the latest log content) and the system will keep pulling to update the log.
|
Note that the display panel will only show the tail end of the chosen log file, up to 32 MB. If you wish to read the entire log file, download the file. |
Search logs
If your browser window is wide, you will see the search panel at the top.
If your browser window is narrow, the search panel collapses. Click the 
button to open it.
In the search panel, you need to provide the following three pieces of information:
-
Pattern
-
Node
-
Component
Without a pattern and at least one node and one component, the search will not be performed.
Use the expand 
or collapse 
buttons for more space to view the log content, if necessary.
The title of each search result contains the machine ID, the file path and the number of lines of content which match the pattern. The detailed log line content will also be shown:
Clicking on a single search result will show the log content in the display panel and highlight the matching log line.
.png)
Read-Only Access to Logs
As of version 4.1, TigerGraph introduces the ability to grant application developers read-only access to logs. This feature enables developers to:
-
Debug: Identify and resolve issues using system and GSQL query logs.
-
Optimize Queries: Analyze logs to fine-tune queries for better performance.
-
Monitor System Health: Track system activity without requiring administrative intervention.
Developers can access logs through:
-
GraphStudio: A user-friendly interface with log viewing, searching, and downloading features.
-
TigerGraph Cloud Portal: Allows developers to monitor and debug logs in real time.
Privileges
The following privileges control access to logs in TigerGraph:
APP_ACCESS_LOG Privilege
APP_ACCESS_LOG privilege grants authorized users global read-only access to logs via GraphStudio or the Cloud Portal.
| Privilege Name | Object | Plural Objects | Scope | Default Roles |
|---|---|---|---|---|
APP_ACCESS_LOG |
LOG |
LOGS |
GLOBAL |
superuser, globaldesigner |
READ_LOG Privilege
The READ_LOG privilege grants read-only access to logs, preventing modifications while enabling monitoring and debugging.
| Privilege Name | Object | Plural Objects | Scope | Default Roles |
|---|---|---|---|---|
READ_LOG |
LOG |
LOGS |
GLOBAL |
None |
Access Points
Users with the appropriate privileges can access logs through GraphStudio or the TigerGraph Cloud Portal:
-
View Logs: Access real-time updates for GSQL query logs and system logs.
-
Search Logs: Use the search panel to filter logs by patterns, nodes, and components.
-
Download Options: Download log files for offline analysis to identify and resolve issues effectively.
|