Parameters of the Supervisor component

2024-12-13 06:57:09  Updated

The Supervisor component has two configuration files:

  • supervisor.json: parameter configurations in the JSON format. This configuration file supports dynamic loading of changes and includes some important parameters in the drc.properties file.

  • drc.properties: This configuration file has been deprecated and is reserved only for compatibility. Logic will no longer be added to this file, and existing logic in the file will no longer be modified.

Description

Notice

If a parameter is followed by a field enclosed with parentheses, this parameter replaces the field in the drc.properties file. If the parameter exists in supervisor.json and is not empty, the configuration in the supervisor.json file applies. Otherwise, the configuration in the drc.properties file applies.

Parameter Default value Description
enableOldTaskId true Specifies whether to enable the taskId mechanism.
enableOldCheckAliveJob true Specifies whether to enable the component health check reporting job.
enableHostStatusJob true Specifies whether to enable the server status reporting job.
enableGetRegTaskJob true Specifies whether to enable the task for obtaining information about registered components from the Cluster Manager (CM) component.
forceCheckDir false Specifies whether to check whether a local task process belongs to the expected directory when you use the ps command to check the process.
asyncCommandStoragePath ./data/async_command The local storage directory for asynchronous commands.
asyncCommandStorageCf async_command The name of the column family in RocksDB where asynchronous commands are locally stored.
asyncCommandStorageTtlSec 7 *24* 2600 The time-to-live (TTL) for asynchronous commands that are locally stored, in seconds.
asyncCommandStorageMaxSizeMB 100 The maximum size of asynchronous commands that are locally stored, in MB.
dbcatDatasourceRetry 0 The number of retries for the DBCat data source.
enableKillOrphan true Specifies whether to delete residual processes of the Incr-Sync component.
leaseTimeSec 300 The lease time for the automatic exit mechanism of the Incr-Sync component, in seconds.
allocatedPortCacheTtlSec 600 The TTL for the cache allocated to ports, in seconds.
diskPaths /home/ds/store;/home/ds/run The directory to which the data disk is mounted. It is used for collecting disk usage information.
enableSingleton true Specifies whether to enable a single instance for the Supervisor process.
enableReportMetrics false Specifies whether to enable reporting metrics.
enableStorageMetrics false Specifies whether to enable local storage of metrics.
enableReportCm true Specifies whether to proactively report information such as heartbeat information to the CM component.
samplingMetricsIntervalSec 10 The metric collection interval, in seconds.
checkpointSizeLengthLimit 48 *1024* 1024 The maximum size of the checkpoint file, in bytes.
errorDetailsFilePath ./collect_errors/error.details.report.process The local storage file of error information.
imageVersion None The image version of the current environment.
bindIp(bind.ip) None The IP address used for reporting in the current environment. The IP address of the Docker may be different from that of an external server. When multiple NICs are available, you must specify an IP address as the identifier of the current supervisor.
enableMetrics(metrics.enable) false Specifies whether to enable metric collection.
metricType(metrics.service.impl) None Specifies whether to report metrics. If the value is empty, metrics will not be reported. If the value is INFLUXDB, metrics will be reported to InfluxDB.
metricServerAddr(metrics.url) None The address of the destination to which metrics are reported.
metricServerUsername(metrics.user) None The username of the destination to which metrics are reported.
metricServerPassword(metrics.password) None The password of the destination to which metrics are reported.
builtinHomePath(drc.homebase) None The directory where the Supervisor component is deployed.
builtinStorePath(drc.storebase) None The directory where the Store component is deployed.
cmAddr(cm.url) None The access address of the CM component.
checkfileLatency(checkfile.latency) 60 The timeout period for Supervisor to collect component files, in seconds.

Contact Us