Skip to content

Commit 5ebf168

Browse files
authored
DOC-2746-Updated troubleshooting page and added reference to Log files page [3.6]
1 parent f34aae8 commit 5ebf168

File tree

1 file changed

+4
-33
lines changed

1 file changed

+4
-33
lines changed

modules/troubleshooting/pages/troubleshooting-guide.adoc

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@ This troubleshooting guide is only up to date for v2.6 and below. +
77
Additional guidance for v3.0+ is in development.
88
====
99

10-
== Introduction
10+
The Troubleshooting Guide teaches you how to monitor the status of your TigerGraph system, and when needed, find the log files in order to get a better understanding of why certain errors are occurring. This guide covers log file debugging for data loading and querying.
11+
12+
For a overview of available log files, their locations, and what information they contain, please refer to the xref:troubleshooting:log-files.adoc#_available_log_files[Log Files] documentation page.
1113

12-
The Troubleshooting Guide teaches you how to monitor the status of your TigerGraph system, and when needed, find the log files in order to get a better understanding of why certain errors are occurring. This section covers log file debugging for data loading and querying.
1314

1415
== General
1516

16-
Before any deeper investigation, always run these general system checks :
17+
Before any deeper investigation, always run these general system checks:
1718

1819
[source,console]
1920
----
@@ -31,36 +32,6 @@ $ grun all "date" (Make sure the time across all nodes are synchronized
3132
with time difference under 2 seconds. )
3233
----
3334

34-
=== Location of Log Files
35-
36-
The following command reveals the location of the log files :
37-
38-
[source,console]
39-
----
40-
gadmin log
41-
----
42-
43-
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.
44-
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.
45-
46-
[NOTE]
47-
====
48-
The .out file extension is for errors. +
49-
The .INFO file extension is for normal behaviors.
50-
====
51-
52-
In order to diagnose an issue for a given component, you'll want to check the .out log file extension for that component.
53-
54-
image::https://lh5.googleusercontent.com/6MnNakec5fKh5faCoWdZwfzprqXyguDZXt15nz0QAG1M3vW1t0nmwo7oYr3DgwVsgJoIEjub-5tSA81UtOQ-Ot-9m30zZ9Zr5tRG077dgfZ7KaE3tMMafUK63oi6fILQeM-kQw6fKqc[]
55-
56-
Other log files that are not listed by the *`gadmin log`* command are those for Zookeeper and Kafka, which can be found here:
57-
58-
[source,console]
59-
----
60-
zookeeper : ~/tigergraph/zk/zookeeper.out.*
61-
kafka : ~/tigergraph/kafka/kafka.out
62-
----
63-
6435
=== Synchronize time across nodes in a cluster
6536

6637
TigerGraph will experience a variety of issues if clocks across different nodes in a cluster are out of sync. If running `grun all "date"` shows that the clocks are out of sync, it is highly recommended that you install NTP implementations such as https://chrony.tuxfamily.org/index.html[`chrony`] or http://manpages.ubuntu.com/manpages/xenial/man8/systemd-timesyncd.service.8.html[`timesyncd`] to keep them in sync.

0 commit comments

Comments
 (0)