Application Service Configuration Manual
Overview¶
This document aims to modify relevant configurations through the "Modify Application Configuration" feature of launcher to better adapt to your own environment, optimize related configurations, and meet personalized configuration requirements.
Launcher Operation Steps¶
-
Browser access to the launcher console
-
Select the upper right corner to enter the Modify Application Configuration interface
-
When modifying the corresponding configuration file, you need to check the Modify Configuration option to make it modifiable.
-
After completing the configuration modification, you need to check Automatically restart related services after modifying configuration at the bottom right corner of the page, and then click Confirm Modification Configuration.
Partial Common Configuration Descriptions for Services¶
Studio Backend Service¶
Configuration File Location¶
- Namespace: forethought-core
- Configuration Name in Launcher: Core
- Configmap Name in kubernetes: core
Configuration File Example¶
# Guance console address access protocol
protocol: "http"
# Guance console address
hostname: "console.cloudcare.cn"
# Management backend site access address
managementHostname: "management.cloudcare.cn"
# Current site name
envName: Guance Deployment Plan
# Whether the system debug mode is enabled, generally not enabled
debug: false
# System default language
defaultLanguage: "zh"
# Frontend access address prefix, the first two curly braces will be occupied by protocol and hostname. If you need to configure a unified secondary address, you can directly adjust this configuration.
frontServerUrlPrefixFormat: "{}://{}"
# ExternalAPI service configuration.
external:
# Validity period for each request signature, in seconds
timeliness: 60
# ak/sk configuration used for interface signature, can be set to a random string as ak/sk
accessKey: ""
secretKey: ""
# When the system is running in debug mode, allows an unlimited automatic pass signature string, default is no value
debugPassSignature: ""
# Alert policy member type optional notification methods
alertPolicyFixedNotifyTypes:
email:
enable: true
# Token default expiration time settings
token_exp_set:
# web client default setting 4 hours
front_web: 14400
# Management backend token default expiration duration
manage: 7200
# API documentation switch, default is off. When true, it means enabled. The API documentation path defaults to /v1/doc; the inner api default address is /v1/inner.doc
apiDocPageSwitch:
# Management backend
admin: false
# Frontend
front: false
# Inner service
inner: false
# Openapi service
openapi: false
center: false
# External service
external: false
# Time range offset for links in query_view, unit is seconds
BusinessQueryViewTimeOffset: 900
# Guance database configuration
database:
connection:
pool_size: 20
max_overflow: 100
echo: false
pool_timeout: 30
# This setting causes the pool to recycle connections after the given number of seconds have passed. It defaults to -1, or no timeout. For example, setting it to 3600 means connections will be recycled after one hour. Note that MySQL will automatically disconnect connections if no activity is detected on the connection for eight hours (although this can be configured via the MySQLDB connection itself and server configuration).
pool_recycle: 3600
# Boolean, if True, enables the connection pool "pre-ping" feature, which tests the liveliness of the connection at each checkout
pool_pre_ping: true
# Use LIFO (Last In, First Out) QueuePool instead of FIFO (First In, First Out) when retrieving connections. Using LIFO, server-side timeout schemes can reduce the number of connections used during non-peak usage periods. When planning server-side timeouts, ensure to use a recycling (pool_recycle) or pre-ping (pool_pre_ping) strategy to properly handle stale connections.
pool_use_lifo: true
# Logger Configuration
logger:
filename: /logdata/business.log
level: info
# Maximum size of each log file
max_bytes: 52428800
# Total number of log file rollovers
backup_count: 3
# Controls log output mode, default is output to both file and stdout
output_mode_switch:
file: true
stdout: true
# GunLogger-access, same as above
g_access_logger:
filename: /logdata/g_access.log
mode: a
level: info
max_bytes: 52428800
backup_count: 3
# Controls log output mode, default is output to both file and stdout
output_mode_switch:
file: true
stdou
# Default oversized log split unit when creating a new workspace, unit byte
workspaceLoggingCutSizeSet:
es: 10240
sls: 2048
beaver: 2048
doris: 10240
# Default data retention policy when creating a new workspace
workspaceVersionSet:
unlimited:
# Default policy configuration for new workspaces in Deployment Plan
durationSet:
rp: 30d
logging: 14d
keyevent: 14d
tracing: 7d
profiling: 7d
rum: 7d
# Only the Deployment Plan will have a separate configuration for session_replay
session_replay: 7d
network: 2d
security: 90d
backup_log: 180d
# Workspace default status settings
WorkspaceDefaultStatsConfig:
isOpenLogMultipleIndex: true # Default workspace creation, custom log index not enabled
logMultipleIndexCount: 6 # Default workspace creation, custom log index count
loggingCutSize: 10240 # Default workspace creation, oversized log counting unit 10KB
maxSearchResultCount: 0 # Default workspace creation, query quantity upper limit 0
# es/doris index configuration default information
WorkspaceDefaultesIndexSettings:
number_of_shards: 1 # Default workspace creation, primary shard count es
number_of_replicas: 1 # Default workspace creation, whether to enable replica es | doris
rollover_max_size: 30 # Default workspace creation, shard size es
hot_retention: 24 # Default workspace creation, hot data duration es | doris
# openapi rate limiting settings
openapiCurrentLimitingSet:
# Rate limiting switch, default is off. If needed, can be set to true
isOpen: false
crontabSet:
# Rate limiting executions per minute
hour: "*"
minute: "*/1"
frequency:
# ak level call rate limit 100 times per minute
ak: 100
# Workspace level call rate limit 300 times per minute
workspace: 300
# Deployment Plan login restrictions
LoginLimitSet:
# Number of consecutive login error retries for the same username
retry_times: 5
# Time to restrict login after consecutive login failures reach retry_times times, default 15 minutes, note the unit is seconds
exp: 900
...
Configuration Item Detailed Description¶
| Configuration Item | Sub-item | Type | Default Value | Description |
|---|---|---|---|---|
| protocol | String | http | Guance console address access protocol | |
| hostname | String | console.cloudcare.cn | Guance console address | |
| managementHostname | String | management.cloudcare.cn | Management backend site access address | |
| envName | String | Guance | Current site name | |
| debug | Boolean | false | debug mode switch | |
| frontServerUrlPrefixFormat | String | {}://{} | Frontend access address prefix, the first two curly braces will be occupied by protocol and hostname. If you need to configure a unified secondary address, you can directly adjust this configuration. | |
| external | timeliness | Number | 60 | Validity period for each request signature, in seconds |
| accessKey | String | ak configuration used for interface signature, can be set to a random string | ||
| secretKey | String | sk configuration used for interface signature, can be set to a random string | ||
| debugPassSignature | String | When the system is running in debug mode, allows an unlimited automatic pass signature string, default is no value | ||
| defaultLanguage | String | zh | System default language. New workspaces will use this configuration value by default if no language is specified. | |
| token_exp_set | front_web | Number | 14400 | Studio browser client user login validity period, unit: seconds |
| manage | Number | 7200 | Management backend browser client user login validity period, unit: seconds | |
| apiDocPageSwitch | admin | Boolean | false | Management backend API interface documentation open switch |
| front | Boolean | false | Studio backend API interface documentation open switch | |
| inner | Boolean | false | Inner service API interface documentation open switch | |
| openapi | Boolean | false | OpenAPI interface documentation open switch | |
| external | Boolean | false | External API interface documentation open switch | |
| BusinessQueryViewTimeOffset | Number | 900 | Time offset range before and after querying RUM Resource corresponding link data, unit: seconds | |
| database | connection | String | Database connection string | |
| pool_size | Number | 20 | Regular size of single worker connection pool connections | |
| max_overflow | Number | 100 | Maximum overflow number of single worker connection pool links | |
| pool_timeout | Number | 30 | Database connection timeout time, unit: seconds | |
| pool_recycle | Number | 3600 | Controls the recycling time of connection pool links. Links will be recycled after the time specified by this value after creation. Unit: seconds. Generally used with pool_pre_ping and pool_use_lifo, and pool_use_lifo should be true. Note that the link recycling mechanism is triggered only when the database link is used. | |
| pool_pre_ping | Boolean | true | Enables the connection pool "pre-ping" feature, which tests the liveliness of the connection each time it is used | |
| pool_use_lifo | Boolean | true | Use LIFO (Last In, First Out) QueuePool instead of FIFO (First In, First Out) when retrieving connections | |
| logger | filename | String | /logdata/business.log | Log file |
| level | String | info | Minimum log level | |
| max_bytes | Number | 52428800 | Maximum size of each log file, unit: bytes | |
| backup_count | Number | 3 | Total number of log file rollovers | |
| output_mode_switch.file | true | Controls log output mode switch, supports output to file | ||
| output_mode_switch.stdout | true | Controls log output mode switch, supports output to stdout | ||
| g_access_logger | gunicon log configuration, related sub-configuration items are the same as logger | |||
| workspaceLoggingCutSizeSet | es | Number | 10240 | Default oversized log split unit when creating a new workspace, unit byte, storage type: elasticsearch/OpenSearch |
| sls | Number | 2048 | Default oversized log split unit when creating a new workspace, unit byte, storage type: Alibaba Cloud SLS storage | |
| beaver | Number | 2048 | Default oversized log split unit when creating a new workspace, unit byte, storage type: Rizhiyi | |
| doris | Number | 10240 | Default oversized log split unit when creating a new workspace, unit byte, storage type: doris | |
| WorkspaceDefaultStatsConfig.unlimited.durationSet | json | Default data retention duration configuration for new workspaces | ||
| rp | String | 30d | Default data retention duration for Measurements | |
| logging | String | 14d | Default data retention duration for logs | |
| keyevent | String | 14d | Default data retention duration for events | |
| tracing | String | 7d | Default data retention duration for links | |
| rum | String | 7d | Default data retention duration for RUM | |
| network | String | 2d | Default data retention duration for network | |
| security | String | 90d | Default data retention duration for Security Check | |
| backup_log | String | 180d | Default data retention duration for backup logs | |
| WorkspaceDefaultStatsConfig | isOpenLogMultipleIndex | Boolean | true | When creating a workspace, whether to enable custom log index |
| logMultipleIndexCount | Number | 6 | When creating a workspace, custom log index count | |
| loggingCutSize | Number | 6 | When creating a workspace, oversized log counting unit 10KB | |
| maxSearchResultCount | Number | 0 | Query quantity upper limit 0 | |
| WorkspaceDefaultesIndexSettings | number_of_shards | Number | 1 | When creating a workspace, primary shard count, valid when storage type is es |
| number_of_shards | Number | 1 | When creating a workspace, primary shard count, valid when storage type is es | |
| number_of_replicas | Number | 1 | When creating a workspace, whether to enable replica, valid when storage type is es/doris | |
| rollover_max_size | Number | 30 | When creating a workspace, shard size, valid when storage type is es/doris | |
| hot_retention | Number | 24 | When creating a workspace, hot data duration, valid when storage type is es/doris | |
| openapiCurrentLimitingSet | json | openapi rate limiting settings | ||
| isOpen | Boolean | false | openapi rate limiting switch, default is off | |
| openapiCurrentLimitingSet.crontabSet | json | Scheduled task configuration | ||
| hour | String | "*" | Hour setting in crontab, defaults to every hour | |
| minute | String | "*/1" | Minute setting in crontab, defaults to every minute | |
| openapiCurrentLimitingSet.frequency | json | Limit configuration | ||
| ak | Number | 100 | ak level call rate limit 100 times per minute | |
| workspace | Number | 300 | Workspace level call rate limit 300 times per minute | |
| LoginLimitSet | json | Deployment Plan login restrictions | ||
| retry_times | Number | 5 | Number of consecutive login error retries for the same username | |
| exp | Number | 900 | Time to restrict login after consecutive login failures reach retry_times times, default 15 minutes, note the unit is seconds |
Studio Frontend Site¶
Configuration File Location¶
- Namespace: forethought-webclient
- Configuration Name in Launcher: frontWeb
- Configmap Name in kubernetes: front-web-config
Configuration File Example¶
window.DEPLOYCONFIG = {
...
"rumDatawayUrl": "https://rum-openway.guance.com",
"datakitScriptUrl": "https://static.guance.com/datakit",
"datakitHelmUrl": "https://pubrepo.guance.com",
"passPublicNetwork": 1,
"isOverseas": 0,
"maxTraceSpanLimit": 10000,
"maxProfileM": 5,
"paasCustomLoginInfo": [{ "iconUrl":"xxx", "label": "xxx", "url": "xxxx" ,desc:"xxx"}],
"paasCustomSiteList": [{"url": "xxxx", "label": "xxx"}],
"paasCustomLoginUrl": "https://www.xxx",
"maxMessageByte": 10 * 1024,
"isDesensitizeUser": false,
"webRumSdkUrl": "https://static.guance.com/browser-sdk/v3/dataflux-rum.js",
"defaultTimeMap": {
'log': [1732254771701,1732255671701],// Or relative time 5m
}
...
}
Configuration Item Detailed Description¶
| Configuration Item | Sub-item | Type | Default Value | Description |
|---|---|---|---|---|
| rumDatawayUrl | String | "https://rum-openway.guance.com" | Dedicated DataWay address for reporting RUM data. After configuration, it will be displayed on the RUM access configuration page. | |
| datakitScriptUrl | String | "https://static.guance.com/datakit" | Default installation script download domain for the DataKit installation page. If using a self-built internal static resource, please modify this configuration. | |
| datakitHelmUrl | String | "https://pubrepo.guance.com" | DataKit Helm image repository address. If using a self-built image repository, please modify this configuration. | |
| passPublicNetwork | Number | 1 | Configures whether the client computer accessing the Studio site has a public network. 0: No, 1: Yes. | |
| isOverseas | Number | 0 | Configures whether this Guance site is deployed overseas. This will affect the display of world maps and China maps in RUM components. | |
| maxTraceSpanLimit | Number | 10000 | Maximum number of Span entries in the flame graph of links, default value: 10000 | |
| maxProfileM | Number | 5 | Maximum MB number for obtaining profile flame graph display. If not configured, the default value is: 5 | |
| paasCustomLoginInfo | Array | None | Deployment Plan Guance console login page single sign-on entry configuration. Added custom fields iconUrl, desc. iconUrl is the single sign-on icon address, default icon if not configured. desc is the single sign-on description text. | |
| paasCustomSiteList | Array | None | Deployment Plan Guance console login page added multi-site selection configuration. label is the site display text, url is the site address. If multiple sites do not exist, this configuration item can be omitted. | |
rumEnable Self-observability |
Boolean | None | Whether to enable RUM, 1 means enabled. If not enabled, the following configuration values can be empty. | |
rumDatakitUrl Self-observability |
String | None | RUM DataKit address or public network openway address | |
rumApplicationId Self-observability |
String | None | RUM application ID, used for reporting application data | |
rumJsUrl Self-observability |
String | None | RUM SDK CDN address | |
rumTrackInteractions Self-observability |
Boolean | None (Not enabled) | Whether to enable user behavior data (Action) collection | |
rumClientToken Self-observability |
String | None | RUM Openway method for reporting data (needs to be used with rumOpenwayUrl). The clientToken generated on the Guance platform conflicts with the datakit reporting method and has higher priority than the datakit reporting method. |
|
rumOpenwayUrl Self-observability |
String | None | RUM Openway public network address (needs to be used with rumClientToken), used for Studio frontend site self-observability data reporting. |
|
isDesensitizeUser Self-observability |
Boolean | None | Whether to enable self-observability user email and username data desensitization, true means enabled, false means disabled | |
| paasCustomLoginUrl | String | None | Custom login url | |
| maxMessageByte | String | None | Log Explorer list message maximum display byte count, defaults to 10 * 1024 if not filled | |
| webRumSdkUrl | String | None | Rum web SDK CDN address, defaults to https://static.guance.com/browser-sdk/v3/dataflux-rum.js if not filled | |
| defaultTimeMap | String or Object structure | None | Explorer default initialization time configuration. Format is {'log': '5m'} or {'log': [1732254771701,1732255671701]}. Object key is a fixed string, log explorer is log, Security Check is security. |
|
| maxPipelineRulesCharacters | Number | 10240 | Maximum number of characters supported for Pipeline parsing rule input. If not configured, the default value is 10240. | |
| hideTesingOperator | Boolean | false | Whether to hide the Synthetic Tests test button |
kodo component¶
Configuration File Location¶
- Namespace: forethought-kodo
- Configuration Name in Launcher: Kodo
- Configmap Name in kubernetes: kodo
Configuration File Example¶
...
global:
workers: 8
log_workers: 8
tracing_workers: 8
...
redis:
host: "r-xxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
asynq_redis:
host: "r-xxxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
dql:
metric_query_workers: 8 # Time series data worker count, default value is 8
log_query_workers: 8 # Log data worker count, default value is 8
...
...
Configuration Item Detailed Description¶
| Configuration Item | Sub-item | Type | Default Value | Description |
|---|---|---|---|---|
| log | log_file | String | '/logdata/log' | Runtime log, storage address. Optional value stdout means standard output, not saved to file. |
| level | String | 'info' | Runtime log minimum level | |
| gin_log_file | String | '/logdata/log' | gin log, storage address. Optional value stdout means standard output, not saved to file. | |
| database | db_dialect | String | 'mysql' | Database type, defaults to mysql |
| addr | String | 'testsql.com:3306' | Database connection address | |
| username | String | ' test_user' | Username | |
| password | String | 'test_password' | Password | |
| network | String | 'tcp' | Connection protocol | |
| db_name | String | 'test_db_name' | Database name | |
| nsq | lookupd | String | 'testnsq.com:4161' | nsq lookupd address |
| discard_expire_interval | Number | 5 | Time series data maximum redundancy time, unit is minutes. Default time series metric data exceeding 5 minutes delay will not be written. | |
| redis | host | String | 'testredis.com:6379' | Redis address used for data processing, supports cluster version. Note: Redis configuration for all kodo related components must be consistent. |
| password | String | 'test_password' | Password | |
| db | Number | 0 | redis db value | |
| is_cluster | Boolean | false | When the redis set is a cluster, and the connection does not support proxy connection, it needs to be set to true. | |
| asynq_redis | host | String | '' | Redis address used for asynchronous tasks, uses the redis configuration by default, does not support cluster version. If the redis configuration is a cluster version, a non-cluster version asynq_redis must be configured. |
| password | String | 'test_password' | Password | |
| db | Number | 0 | redis db value |
kodo-inner component¶
Configuration File Location¶
- Namespace: forethought-kodo
- Configuration Name in Launcher: KodoInner
- Configmap Name in kubernetes: kodo-inner
Configuration File Example¶
...
redis:
host: "r-xxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
asynq_redis:
host: "r-xxxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
dql:
metric_query_workers: 8 # Time series data worker count, default value is 8
log_query_workers: 8 # Log data worker count, default value is 8
...
...
Configuration Item Detailed Description¶
| Configuration Item | Sub-item | Type | Default Value | Description |
|---|---|---|---|---|
| log | log_file | String | '/logdata/log' | Runtime log, storage address. Optional value stdout means standard output, not saved to file. |
| level | String | 'info' | Runtime log minimum level | |
| gin_log_file | String | '/logdata/log' | gin log, storage address. Optional value stdout means standard output, not saved to file. | |
| database | db_dialect | String | 'mysql' | Database type, defaults to mysql |
| addr | String | 'testsql.com:3306' | Database connection address | |
| username | String | ' test_user' | Username | |
| password | String | 'test_password' | Password | |
| network | String | 'tcp' | Connection protocol | |
| db_name | String | 'test_db_name' | Database name | |
| nsq | lookupd | String | 'testnsq.com:4161' | nsq lookupd address |
| discard_expire_interval | Number | 5 | Time series data maximum redundancy time, unit is minutes. Default time series metric data exceeding 5 minutes delay will not be written. | |
| redis | host | String | 'testredis.com:6379' | Redis address used for data processing, supports cluster version. Note: Redis configuration for all kodo related components must be consistent. |
| password | String | 'test_password' | Password | |
| db | Number | 0 | redis db value | |
| is_cluster | Boolean | false | When the redis set is a cluster, and the connection does not support proxy connection, it needs to be set to true. | |
| asynq_redis | host | String | '' | Redis address used for asynchronous tasks, uses the redis configuration by default, does not support cluster version. If the redis configuration is a cluster version, a non-cluster version asynq_redis must be configured. |
| password | String | 'test_password' | Password | |
| db | Number | 0 | redis db value | |
| dql | metric_query_workers | Number | 32 | DQL metric data query worker count |
| query_metric_channel_size | Number | 32 | Request queue size in each metric_query_worker | |
| log_query_workers | Number | 32 | DQL log text class (logs, links, RUM and all text class data) data query worker count | |
| query_log_channel_size | Number | 32 | Request queue size in each log_query_worker | |
| general_query_workers | Number | 32 | Non-metric or log query worker count | |
| query_general_channel_size | Number | 32 | Request queue size in each general_query_worker | |
| profiling_parse | Boolean | true | Whether DQL query enables metrics, statistics query time consumption for each stage | |
| influxdb | read_timeout | Number | 60 | Query time series metric data, query timeout time, unit is s, default timeout time is 60s |
| dial_timeout | Number | 30 | Query time series metric data, connection establishment timeout time, unit is ms, default connection creation timeout time is 30ms | |
| doris | read_timeout | Number | 60 | Query log class data, query timeout time, unit is s, default timeout time is 60s |
| dial_timeout | Number | 30 | Query log class data, connection establishment timeout time, unit is ms, default connection creation timeout time is 30ms | |
| global | datakit_usage_check_enabled | Boolean | false | Whether to check if the number of datakits exceeds the license limit during log query, default is not to check |
kodo-x component¶
Configuration File Location¶
- Namespace: forethought-kodo
- Configuration Name in Launcher: KodoX
- Configmap Name in kubernetes: kodo-x
Configuration File Example¶
...
global:
workers: 8
log_workers: 8
tracing_workers: 8
...
redis:
host: "r-xxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
asynq_redis:
host: "r-xxxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
doris:
dial_timeout: 10
gzip_enable: false
dql:
metric_query_workers: 8 # Time series data worker count, default value is 8
log_query_workers: 8 # Log data worker count, default value is 8
...
pipeline:
enable: false
pull_duration: "1m"
...
Configuration Item Detailed Description¶
| Configuration Item | Sub-item | Type | Default Value | Description |
|---|---|---|---|---|
| log | log_file | String | '/logdata/log' | Runtime log, storage address. Optional value stdout means standard output, not saved to file. |
| level | String | 'info' | Runtime log minimum level | |
| gin_log_file | String | '/logdata/log' | gin log, storage address. Optional value stdout means standard output, not saved to file. | |
| database | db_dialect | String | 'mysql' | Database type, defaults to mysql |
| addr | String | 'testsql.com:3306' | Database connection address | |
| username | String | ' test_user' | Username | |
| password | String | 'test_password' | Password | |
| network | String | 'tcp' | Connection protocol | |
| db_name | String | 'test_db_name' | Database name | |
| nsq | lookupd | String | 'testnsq.com:4161' | nsq lookupd address |
| discard_expire_interval | Number | 5 | Time series data maximum redundancy time, unit is minutes. Default time series metric data exceeding 5 minutes delay will not be written. | |
| redis | host | String | 'testredis.com:6379' | Redis address used for data processing, supports cluster version. Note: Redis configuration for all kodo related components must be consistent. |
| password | String | 'test_password' | Password | |
| db | Number | 0 | redis db value | |
| is_cluster | Boolean | false | When the redis set is a cluster, and the connection does not support proxy connection, it needs to be set to true. | |
| asynq_redis | host | String | '' | Redis address used for asynchronous tasks, uses the redis configuration by default, does not support cluster version. If the redis configuration is a cluster version, a non-cluster version asynq_redis must be configured. |
| password | String | 'test_password' | Password | |
| db | Number | 0 | redis db value | |
| global | workers | Number | 8 | Default processing worker count for various data types |
| metric_workers | Number | 8 | Time series metric data processing worker count | |
| log_workers | Number | 8 | Log data processing worker count | |
| tracing_workers | Number | 8 | Link data processing worker count, uses the log_workers configuration item value by default | |
| sub_topic_max_expire_seconds | Object structure | Optional values are df_audit_event (audit events), df_dialtesting (Synthetic Tests), df_event (events), df_logging (logs), df_network (network), df_object (infrastructure), df_profiling (profiling), df_rum (RUM), df_security (Security Check), df_tracing (APM). For example: df_logging: 3600, means logs older than 1 hour are directly discarded and no longer consumed. | ||
| influxdb | read_timeout | Number | 60 | Query time series metric data, query timeout time, unit is s, default timeout time is 60s |
| write_timeout | Number | 300 | Write time series metric data timeout time, unit is s, default write timeout time is 5 min | |
| enable_gz | Boolean | false | Whether to enable gzip compression for writing data | |
| dial_timeout | Number | 30 | Query time series metric data, connection establishment timeout time, unit is ms, default connection creation timeout time is 30ms | |
| doris | read_timeout | Number | 60 | Query log class data, query timeout time, unit is s, default timeout time is 60s |
| write_timeout | Number | 300 | Write log class data timeout time, unit is s, default write timeout time is 5 min | |
| gzip_enable | Boolean | false | Whether to enable gzip compression for writing data | |
| dial_timeout | Number | 30 | Query log class data, connection establishment timeout time, unit is ms, default connection creation timeout time is 30ms | |
| backup_kafka | async | Boolean | false | Data forwarding to kafka, write method, default is synchronous write |
| write_timeout | Number | 30 | Write kafka timeout time, unit is s, default write timeout time is 30s | |
| max_bulk_docs | Number | 0 | Whether to write multiple logs into one kafka message and send it to kafka. Default is one log forms one kafka message. | |
| pipeline | enable | Boolean | false | Configure as true to enable central Pipeline functionality |
| pull_duration | String | 1m | Central Pipeline script synchronization time interval. Default value 1m means synchronize every 1 minute. Supports time interval notation like s, m, h, e.g., 1m30s means synchronize central Pipeline scripts every 1 minute and 30 seconds. |
kodo-servicemap component¶
Configuration File Location¶
- Namespace: forethought-kodo
- Configuration Name in Launcher: kodoServiceMap
- Configmap Name in kubernetes: kodo-servicemap
Configuration File Example¶
...
redis:
host: "r-xxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
asynq_redis:
host: "r-xxxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
...
Configuration Item Detailed Description¶
| Configuration Item | Sub-item | Type | Default Value | Description |
|---|---|---|---|---|
| redis | host | String | '' | Redis address used for data processing, supports cluster version. Note: Redis configuration for all kodo related components must be consistent. |
| asynq_redis | host | String | '' | Redis address used for asynchronous tasks, uses the redis configuration by default, does not support cluster version. If the redis configuration is a cluster version, a non-cluster version asynq_redis must be configured. |
kodo-x-scan component¶
Configuration File Location¶
- Namespace: forethought-kodo
- Configuration Name in Launcher: kodoXScan
- Configmap Name in kubernetes: kodo-x-scan
Configuration File Example¶
...
redis:
host: "r-xxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
asynq_redis:
host: "r-xxxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
...
Configuration Item Detailed Description¶
| Configuration Item | Sub-item | Type | Default Value | Description |
|---|---|---|---|---|
| redis | host | String | '' | Redis address used for data processing, supports cluster version. Note: Redis configuration for all kodo related components must be consistent. |
| asynq_redis | host | String | '' | Redis address used for asynchronous tasks, uses the redis configuration by default, does not support cluster version. If the redis configuration is a cluster version, a non-cluster version asynq_redis must be configured. |
kodo-ws component¶
Configuration File Location¶
- Namespace: forethought-kodo
- Configuration Name in Launcher: kodoWS
- Configmap Name in kubernetes: kodo-ws
Configuration File Example¶
...
redis:
host: "r-xxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
asynq_redis:
host: "r-xxxx.redis.rds.xxx.com:6379"
password: "..."
db: 0
...
Configuration Item Detailed Description¶
| Configuration Item | Sub-item | Type | Default Value | Description |
|---|---|---|---|---|
| redis | host | String | '' | Redis address used for data processing, supports cluster version. Note: Redis configuration for all kodo related components must be consistent. |
| asynq_redis | host | String | '' | Redis address used for asynchronous tasks, uses the redis configuration by default, does not support cluster version. If the redis configuration is a cluster version, a non-cluster version asynq_redis must be configured. |

