If you have a version 1.0 string-type license key, then during initial platform installation, you can either specify your license key as an argument, for example:
./install.sh -l <your_license_key>
Or you may input it when prompted.
To apply a new license key string, use the following command:
gadmin set-license-key <your_license_key>
If you have a version 2.0 file-type license key which is linked to a specific machine or cluster:
If this is the initial installation or you are updating a previous key file, then please see the document Activating a System-Specific License
If you are updating from a version 1.0 key string to a version 2.0 key file, please contact email@example.com for the correct procedure.
If you have a version 1.0 string-type license key, the following command will tell you your key's expiration date:
gadmin status license
If you have a version 2.0 file-type license key which is linked to a specific machine or cluster, then run the following command:
curl -X GET "localhost:9000/showlicenseinfo"
A description of each component is given in the Glossary section of the TigerGraph Platform Overview document.
The following command tells you the basic summary of each component:
If you want to know more, including process information, memory/cpu usage information of each component, use the -v option for verbose output.
gadmin status -v
The default RESTful API port is 9000. It can be changed by configuration. To find out the current RESTful API port, use following command:
gadmin --dump-config | grep nginx.port
The default port for the GraphStudio UI is 14240. (Prior to TigerGraph 1.2, it was 44240.) Use the following to check its configuration:
gadmin --dump-config | grep nginx.services.port
If you are using a remote GSQL client, it communicates with the GSQL server via port 8123.
gadmin --dump-config | grep gsql.server.port
To see a list of all ports:
gadmin --dump-config | grep port
GBAR is the utility to do backup and restore of TigerGraph system. Before a backup, GBAR needs to be configured. Please see GBAR - Graph Backup and Restore for details.
To backup the current system:
gbar backup -t <tag_of_the_backup>
Please be advised that GBAR only backs up data and configuration. No logs or binaries will be backed up.
To restore an existing backup:
gbar restore <tag_of_the_backup>
Please be advised that running restore will STOP the service and ERASE existing data.
gadmin status graph -v
will tell you the size of graph data on disk, number of vertices and edges.
TigerGraph provides a RESTful API to tell request statistics. Assuming REST port is 9000, use command below:
curl -l http://localhost:9000/statistics
If you need to restart everything, use the following:
If you know which component(s) you want to restart,you can list them:
gadmin restart <component_name(s)>
Multiple component names are separated by spaces.
Normally it is not necessary to manually turn off any services. However if you wish to, use the stop command.
# stop (nearly) all servicesgadmin stop# stop selected servicesgadmin stop <component_name(s)>
Note: running "gadmin stop" still does not stop every single TigerGraph service. Ts3 will still run because it is monitoring other services, and the Admin server will still run because it manages the other services. If you need to perform a full shutdown, for example, before a software upgrade or before a hardware change, perform the following sequence of commands:
gadmin stop ts3 -ygadmin stop -f -ygadmin stop admin -y
There are a few typical causes for a service being down:
Expired license key. Double check your license key expiration date, and contact firstname.lastname@example.org if it is expired. After applying a new license key, your service will come back online. Usually, TigerGraph will reach out before your license key expires. Please act accordingly when that happens.
Not enough memory. TigerGraph is a memory intensive system. When there is not much free memory, Linux may kill a process based on memory usage. Please check your memory usage after TigerGraph starts. We suggest at least 30% free memory after TigerGraph starts up. To confirm if one of TigerGraph's processes is a victim, use dmesg to check.
Not enough free disk space. TigerGraph writes data, logs, as well as some temporary files onto disk(s). It requires enough free space to function properly. If TigerGraph service or one of its components is down, please check whether there is enough free space on the disk using df .
Use following command to figure out where are log files for each component:
To log at the log file for a particular component:
gadmin log <component>
If you want to look at only the last N lines of the log:
gadmin log -v [component] [-n number_of_lines]
Timeout is applied to any request coming into TigerGraph system. If a request runs longer than the Timeout value, it will be killed. The default timeout value is 16 second.
If you knows that your query will run longer than the value, configure all related timeouts to a bigger value. To do this:
gadmin --configure timeout_seconds
Input a value you expected, the unit is in second. Then apply the config to the system and restart the service.
gadmin config-applygadmin restart
The timeout can also be changed for each query, but only when calling the REST endpoint. You would need to use a timeout value each time you run a query, otherwise the default timeout value will be assumed.
curl -X <GET/POST> -H "GSQL-TIMEOUT: <timeout value in milliseconds>" '<request_URL>'
A core dump file is produced by the OS when a certain signal causes a process to terminate. The core dump is a disk file containing an image of the process's memory at the time of termination. This image can be used in a debugger (e.g., gdb) to inspect the state of the program at the time that it terminated.
The TigerGraph installation process configures the operating system to place core dump files in the TigerGraph root directory, with the name core-%e-%s-%p.%t, where
%e: executable filename (without path prefix)
%s: signal number which caused the dump
%p: PID of dumped process
%t: time of dump, expressed as seconds since the epoch
The coredump configuration was set by the following command:
echo "$coreLocation/core-%e-%s-%p.%t" > /proc/sys/kernel/core_pattern
If you want to alter the location or file name template, you can edit the contents of