Application Service Configuration Guide

# Guance Console 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 adjust this configuration directly.
frontServerUrlPrefixFormat: "{}://{}"

# ExternalAPI Service Configuration.
external:
  # The validity period of each request signature, in seconds
  timeliness: 60
  # The ak/sk configuration used for interface signing, can set random strings as ak/sk
  accessKey: ""
  secretKey: ""
  # When the system runs in debug mode, allows unlimited automatic passing of the signature string, default value is none
  debugPassSignature: ""

# Fixed notification types for alert policies
alertPolicyFixedNotifyTypes:
  email:
    enable: true

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


# API documentation switch, default closed, if true indicates open. 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 links, 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 automatically disconnects if no activity is detected on the connection 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 upon 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, default outputs both to 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 method, default outputs both to file and stdout
  output_mode_switch:
    file: true
    stdou


# Default split unit for ultra-large logs when creating workspaces, unit in bytes
workspaceLoggingCutSizeSet:
  es: 10240
  sls: 2048
  beaver: 2048
  doris: 10240

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

# Default workspace status settings
WorkspaceDefaultStatsConfig:
  isOpenLogMultipleIndex:  true     # By default, create workspace with custom log indexes disabled
  logMultipleIndexCount:  6         # By default, create workspace with 6 custom log indexes
  loggingCutSize: 10240             # By default, create workspace with ultra-large log count unit of 10KB
  maxSearchResultCount: 0           # By default, create workspace with query quantity limit of 0

# Default information for es/doris index configuration when creating workspace
WorkspaceDefaultesIndexSettings:
  number_of_shards: 1               # By default, create workspace with 1 primary shard for es
  number_of_replicas: 1             # By default, create workspace with replicas enabled for es | doris
  rollover_max_size: 30             # By default, create workspace with shard size of 30 for es
  hot_retention: 24                 # By default, create workspace with hot data duration of 24 for es | doris


# OpenAPI rate limiting settings
openapiCurrentLimitingSet:
  # Rate limiting switch, default closed, set to true if needed
  isOpen: false
  crontabSet:
    # Number of rate limiting executions per minute
    hour: "*"
    minute: "*/1"
  frequency:
    # Ak level call rate limiting 100 times per minute
    ak: 100
    # Workspace level call rate limiting 300 times per minute
    workspace: 300


# Login restrictions for Deployment Plan
LoginLimitSet:
  # Number of consecutive login error retries for the same username
  retry_times: 5
  # Restricted login time after failing retry_times consecutive logins, default 15 minutes
  exp: 900

...

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

...

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

...