Configuration Parameters
This page provides a comprehensive list of system configuration parameters.
See Guide to management with gadmin for how to use gadmin config
to set configuration parameters.
The parameters are organized by TigerGraph internal component, listed here in alphabetical order: Admin
, Controller
, Dict
, etc.
In addition, the last table is for runtime environment variables. Each component may have a set of environment variables which are set by xxx.BasicConfig.Env
. See Admin.BasicConfig.Env
below for an example.
Admin
Name | Description | Example |
---|---|---|
Admin.BasicConfig.Env |
A list of |
|
Admin.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
Admin.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
Admin.BasicConfig.LogConfig.LogLevel |
The log
level( |
|
Admin.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
Admin.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of the log directory for Admin |
|
Admin.BasicConfig.Nodes |
The node list for Admin |
|
Admin.Port |
The port for Admin |
|
Controller
Name | Description | Example |
---|---|---|
Controller.BasicConfig.Env |
A list of |
|
Controller.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
Controller.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
Controller.BasicConfig.LogConfig.LogLevel |
The log
level( |
|
Controller.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
Controller.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for Controller |
|
Controller.BasicConfig.Nodes |
The nodes to deploy Controller |
|
Controller.ConfigRepoRelativePath |
The relative path (to the System.DataRoot) of config repo where the service config files are stored |
|
Controller.Connect.PrunerEnabled |
Whether to automatically remove data that was already loaded by GSQL in Kafka. |
|
Controller.Connect.PruneIntervalMin |
The wait time, in minutes, between each prune job that removes data already loaded by GSQL in Kafka. Accepts an integer from 1 to 59, inclusive. |
|
Controller.FileRepoRelativePath |
The relative path (to the System.DataRoot) of the file repo for file management |
|
Controller.FileRepoVersionNum |
The maximum version of files to keep in the file repo |
|
Controller.LeaderElectionHeartBeatIntervalMS |
The maximum interval(milliseconds) at which each service should call controller leader election service to be considered alive. |
|
Controller.LeaderElectionHeartBeatMaxMiss |
The maximum number of heartbeats that can be missed before one service is considered dead by the controller |
|
Controller.Port |
The serving gRPC (Google Remote Procedure Call) port for Controller |
|
Dict
Name | Description | Example |
---|---|---|
Dict.BasicConfig.Env |
A list of |
|
Dict.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
Dict.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
Dict.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
Dict.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for Dict |
|
Dict.BasicConfig.Nodes |
The node list for Dict |
|
Dict.Port |
The port for Dict |
|
ETCD
Name | Description | Example |
---|---|---|
ETCD.BasicConfig.Env |
A list of |
|
ETCD.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
ETCD.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
ETCD.BasicConfig.LogConfig.LogLevel |
The log
level( |
|
ETCD.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
ETCD.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of the log directory for ETCD |
|
ETCD.BasicConfig.Nodes |
The node list for ETCD |
|
ETCD.ClientPort |
The port of ETCD to listen for client traffic |
|
ETCD.DataRelativePath |
The data dir of etcd under |
|
ETCD.ElectionTimeoutMS |
Time (in milliseconds) for an election to timeout |
|
ETCD.HeartbeatIntervalMS |
Time (in milliseconds) of a heartbeat interval |
|
ETCD.MaxRequestBytes |
Maximum client request size in bytes the server will accept |
|
ETCD.MaxSnapshots |
Maximum number of snapshot files to retain (0 is unlimited) |
|
ETCD.MaxTxnOps |
Maximum number of operations permitted in a transaction |
|
ETCD.MaxWals |
Maximum number of wal files to retain (0 is unlimited) |
|
ETCD.PeerPort |
The port of ETCD to listen for peer traffic |
|
ETCD.SnapshotCount |
Number of committed transactions to trigger a snapshot to disk |
|
Executor
Name | Description | Example |
---|---|---|
Executor.BasicConfig.Env |
A list of |
|
Executor.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
Executor.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
Executor.BasicConfig.LogConfig.LogLevel |
The log
level( |
|
Executor.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
Executor.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for Executor |
|
Executor.BasicConfig.Nodes |
The nodes to deploy Executors |
|
Executor.DataRelativePath |
The data dir of executor under $DataRoot |
|
Executor.FileTransferConcurrency |
The maximum concurrency for Executor file transfer |
|
Executor.FileTransferPort |
The port for Executor to do file transfer |
|
Executor.FileVersionNum |
The maximum version of files to keep |
|
Executor.Port |
The serving port for Executor |
|
Executor.WatchDogIntervalMS |
The process status check interval (ms) |
|
FileLoader
Name | Description | Example |
---|---|---|
FileLoader.BasicConfig.Env |
A list of |
|
FileLoader.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
FileLoader.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
FileLoader.BasicConfig.LogConfig.LogLevel |
The log level( |
|
FileLoader.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
FileLoader.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for FileLoader |
|
FileLoader.Factory.DefaultLoadingTimeoutSec |
The default per request loading timeout (s) for FileLoader |
|
FileLoader.Factory.DefaultQueryTimeoutSec |
The default query timeout (s) for FileLoader |
|
FileLoader.Factory.DynamicEndpointRelativePath |
FileLoader’s relative (to data root) path to store the dynamic endpoint |
|
FileLoader.Factory.DynamicSchedulerRelativePath |
FileLoader’s relative (to data root) path to store the dynamic scheduler |
|
FileLoader.Factory.EnableAuth |
Enable authentication of FileLoader |
|
FileLoader.Factory.HandlerCount |
FileLoader’s handler count |
|
FileLoader.Factory.StatsIntervalSec |
FileLoader’s time interval to collect stats (e.g. QPS) |
|
FileLoader.GPEResponseBasePort |
The port of FileLoader to accept GPE response |
|
FileLoader.GSEResponseBasePort |
The port of FileLoader to accept GSE response |
|
FileLoader.ReplicaNumber |
The number of replicas of Fileloader per node |
|
GPE
Name | Description | Example |
---|---|---|
GPE.BasicConfig.Env |
A list of |
|
GPE.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
GPE.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
GPE.BasicConfig.LogConfig.LogLevel |
The log level ( |
|
GPE.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
GPE.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for GPE |
|
GPE.BasicConfig.Nodes |
The node list for GPE |
|
GPE.Disk.CompressMethod |
The compression method of GPE disk data |
|
GPE.Disk.DiskStoreRelativePath |
The path (relative to temp root) to store GPE temporary disk data |
|
GPE.Disk.LoadThreadNumber |
The number of threads to load from disk |
|
GPE.Disk.SaveThreadNumber |
The number of threads to save to disk |
|
GPE.EdgeDataMemoryLimit |
The memory limit for edge data. |
|
GPE.GPE2GPEResponsePort |
The GPE port for receiving response back from other GPEs |
|
GPE.GPERequestPort |
The GPE port for receiving requests |
|
GPE.IdResponsePort |
The GPE port for receiving id response from GSE |
|
GPE.Kafka.BatchMsgNumber |
The number of messages to send in one batch when using async mode. The producer will wait until either this number of messages are ready to send or queue buffer max ms is reached. |
|
GPE.Kafka.CompressCodec |
This parameter allows you to specify the compression codec for all data generated by this producer. Valid values are none, gzip and snappy. |
|
GPE.Kafka.FetchErrorBackoffTimeMS |
How long to postpone the next fetch request for a topic+partition in case of a fetch error. |
|
GPE.Kafka.FetchWaitMaxTimeMS |
The maximum amount of time the server will block before answering the fetch request if there isn’t sufficient data to immediately satisfy fetch min bytes. |
|
GPE.Kafka.MsgMaxBytes |
Maximum transmit message size. |
|
GPE.Kafka.QueueBufferMaxMsgNumber |
The maximum number of unsent messages that can be queued up the producer when using async mode before either the producer must be blocked or data must be dropped. |
|
GPE.Kafka.QueueBufferMaxTimeMS |
Maximum time to buffer data when using async mode. |
|
GPE.Kafka.QueueMinMsgNumber |
Minimum number of messages per topic+partition in the local consumer queue. |
|
GPE.Kafka.RequestRequiredAcks |
This field indicates how many acknowledgements the leader broker must receive from ISR brokers before responding to the request. |
|
GPE.LeaderElectionTTLSec |
The time-to-live of a GPE election participant. A GPE will be kicked out of election if one GPE is not responsive after the TTL. |
|
GPE.MemoryLimitMB |
The total topology memory limit. For graphs with large topology data, this parameter can limit the system memory used for topology data in order to free up memory for query processing. This parameter takes precedence over the |
|
GPE.NumberOfHashBucketInBit |
The number of bits used to represent hash bucket counts. |
|
GPE.RebuildThreadNumber |
The number of rebuild threads for GPE |
|
GPE.StopTimeoutMS |
Stop GPE timeout |
|
GPE.VertexDataMemoryLimit |
The memory limit for vertex data in the topology. |
|
GSE
Name | Description | Example |
---|---|---|
GSE.BasicConfig.Env |
A list of Some of the environment variables:
|
|
GSE.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
GSE.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
GSE.BasicConfig.LogConfig.LogLevel |
The log level( |
|
GSE.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
GSE.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for GSE |
|
GSE.BasicConfig.Nodes |
The node list for GSE |
|
GSE.IdRequestPort |
The id request serving port of GSE |
|
GSE.JournalTopicPrefix |
Kafka Topic prefix of GSE journal storage/replication |
|
GSE.LeaderElectionTTLSec |
The time-to-live of a GSE election participant.A GSE will be kicked out of election if one GSE is not responsive after the TTL. |
|
GSE.RLSPort |
The serving port of GSE RLS |
|
GSE.StopTimeoutMS |
Stop GSE timeout |
|
GSQL
Name | Description | Example |
---|---|---|
GSQL.BasicConfig.Env |
A list of |
|
GSQL.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
GSQL.BasicConfig.LogConfig.LogLevel |
GSQL log level: ERROR, INFO, DEBUG |
|
GSQL.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
GSQL.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for GSQL |
|
GSQL.BasicConfig.Nodes |
The node list for GSQL |
|
GSQL.CatalogBackupFileMaxDurationDay |
The maximum number of days for catalog backup files to retain |
|
GSQL.CatalogBackupFileMaxNumber |
The maximum number of catalog backup files to retain |
|
GSQL.DataRelativePath |
The data dir of gsql under $DataRoot |
|
GSQL.EnableStringCompress |
Enable string compress |
|
GSQL.FileOutputPolicy |
The policy to control file outputs in GSQL queries |
|
GSQL.GithubBranch |
The working branch in provided repository. Will use `master' as the default branch |
|
GSQL.GithubPath |
The path to the directory in the github that has TokenBank.cpp, ExprFunctions.hpp, ExprUtil.hpp, e.g. sample_code/src |
|
GSQL.GithubRepository |
The repository name, e.g. tigergraph/ecosys |
|
GSQL.GithubUrl |
The url that is used for github enterprise, e.g. https://api.github.com |
|
GSQL.GithubUserAcessToken |
The credential for github. Set it to `anonymous' for public access, or empty to not use github |
|
GSQL.GrpcMessageMaxSizeMB |
The maximum size of grpc message request of gsql |
|
GSQL.HA.BufferedReaderBufferSizeBytes |
Customizes the buffer size (in bytes) for messages sent between GSQL servers in a HA cluster. |
|
GSQL.LoginLimit.InitialWaitTimeSec |
The amount of time in seconds a user has to wait for the subsequent login after the number of successive failed login attempts reaches the initial threshold. |
|
GSQL.LoginLimit.InitialThreshold |
The number of successive failed login attempts since the last successful login to apply the wait time for the subsequent login attempts. Set 0 to disable the rate limiting. |
|
GSQL.LoginLimit.SecondaryThreshold |
The number of successive failed login attempts after reaching the initial threshold that the wait time will be doubled for every this number of successive failed login attempts afterward. |
|
GSQL.ManageCatalogTimeoutSec |
GSQL connection timeout (second) to admin server when trying to download/upload/delete catalog. Default value: 20 |
20 |
GSQL.MaxAuthTokenLifeTimeSec |
The maximum lifetime of auth token in seconds, 0 means unlimited |
|
GSQL.OutputTokenBufferSize |
The buffer size for output token from GSQL |
|
GSQL.Port |
The server port for GSQL |
|
GSQL.QueryResponseMaxSizeByte |
Maximum response size in byte |
|
GSQL.RESTPPRefreshTimeoutSec |
Refresh time in Seconds of Restpp |
|
GSQL.SchemaIndexFileNumber |
File number |
|
GSQL.TokenCleaner.GraceTimeSec |
The grace time (in seconds) for expired tokens to exist without being cleaned |
|
GSQL.TokenCleaner.IntervalTimeSec |
The running interval of TokenCleaner in seconds |
|
GSQL.UDF.EnablePutTokenBank |
Whether to enable the |
|
GSQL.UDF.EnablePutExpr |
Whether to enable the |
|
GSQL.UDF.Policy.Enable |
Whether to enforce a policy on the contents of UDF files (see UDF file scanning). |
|
GSQL.UDF.Policy.HeaderAllowlist |
A default set of C++ headers that are allowed to be included in a UDF file. |
|
GSQL.UserInfoLimit.TokenSizeLimit |
The max number of tokens allowed |
|
GSQL.UserInfoLimit.UserCatalogFileMaxSizeByte |
The file size limit for user metadata in byte |
|
GSQL.UserInfoLimit.UserSizeLimit |
The max number of users allowed |
|
GSQL.WaitServiceOnlineTimeoutSec |
Timeout to wait for all services online |
|
GUI
Name | Description | Example |
---|---|---|
GUI.BasicConfig.Env |
A list of |
|
GUI.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
GUI.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
GUI.BasicConfig.LogConfig.LogLevel |
The log
level( |
|
GUI.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
GUI.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for GUI |
|
GUI.BasicConfig.Nodes |
The node list for GraphStudio |
|
GUI.ClientIdleTimeSec |
The maximum idle time of client-side GraphStudio and AdminPortal before inactivity logout |
|
GUI.Cookie.DurationSec |
GUI Cookie duration time in seconds |
|
GUI.Cookie.SameSite |
Default mode: 1; Lax mode: 2; Strict mode: 3; None mode: 4 |
|
GUI.EnableConcurrentSession |
Enable or disable concurrent sessions for GUI. Setting to |
|
GUI.DataDirRelativePath |
The relative path of gui data folder (to the System.DataRoot) |
|
GUI.EnableDarkTheme |
The boolean value on whether or not GUI should enable dark theme |
|
GUI.GraphQLConfig.SchemaRefreshPeriod |
The schema refresh period of GraphQL service |
|
GUI.GraphStatCheckIntervalSec |
The internval(in seconds) GraphStudio wait before checking the graph statistics |
|
GUI.HTTPRequest.RetryMax |
GUI http request max retry times |
|
GUI.HTTPRequest.RetryWaitMaxSec |
GUI HTTP request max retry waiting time in seconds |
|
GUI.HTTPRequest.RetryWaitMinSec |
GUI HTTP request minimum retry waiting time in seconds |
|
GUI.HTTPRequest.TimeoutSec |
GUI HTTP request timeout in seconds |
|
GUI.Port |
The serving port for GraphStudio Websocket communication |
|
GUI.RESTPPResponseMaxSizeBytes |
The RESTPP response size limit bytes. |
|
GUI.TempDirRelativePath |
The relative path of gui temp folder (to the System.TempRoot) |
|
GUI.TempFileMaxDurationDay |
GUI temp file max duration time in days |
|
Gadmin
Name | Description | Example |
---|---|---|
Gadmin.StartServiceDefaultTimeoutMS |
The start one service default timeout in milliseconds |
|
Gadmin.StartStopRequestTimeoutMS |
The start/stop service default request timeout in milliseconds |
|
Gadmin.StopServiceDefaultTimeoutMS |
The stop one service default request timeout in milliseconds |
|
Informant
Name | Description | Example |
---|---|---|
Informant.BasicConfig.Env |
A list of |
|
Informant.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
Informant.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
Informant.BasicConfig.LogConfig.LogLevel |
The log
level( |
|
Informant.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
Informant.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for Informant |
|
Informant.BasicConfig.Nodes |
The nodes to deploy Informant |
|
Informant.DBRelativePath |
The relative path (to the System.DataRoot) of informant database source folder |
|
Informant.GrpcPort |
The grpc server port for Informant |
|
Informant.RestPort |
The restful server port for Informant |
|
Informant.RetentionPeriodDay |
The period in days for local data records to be kept, set to -1 for forever (not advised). Longer retention results in higher disk space usage and slower search for historical status |
|
Kafka
Name | Description | Example |
---|---|---|
Kafka.BasicConfig.Env |
A list of |
|
Kafka.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
Kafka.BasicConfig.LogConfig.LogLevel |
The log level for kafka
( |
|
Kafka.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
Kafka.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for Kafka |
|
Kafka.BasicConfig.Nodes |
The node list for Kafka |
|
Kafka.DataRelativePath |
The data dir of kafka under $DataRoot |
|
Kafka.IOThreads |
The number of threads for Kafka IO |
|
Kafka.LogFlushIntervalMS |
The threshold of time for flushing log (ms) |
|
Kafka.LogFlushIntervalMessage |
The threshold of message for flushing log |
|
Kafka.MessageMaxSizeMB |
The maximum size of a message of Kafka to be produced (megabytes) |
|
Kafka.MinInsyncReplicas |
The minimal number of insync replicas that must acknowledge, when producer sets acks to `all' |
|
Kafka.NetworkThreads |
The number of threads for Kafka Network |
|
Kafka.Port |
The serving port for Kafka |
|
Kafka.RetentionHours |
The minimum age of a log file of Kafka to be eligible for deletion (hours) |
|
Kafka.RetentionSizeGB |
The minimum size of a log file of Kafka to be eligible for deletion (gigabytes) |
|
Kafka.StartTimeoutMS |
Start kafka timeout |
|
Kafka.TopicReplicaFactor |
The default replica number for each topic |
|
KafkaConnect
Name | Description | Example |
---|---|---|
KafkaConnect.AllowedTaskPerCPU |
[v3.9.2+] Maximum number of allowed connector tasks = (#CPUs) x AllowedTaskPerCPU. Range is [0.5,10]. It is recommended to stay below 2.0. |
|
KafkaConnect.BasicConfig.Env |
A list of |
|
KafkaConnect.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
KafkaConnect.BasicConfig.LogConfig.LogLevel |
The log level for kafka
connect ( |
|
KafkaConnect.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
KafkaConnect.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for Kafka connect |
|
KafkaConnect.BasicConfig.Nodes |
The node list for Kafka connect |
|
KafkaConnect.MaxMemorySizeMB |
The max memory usage limit of Kafka Connect in MB. |
10240 |
KafkaConnect.MaxRequestSize |
The max request size of kafka connect producer |
|
KafkaConnect.OffsetFlushIntervalMS |
The interval at which Kafka connect tasks’ offsets are committed |
|
KafkaConnect.Port |
The port used for kafka connect |
|
KafkaConnect.ReconnectBackoffMS |
The amount of time to wait before attempting to reconnect to a given host |
|
KafkaConnect.RetryBackoffMS |
The amount of time to wait before attempting to retry a failed fetch request to a given topic partition |
|
KafkaLoader
Name | Description | Example |
---|---|---|
KafkaLoader.BasicConfig.Env |
A list of |
|
KafkaLoader.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
KafkaLoader.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
KafkaLoader.BasicConfig.LogConfig.LogLevel |
The log level( |
|
KafkaLoader.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
KafkaLoader.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for KafkaLoader |
|
KafkaLoader.Factory.DefaultLoadingTimeoutSec |
The default per request loading timeout (s) for KafkaLoader |
|
KafkaLoader.Factory.DefaultQueryTimeoutSec |
The default query timeout (s) for KafkaLoader |
|
KafkaLoader.Factory.DynamicEndpointRelativePath |
KafkaLoader’s relative (to data root) path to store the dynamic endpoint |
|
KafkaLoader.Factory.DynamicSchedulerRelativePath |
KafkaLoader’s relative (to data root) path to store the dynamic scheduler |
|
KafkaLoader.Factory.EnableAuth |
Enable authentication of KafkaLoader |
|
KafkaLoader.Factory.HandlerCount |
KafkaLoader’s handler count |
|
KafkaLoader.Factory.StatsIntervalSec |
KafkaLoader’s time interval to collect stats (e.g. QPS) |
|
KafkaLoader.GPEResponseBasePort |
The port of KafkaLoader to accept GPE response |
|
KafkaLoader.GSEResponseBasePort |
The port of KafkaLoader to accept GSE response |
|
KafkaLoader.ReplicaNumber |
The number of replica of kafkaloader per node |
|
KafkaStreamLL
Name | Description | Example |
---|---|---|
KafkaStreamLL.BasicConfig.Env |
A list of |
|
KafkaStreamLL.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
KafkaStreamLL.BasicConfig.LogConfig.LogLevel |
The log level for Kafka
stream LoadingLog ( |
|
KafkaStreamLL.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
KafkaStreamLL.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for Kafka stream LoadingLog |
|
KafkaStreamLL.BasicConfig.Nodes |
The node list for Kafka stream LoadingLog |
|
KafkaStreamLL.MaxPartitionFetchBytes |
Max partition fetch bytes size |
|
KafkaStreamLL.Port |
The port used for Kafka stream LoadingLog |
|
KafkaStreamLL.ReplicaNumber |
The number of standby replicas. Standby replicas are shadow copies of local state stores |
|
KafkaStreamLL.StateDirRelativePath |
The relative folder path for Kafka stream LoadingLog state |
|
Nginx
Name | Description | Example |
---|---|---|
Nginx.AllowedCIDRList |
The allowlist of IPv4/IPv6 CIDR blocks to restrict the application access, separate in comma. |
|
Nginx.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
Nginx.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
Nginx.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
Nginx.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for Nginx |
|
Nginx.BasicConfig.Nodes |
The node list for Nginx |
|
Nginx.ClientMaxBodySize |
The maximum request size for Nginx in MB |
|
Nginx.ConfigTemplate |
The template to generate nginx config. Please use
|
|
Nginx.Port |
The serving port for Nginx |
|
Nginx.ResponseHeaders |
The customized headers in HTTP Response |
|
Nginx.SSL.Cert |
Public certificate for SSL. (Could use @cert_file_path to parse the certificate from file) |
|
Nginx.SSL.Enable |
Enable SSL connection for all HTTP requests |
|
Nginx.SSL.Key |
Private key for SSL. (Could use @key_file_path to parse the key from file) |
|
Nginx.WorkerProcessNumber |
The number of worker processes for Nginx |
|
RESTPP
Name | Description | Example |
---|---|---|
RESTPP.BasicConfig.Env |
A list of |
|
RESTPP.BasicConfig.LogConfig.LogFileMaxDurationDay |
The maximum number of days to retain old log files based on the timestamp encoded in their filename |
|
RESTPP.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
RESTPP.BasicConfig.LogConfig.LogLevel |
The log level( |
|
RESTPP.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
RESTPP.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for RESTPP |
|
RESTPP.BasicConfig.Nodes |
The node list for RESTPP |
|
RESTPP.FCGISocketBackLogMaxCnt |
RESTPP fcgi socket backlog max length which is the listen queue depth used in the listen() call. |
|
RESTPP.FCGISocketFileRelativePath |
The relative path of FCGI socket for RESTPP-Nginx communitation under $TempRoot |
|
RESTPP.Factory.DefaultLoadingTimeoutSec |
The default per request loading timeout (s) for RESTPP |
|
RESTPP.Factory.DefaultQueryTimeoutSec |
The default query timeout (s) for RESTPP |
|
RESTPP.Factory.DynamicEndpointRelativePath |
RESTPP’s relative (to data root) path to store the dynamic endpoint |
|
RESTPP.Factory.DynamicSchedulerRelativePath |
RESTPP’s relative (to data root) path to store the dynamic scheduler |
|
RESTPP.Factory.EnableAuth |
Enable authentication of RESTPP |
|
RESTPP.Factory.HandlerCount |
RESTPP’s handler count |
|
RESTPP.Factory.QueryMemoryLimitMB |
The memory limit of query runs for container on disk. The default value is -1, meaning no limit |
|
RESTPP.Factory.StatsIntervalSec |
RESTPP’s time interval to collect stats (e.g. QPS) |
|
RESTPP.GPEResponsePort |
The port of RESTPP to accept GPE response |
|
RESTPP.GSEResponsePort |
The port of RESTPP to accept GSE response |
|
RESTPP.HttpServer.Enable |
Enable RESTPP’s http server |
|
RESTPP.HttpServer.Port |
RESTPP’s http server port |
|
RESTPP.HttpServer.WorkerNum |
RESTPP’s http server worker number |
|
RESTPP.LoadedOffsetTraceBackHr |
The trace back time (hour) of loaded offset, offsets will not be reported beyond the specified time |
|
RESTPP.NginxPort |
The port of RESTPP to accept upstream Nginx requests |
|
RESTPP.WorkLoadManager.MaxHeavyBuiltinQueries |
The maximum number of concurrent “heavy“ built-in queries (kstep_expansion, searchvertex, allpaths, shortestpath) on a restpp server |
|
RESTPP.WorkLoadManager.MaxConcurrentQueries |
The maximum number of concurrent queries allowed to run, excluding heavy queries |
|
RESTPP.WorkLoadManager.MaxDelayQueueSize |
The maximum number of concurrent queries in the delay queue |
|
RESTPP.QueryRouting.Mode |
Set the query routing mode (0=RoundRobin, 1=CPULoadAware) |
|
RESTPP.QueryRouting.TargetSelectionCPUThreshold |
Set the query routing mode CPU usage threshold |
|
Security
Name | Description | Example |
---|---|---|
Security.JWT.RSA.PublicKey |
Configure a RSA public key for OIDC JWT Authentication. |
|
Security.JWT.HMAC.Secret |
Configure a HMAC Secret for OIDC JWT Authentication. |
|
Security.JWT.Issuer |
Configure the |
|
Security.JWT.Audience |
Configure this JWT Token authentication to verify if the |
|
Security.LDAP.AdminDN |
Configure the DN of LDAP user who has read access to the base DN specified above. Empty if everyone has read access to LDAP data: default empty |
|
Security.LDAP.AdminPassword |
Configure the password of the admin DN specified above. Needed only when admin_dn is specified: default empty |
|
Security.LDAP.BaseDN |
Configure LDAP search base DN, the root node to start the LDAP search for user authentication: must specify |
|
Security.LDAP.Enable |
Enable LDAP authentication: default false |
|
Security.LDAP.GroupFilter |
list of group objects on LDAP server used to retrieve group hierarchy information, default value: (objectClass=group) |
(objectClass=group) |
Security.LDAP.GroupHierarchyRefreshIntervalMin |
Refresh time in minutes of ldap group hierarchy information. default 240 |
60 |
Security.LDAP.Hostname |
Configure LDAP server hostname: default localhost |
|
Security.LDAP.Port |
Configure LDAP server port: default 389 |
|
Security.LDAP.SearchFilter |
Configure LDAP search base DN, the root node to start the LDAP search for user authentication. |
|
Security.LDAP.Secure.Protocol |
Enable SSL/StartTLS for LDAP connection [none/ssl/starttls]: default none |
|
Security.LDAP.Secure.TrustAll |
Configure to trust all LDAP servers (unsafe): default false |
|
Security.LDAP.Secure.TruststoreFormat |
Configure the truststore format [JKS/PKCS12]: default JKS |
|
Security.LDAP.Secure.TruststorePassword |
Configure the truststore password: default changeit |
|
Security.LDAP.Secure.TruststorePath |
Configure the truststore absolute path for the certificates used in SSL: default empty |
|
Security.LDAP.UsernameAttribute |
Configure the username attribute name in LDAP server: default uid |
|
Security.SSO.OIDC.OP.AccessTokenURL |
The API to request access token from OP. Required for OIDC code flow, not needed for implicit flow. Type: |
|
Security.SSO.OIDC.BuiltinUser |
The builtin user for OIDC, default: GSQLoidc |
|
Security.SSO.OIDC.CallBackUrl |
TigerGraph service provider callback URL: default http://127.0.0.1:14240 |
|
Security.SSO.OIDC.ClaimAsUserID |
The OIDC claim which will be used as username in TigerGraph Type: |
|
Security.SSO.OIDC.Enable |
Enable OIDC based SSO [true/false]: default false |
|
Security.SSO.OIDC.OP.ClientId |
The client id assigned by Openid Provider when registers TigerGraph |
|
Security.SSO.OIDC.OP.ClientSecret |
The client secret generated by OIDC provider, this config is only needed if algorithm is HMAC type |
|
Security.SSO.OIDC.OP.JWKSUrl |
The url of the OpenID provider to retrieve the public JSON web key set, e.g. https://op.example.com/.well-known/jwks.json. It is only needed if algorithm is RSA type |
|
Security.SSO.OIDC.OP.Issuer |
Required, not needed for TG-Cloud. Entity that issues a set of claims. Type: |
|
Security.SSO.OIDC.OP.SSOUrl |
Single Sign-On URL: default https://op.example.com/oauth/authorize |
|
Security.SSO.OIDC.OP.SigAlgorithm |
Define the algorithm that OIDC provider used to sign the ID token, [RS256/HS256/…]: default RS256 |
|
Security.SSO.OIDC.OrganizationId |
The organization ID for cloud OpenId server |
|
Security.SSO.OIDC.ResponseType |
Define the kind of credential that OIDC provider will return [code/token/id_token/code id_token/…]: default code |
|
Security.SSO.OIDC.Scope |
Specifies the claims (or user attributes) to retrieve, separated by a space [openid email/openid profile/…]: default openid profile (means user’s full profile). |
|
Security.SSO.OIDC.OP.UserInfoURL |
Required for OIDC code flow, not needed for implicit flow. The API to request user information via an access token. Type: |
|
Security.SSO.SAML.AssertionSigned |
Require Identity Provider to sign assertions: default true |
|
Security.SSO.SAML.AuthnRequestSigned |
Sign AuthnRequests before sending to Identity Provider: default true |
|
Security.SSO.SAML.BuiltinUser |
The builtin user for SAML |
|
Security.SSO.SAML.Enable |
Enable SAML2-based SSO: default false |
|
Security.SSO.SAML.IDP.EntityId |
Identity Provider Entity ID: default http://idp.example.com |
|
Security.SSO.SAML.IDP.SSOUrl |
Single Sign-On URL: default http://idp.example.com/sso/saml |
|
Security.SSO.SAML.IDP.X509Cert |
Identity Provider’s x509 Certificate filepath: default empty. You can use @/cert/file/path to pass the certificate from a file. |
|
Security.SSO.SAML.MetadataSigned |
Sign Metadata: default true |
|
Security.SSO.SAML.RequestedAuthnContext |
Authentication context (comma separate multiple values) |
|
Security.SSO.SAML.ResponseSigned |
Require Identity Provider to sign SAML responses: default true |
|
Security.SSO.SAML.SP.Hostname |
TigerGraph Service Provider URL: default http://127.0.0.1:14240 |
|
Security.SSO.SAML.SP.PrivateKey |
Content of the host machine’s private key. Require PKCS#8 format (start with ``BEGIN PRIVATE KEY''). You can use @/privatekey/file/path to pass the certificate from a file. |
|
Security.SSO.SAML.SP.X509Cert |
Content of the x509 Certificate: default empty. You can use @/cert/file/path to pass the certificate from a file. |
|
Security.SSO.SAML.SignatureAlgorithm |
Signiture algorithm [rsa-sha1/rsa-sha256/rsa-sha384/rsa-sha512]: default rsa-sha256 |
|
System
Name | Description | Example |
---|---|---|
System.AppRoot |
The root directory for TigerGraph applications |
|
System.Audit.Enable |
Setting to enable audit logs. |
|
System.Audit.DatabaseName |
Modify the DataBaseName field in log file header. |
|
System.Audit.LogDirRelativePath |
Modify the relative audit log path. |
|
System.Audit.LogConfig.LogFileMaxDurationDay |
Modify the audit log file’s modification date. |
|
System.Audit.LogConfig.LogFileMaxSizeMB |
Modify the audit log file’s max size. |
|
System.Audit.LogConfig.LogRotationFileNumber |
Modify the max amount of Audit Log files in the Audit Log folder. |
|
System.Audit.MaskPII |
Mask Sensitive data or PII in the audit log. Default value is: |
|
System.AuthToken |
The authorization token for TigerGraph services |
|
System.Backup.CompressProcessNumber |
The number of concurrent process
for compression during backup. Value |
|
System.Backup.DecompressProcessNumber |
The number of concurrent processes for decompression during the restore. |
|
System.Backup.CompressionLevel |
The backup compression level strikes a balance between size and speed. The better compression, the longer it takes. ("BestSpeed", "DefaultCompression", "BestCompression") |
"DefaultCompression" |
System.Backup.Local.Enable |
Backup data to local path IMPORTANT: If set to |
|
System.Backup.Local.Path |
The path to store the backup files |
|
System.Backup.S3.AWSAccessKeyID |
The AWS access key ID for s3 bucket of backup |
|
System.Backup.S3.AWSSecretAccessKey |
The secret access key for s3 bucket |
|
System.Backup.S3.RoleARN |
The AWS role for accessing s3 bucket, its use is prioritized over the combination of access key id and secret access key in accessing s3. To understand what AWS role ARN is, see AWS role ARN doc. NOTE: This is only for AWS S3, and TigerGraph assumes the credentials for using |
|
System.Backup.S3.BucketName |
The S3 bucket name |
|
System.Backup.S3.Enable |
Backup data to S3 path |
|
System.Backup.S3.Endpoint |
Endpoint to use instead of the S3 default endpoint. Must be a fully qualified URL. Typically used when operating in a private network or with a non-AWS S3-compatible endpoint. |
null |
System.Backup.TimeoutSec |
The backup timeout in seconds |
|
System.CrossRegionReplication.Enabled |
Enable Kafka Mirrormaker |
|
System.CrossRegionReplication.PrimaryKafkaIPs |
Kafka mirrormaker primary cluster’s IPs, separator by `,' |
|
System.CrossRegionReplication.PrimaryKafkaPort |
Kafka mirrormaker primary cluster’s KafkaPort |
|
System.CrossRegionReplication.TopicPrefix |
The prefix of GPE/GUI/GSQL Kafka Topic, by default is empty. |
|
System.DataRoot |
The root directory for data |
|
System.Event.EventInputTopic |
Kafka topic name of event input queue |
|
System.Event.EventOffsetFolderRelativePath |
The relative path (to the System.DataRoot) of the folder to keep track of Kafka offsets for event input/output queue |
|
System.Event.EventOutputTopic |
Kafka topic name of event output queue |
|
System.Event.MetricsTopic |
Kafka topic name of metrics event queue |
|
System.HostList |
The aliases and hostnames/IPs for nodes |
|
System.License |
The license key for TigerGraph system |
|
System.LogRoot |
The root directory for TigerGraph logs |
|
System.Metrics.CPUIntervalSec |
The CPU metric data collect interval (s) |
|
System.Metrics.DiskspaceIntervalSec |
The diskspace metric data collect interval (s) |
|
System.Metrics.MemoryIntervalSec |
The memory metric data collect interval (s) |
|
System.Metrics.NetworkIntervalSec |
The network metric data collect interval (s) |
|
System.Metrics.QPSIntervalSec |
The QPS metric data collect interval (s) |
|
System.Metrics.IncludeHostName |
If set to true, the hostname/ip will be included in all metrics output, in OpenMetrics format, as part of the variable labels. Otherwise, the default is |
|
System.SSH.ConfigFileRelativePath |
The relative path (to the System.DataRoot) of SSH config file |
|
System.SSH.Port |
SSH port |
|
System.SSH.User.Password |
OS User password (optional if using privatekey) |
|
System.SSH.User.Privatekey |
OS user private key path |
|
System.SSH.User.Username |
OS Username for TigerGraph database |
|
System.TempRoot |
The temporary directory for TigerGraph applications |
|
ZK
Name | Description | Example |
---|---|---|
ZK.BasicConfig.Env |
A list of |
|
ZK.BasicConfig.LogConfig.LogFileMaxSizeMB |
The maximum size in megabytes of the log file before it gets rotated |
|
ZK.BasicConfig.LogConfig.LogLevel |
The log level for zk ( |
|
ZK.BasicConfig.LogConfig.LogRotationFileNumber |
The maximum number of old log files to retain |
|
ZK.BasicConfig.LogDirRelativePath |
The relative path (to the System.LogRoot) of log directory for ZK |
|
ZK.BasicConfig.Nodes |
The node list for Zookeeper |
|
ZK.DataRelativePath |
The data dir of zookeeper under $DataRoot |
|
ZK.ElectionPort |
The port for Zookeeper to do leader election |
|
ZK.ForceSync |
The force synchronize property of zookeeper |
|
ZK.InitLimit |
The amount of time, in ticks(by default 2s for one tick), to allow followers to connect and sync to a leader. Increased this value as needed, if the amount of data managed by ZooKeeper is large |
|
ZK.Port |
The serving port for Zookeeper |
|
ZK.QuorumPort |
The port for Zookeeper to do peer communication |
|
ZK.StartTimeoutMS |
Start zookeeper timeout |
|
Environment Variables
An environment variable is set using its xxx.Basic.ConfigEnv
configuration parameter, where xxx
is the name of its associated component.
If you use gadmin config set GPE.BasicConfig.Env
or gadmin config entry GPE.BasicConfig.Env
, users will be able to add entries for GPE runtime environment variables.
Component | Name | Description | Example |
---|---|---|---|
GSQL |
|
[v3.9.2+] Timeout (minutes) for dynamic schema change. Default = 30 |
30 |
RESPP |
|
Set the CA certificate |
|
GPE |
|
|
|
|
|
|
|
|
|
|
|
|
In-memory buffer limit for delta message in CDC service. |
|
|
|
In-memory buffer limit for “vertex-deletion“ delta message in deleted id map service. |
|
|
|
In-memory cache limit for deleted id map. |
|
|
|
Interval for purging outdated entries in deleted id map. |
|
|
|
The value must be uint64_t type and in unit: Byte. The default value is 4194304, which means 4 MB. |
|
|
|
|
|