×

☰ Table of Contents

TigerGraph Docs : TigerGraph System Administration FAQs

Version 1.0
Document Updated:

Copyright © 2015-2017 TigerGraph. All Rights Reserved.
For technical support on this topic, contact support@tigergraph.com with a subject line beginning with "FAQ"


TigerGraph System Administrator FAQs

In this document, all commands should be executed as TigerGraph user, unless specified.


How to apply or update my license key?

During install, 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, use the following command:

gadmin set-license-key <your_license_key>


When my license key expire?

The following command will tell you your key's expiration date:

gadmin status license

What are the components of the TigerGraph platform?

GPE GSE RESTPP ZK KAFKA DICT GSQL GLIVE VISUALIZATION (GraphStudio)

A description of each component is given in the Glossary section of the TigerGraph Platform Overview document.

How can I find out current status of the system?

The following command tells you the basic summary of each component:

gadmin status

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

How can I find out the port of a service?

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 44240. Use the following to check its configuration:

gadmin --dump-config |grep gstudio.web.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

How do I backup my data?

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 v1.0 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.

How do I restore a backup?

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.

How can I find out statistics of my graph data?

The command

gadmin status graph -v

will tell you the size of graph data on disk, number of vertices and edges.

How can I find out statistics of requests?

TigerGraph provides a RESTful API to tell request statistics. Assuming REST port is 9000, use command below:

curl -l http://localhost:9000/statistics

How do I restart a service?

If you need to restart everything, use the following:

gadmin restart

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.

How to I stop some or all services?

Normally it is not necessary to manually turn off any services. However if you wish to, use the stop command.

# stop (nearly) all services gadmin stop # stop selected services gadmin stop <component_name(s)>


Note: runnng "gadmin stop" still does not stop every single TigerGraph service.  Glive 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:

Full shutdown
gadmin stop glive -y gadmin stop -f -y gadmin stop admin -y


Why the service is down?

There are a few typical causes for a service being down:

  1. Expired license key.
    Double check your license key expiration date, and contact support@tigergraph.com 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.
  2. 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 <span>dmesg</span> to check.
  3. 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 <span>df</span> .

Where are the logs?

Use following command to figure out where are log files for each component:

gadmin log

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]


Why has my request timed out?

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-apply gadmin restart