Application Service Configuration Guide

# Guance Console Access Protocol
protocol: "http"
# Guance Console Address
hostname: "console.cloudcare.cn"

# Management Site Access Address
managementHostname: "management.cloudcare.cn"

# Current Site Name
envName: Guance Deployment Plan

# Whether the system is in debug mode, generally not enabled
debug: false
# System default language
defaultLanguage: "zh"

# Frontend access address prefix; the first two curly braces are occupied by protocol and hostname. If you need to configure a unified secondary domain, adjust this setting directly.
frontServerUrlPrefixFormat: "{}://{}"

# ExternalAPI service configuration.
external:
  # Validity period for each request signature, in seconds
  timeliness: 60
  # AK/SK configuration used for API signing; can be set as random strings for ak/sk
  accessKey: ""
  secretKey: ""
  # Signature string allowed to pass without restriction when the system is running in debug mode, default is empty
  debugPassSignature: ""

# Alert policy notification methods
alertPolicyFixedNotifyTypes:
  email:
    enable: true

# Default token expiration time settings
token_exp_set:
  # Web end default setting 4 hours
  front_web: 14400
  # Management backend token default expiration duration
  manage: 7200


# API documentation switch, default is closed, set to true to open. Default path for API documentation is /v1/doc; inner api default path 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 offset for BusinessQueryView traces, in 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 specified number of seconds. It defaults to -1, or no timeout. For example, setting it to 3600 means connections will be recycled after one hour. Note that MySQL automatically disconnects if there is no activity on the connection within eight hours (although this can be configured via MySQLDB connection and server settings).
  pool_recycle: 3600
  # Boolean value, if True, enables the connection pool "pre ping" feature, which tests the activity of the connection upon 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 can reduce the number of connections used during non-peak periods under server-side timeout schemes. When planning server-side timeouts, ensure you use the recycle(pool_recycle) or pre-ping(pool_pre_ping) strategy to properly handle outdated 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 rolled-over log files
  backup_count: 3
  # Control log output method, default outputs 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
  # Control log output method, default outputs to both file and stdout
  output_mode_switch:
    file: true
    stdout: true


# Default large log split unit when creating a new workspace, in bytes
workspaceLoggingCutSizeSet:
  es: 10240
  sls: 2048
  beaver: 2048
  doris: 10240

# Default data retention policy when creating a new workspace
workspaceVersionSet:
  unlimited:
    # Default policy configuration for creating a new workspace under Deployment Plan
    durationSet:
      rp: 30d
      logging: 14d
      keyevent: 14d
      tracing: 7d
      profiling: 7d
      rum: 7d
      # Only the Deployment Plan has a separate session_replay configuration
      session_replay: 7d
      network: 2d
      security: 90d
      backup_log: 180d

# Default workspace status settings
WorkspaceDefaultStatsConfig:
  isOpenLogMultipleIndex:  true     # By default, custom log indexes are not enabled when creating a workspace
  logMultipleIndexCount:  6         # Default custom log index count when creating a workspace
  loggingCutSize: 10240             # Default large log count unit 10KB when creating a workspace
  maxSearchResultCount: 0           # Default query result limit 0 when creating a workspace

# Default ES/Doris index configuration information
WorkspaceDefaultesIndexSettings:
  number_of_shards: 1               # Default primary shard count for ES when creating a workspace
  number_of_replicas: 1             # Default replica count for ES/Doris when creating a workspace
  rollover_max_size: 30             # Default shard size for ES when creating a workspace
  hot_retention: 24                 # Default hot data duration for ES/Doris when creating a workspace

...

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,
    "webRumSdkUrl": "https://static.guance.com/browser-sdk/v3/dataflux-rum.js",
    "defaultTimeMap": {
        'log': [1732254771701,1732255671701],// or relative time 5m
    }
    ...
}

...

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

...

...

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

...

...

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"

...

...

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

...

...

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

...

...

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

...