Skip to content

DOC-2746-Added info on Log File Extensions #815

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 4.2
Choose a base branch
from
Open

DOC-2746-Added info on Log File Extensions #815

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions modules/troubleshooting/pages/troubleshooting-guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,20 +40,24 @@ The following command reveals the location of the log files:
gadmin log
----

You will be presented with a list of log files. The left side of the resulting file paths is the component for which the respective log file is logging information.
The majority of the time, these files will contain what you are looking for. You may notice that there are multiple files for each TigerGraph component.
This command will list the log files, and the left side of the resulting file paths indicates the respective component's log file.
Typically, these files contain the information you're looking for. Each TigerGraph component has multiple associated log files.

[NOTE]
====
The .out file extension is for errors. +
The .INFO file extension is for normal behaviors.
====
*Log File Extensions*

* `.out` files capture *standard output (stdout)* and log runtime information, including error stack traces when services crash or unexpected errors occur.
These logs are especially useful for errors that aren't logged by the service's internal logging mechanism.

In order to diagnose an issue for a given component, you'll want to check the .out log file extension for that component.
* `.ERROR` files are used to log errors captured by the system, typically from exceptions caught in try-catch blocks. If an error occurs before the logging system initializes or is uncaught, it is logged in the `.out` file instead.

* `.INFO` files log regular operational information about the system's normal functioning.

To diagnose an issue for a given component, check the `.out` log file for that component.

image::https://lh5.googleusercontent.com/6MnNakec5fKh5faCoWdZwfzprqXyguDZXt15nz0QAG1M3vW1t0nmwo7oYr3DgwVsgJoIEjub-5tSA81UtOQ-Ot-9m30zZ9Zr5tRG077dgfZ7KaE3tMMafUK63oi6fILQeM-kQw6fKqc[]

Other log files that are not listed by the *`gadmin log`* command are those for Zookeeper and Kafka, which can be found here:
*Other Logs*
For components like Zookeeper and Kafka, the log files are not listed by `gadmin log`. You can find them in the following locations:

[source,console]
----
Expand Down Expand Up @@ -662,4 +666,4 @@ else
echo; echo "Support Collection has been saved as $supportdir.tar.xz"
fi
----
====
====