Application Service Configuration Guide

# 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 is in debug mode, generally not enabled
debug: false
# System default language
defaultLanguage: "zh"

# Frontend access address prefix, the first two curly brackets 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:
  # The validity period of each request signature, in seconds
  timeliness: 60
  # ak/sk configuration used for interface signing, can set random strings as ak/sk
  accessKey: ""
  secretKey: ""
  # When the system runs in debug mode, the signature string that allows unlimited automatic passing, default has no value
  debugPassSignature: ""

# Fixed notification types for alert strategies
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


# Whether API documentation is enabled, default closed, true indicates enabled. API documentation path defaults to /v1/doc; 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 offset range for queries in query_view chains, unit 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 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 any connection with no activity detected within eight hours (though this can be configured via MySQLDB connection itself and server settings).
  pool_recycle: 3600
  # Boolean value, if True, enables the connection pool “pre ping” feature, which tests the activity of the connection on each checkout
  pool_pre_ping: true
  # Retrieves connections using LIFO (last-in-first-out) QueuePool instead of FIFO (first-in-first-out). Using LIFO reduces the number of connections used during non-peak usage under server-side timeout schemes. When planning server-side timeouts, ensure use of recycling(pool_recycle) or pre-ping(pool_pre_ping) strategies 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 log file rollovers
  backup_count: 3
  # Controls log output method, by default outputs to both files 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 method, by default outputs to both files and stdout
  output_mode_switch:
    file: true
    stdout: true


# Default ultra-large log split size when creating workspaces, unit byte
workspaceLoggingCutSizeSet:
  es: 10240
  sls: 2048
  beaver: 2048
  doris: 10240

# Default data retention policy when creating workspaces
workspaceVersionSet:
  unlimited:
    # Default strategy configuration for creating workspaces under Deployment Plan
    durationSet:
      rp: 30d
      logging: 14d
      keyevent: 14d
      tracing: 7d
      profiling: 7d
      rum: 7d
      # Only Deployment Plan will have separate session_replay configuration
      session_replay: 7d
      network: 2d
      security: 90d
      backup_log: 180d

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

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

...

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

...