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 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, unit seconds
  timeliness: 60
  # Legacy single account ak/sk configuration; retained for compatibility with historical environments, equivalent to a set of read-write accounts with privilege=w
  accessKey: ""
  secretKey: ""
  # Email name used as the account in interface operations
  email: ""
  # ExternalAPI multi-account configuration, supporting separation of read-write accounts and read-only accounts; when empty, only the legacy single account configuration above is used.
  # Field description:
  #   name: Account identifier, used only for logging, observation, and troubleshooting; do not use ambiguous names like default.
  #   accessKey: The AK used in the request header X-Df-Access-Key.
  #   secretKey: The signature SK corresponding to the current AK, not written to logs.
  #   privilege: Account permission, w indicates read-write account, can access privilege=r/w interfaces; r indicates read-only account, can only access privilege=r interfaces.
  #   email: The email displayed in the request context for this ExternalAPI account; falls back to external.email if empty.
  #   enabled: Whether this account is enabled, false means this account cannot be used for authentication.
  accounts: []
  # accounts:
  #   - name: "primary-write"
  #     accessKey: ""
  #     secretKey: ""
  #     privilege: "w"
  #     email: ""
  #     enabled: true
  #   - name: "security-readonly"
  #     accessKey: ""
  #     secretKey: ""
  #     privilege: "r"
  #     email: ""
  #     enabled: true

# 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 off, true means on. 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 range offset for links in query_view, unit seconds
BusinessQueryViewTimeOffset: 900

# Same organization cross-workspace Trace query configuration, default off
SameOrgTraceQuerySet:
  # Whether to allow querying Trace data from non-current workspaces under the same organization
  enable: false
  # Maximum number of workspace UUIDs allowed to be passed in a single query or workspace list filtering
  maxWorkspaceCount: 20
  # Maximum allowed value when limit is explicitly passed in a single Trace query
  maxLimit: 1000
  # Maximum time window allowed for a single Trace query, unit hours
  maxTimeRangeHours: 24
  # Maximum pagination size allowed for the simplified list interface of workspaces in the same organization
  workspaceListPageSizeMax: 100



# 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 has 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 them 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 connections on 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 off-peak usage. When planning server-side timeouts, ensure to use recycling (pool_recycle) or pre-ping (pool_pre_ping) strategies 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 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
  # Controls log output mode, default outputs 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 creating new workspaces in Deployment Plan
    durationSet:
      rp: 30d
      logging: 14d
      keyevent: 14d
      tracing: 7d
      profiling: 7d
      rum: 7d
      # Only Deployment Plan will have separate configuration for session_replay
      session_replay: 7d
      network: 2d
      security: 90d
      backup_log: 180d

# Workspace default status settings
WorkspaceDefaultStatsConfig:
  isOpenLogMultipleIndex:  true     # Default when creating workspace, custom log index not enabled
  logMultipleIndexCount:  6         # Default when creating workspace, number of custom log indices
  loggingCutSize: 10240             # Default when creating workspace, oversized log counting unit 10KB
  maxSearchResultCount: 0           # Default when creating workspace, query count upper limit 0

# es/doris index configuration default information
WorkspaceDefaultesIndexSettings:
  number_of_shards: 1               # Default when creating workspace, number of primary shards es
  number_of_replicas: 1             # Default when creating workspace, whether to enable replicas es | doris
  rollover_max_size: 30             # Default when creating workspace, shard size    es
  hot_retention: 24                 # Default when creating workspace, hot data duration   es | doris


# openapi rate limiting settings
openapiCurrentLimitingSet:
  # Rate limiting switch, default off, can be set to true if needed
  isOpen: false
  crontabSet:
    # Rate limiting frequency executed 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

# Studio backend CORS whitelist configuration
CorsAllowOriginSet:
  # Whether to enable CORS Origin whitelist, default off for compatibility; when enabled, Access-Control-Allow-Origin is only returned for browser Origins in the whitelist.
  enabled: false
  # Exact match frontend domain list, data format is string array, must include protocol, domain, and optional port.
  # Example: ["https://console.example.com", "https://uat-console.example.com:8443"]
  allowedOrigins: []
  # Controlled wildcard rule list, data format is string array, performs wildcard matching on Origin strings.
  # Example: ["https://*.example.com"]; configure only when necessary to open multiple subdomains, not recommended to use "*".
  allowedOriginPatterns: []
  # Whether to allow browsers to carry credentials for cross-origin access
  allowCredentials: true
  # Allowed cross-origin request methods
  allowMethods: "GET,POST,HEAD,PATCH,PUT,OPTIONS,DELETE"

# 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 retry_times times, 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 8
    log_query_workers: 8 # Log data worker count, default value 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 8
    log_query_workers: 8    # Log data worker count, default value 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 8
    log_query_workers: 8 # Log data worker count, default value 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

...