애플리케이션 서비스 구성 항목 가이드

# Guance 콘솔 주소 액세스 프로토콜
protocol: "http"
# Guance 콘솔 주소
hostname: "console.cloudcare.cn"

# 관리 백엔드 사이트 액세스 주소
managementHostname: "management.cloudcare.cn"

# 현재 사이트 이름
envName: Guance 배포 플랜

# 시스템 디버그 모드 활성화 여부, 일반적으로 비활성화
debug: false
# 시스템 기본 언어
defaultLanguage: "zh"

# 프론트엔드 액세스 주소 접두사, 처음 두 개의 중괄호는 protocol과 hostname으로 대체되며, 통합된 2차 주소를 구성하려면 이 설정을 직접 조정할 수 있습니다.
frontServerUrlPrefixFormat: "{}://{}"

# ExternalAPI 서비스 구성
external:
  # 각 요청 서명의 유효 기간, 단위: 초
  timeliness: 60
  # 구버전 단일 계정 AK/SK 구성; 히스토리 환경 호환을 위해 유지, privilege=w인 읽기/쓰기 계정과 동일
  accessKey: ""
  secretKey: ""
  # 인터페이스 작업에서 계정으로 사용되는 이메일 이름
  email: ""
  # ExternalAPI 다중 계정 구성, 읽기/쓰기 계정과 읽기 전용 계정 분리 지원; 비어 있을 경우 위의 구버전 단일 계정 구성만 사용
  # 필드 설명:
  #   name: 계정 식별자, 로그, 관측 및 문제 해결에만 사용; default와 같은 의미 없는 이름은 사용하지 마십시오
  #   accessKey: 요청 헤더 X-Df-Access-Key에 사용되는 AK
  #   secretKey: 현재 AK에 해당하는 서명 SK, 로그에 기록되지 않음
  #   privilege: 계정 권한, w는 읽기/쓰기 계정으로 privilege=r/w 인터페이스에 액세스 가능; r은 읽기 전용 계정으로 privilege=r 인터페이스에만 액세스 가능
  #   email: 현재 ExternalAPI 계정이 요청 컨텍스트에 표시하는 이메일; 비어 있을 경우 external.email로 대체
  #   enabled: 계정 활성화 여부, false인 경우 인증에 사용할 수 없음
  accounts: []
  # accounts:
  #   - name: "primary-write"
  #     accessKey: ""
  #     secretKey: ""
  #     privilege: "w"
  #     email: ""
  #     enabled: true
  #   - name: "security-readonly"
  #     accessKey: ""
  #     secretKey: ""
  #     privilege: "r"
  #     email: ""
  #     enabled: true

# 알림 정책 멤버 유형 선택 가능한 알림 방식
alertPolicyFixedNotifyTypes:
  email:
    enable: true

# Token 기본 만료 시간 설정
token_exp_set:
  # 웹 기본 설정 4시간
  front_web: 14400
  # 관리 백엔드 token 기본 만료 시간
  manage: 7200


# API 문서 활성화 여부, 기본 비활성화, true인 경우 활성화. API 문서 경로 기본값은 /v1/doc; inner API 기본 주소는 /v1/inner.doc
apiDocPageSwitch:
  # 관리 백엔드
  admin: false
  # 프론트엔드
  front: false
  # inner 서비스
  inner: false
  # openapi 서비스
  openapi: false
  center: false
  # external 서비스
  external: false


# query_view에서 트레이스의 시간 범위 오프셋, 단위: 초
BusinessQueryViewTimeOffset: 900

# 동일 조직 내 워크스페이스 간 Trace 조회 구성, 기본 비활성화
SameOrgTraceQuerySet:
  # 동일 조직 내 현재 워크스페이스가 아닌 Trace 데이터 조회 허용 여부
  enable: false
  # 단일 조회 또는 워크스페이스 목록 필터링에서 허용되는 최대 워크스페이스 UUID 수
  maxWorkspaceCount: 20
  # 단일 Trace 조회 시 limit을 명시적으로 전달할 때 허용되는 최대값
  maxLimit: 1000
  # 단일 Trace 조회에서 허용되는 최대 시간 창, 단위: 시간
  maxTimeRangeHours: 24
  # 동일 조직 워크스페이스 단순화 목록 인터페이스에서 허용되는 최대 페이지 크기
  workspaceListPageSizeMax: 100



# Guance의 데이터베이스 구성
database:
  connection:
  pool_size: 20
  max_overflow: 100
  echo: false
  pool_timeout: 30
  # 이 설정은 지정된 시간(초)이 지나면 풀이 연결을 재활용하도록 합니다. 기본값은 -1 또는 타임아웃 없음입니다. 예를 들어 3600으로 설정하면 연결이 1시간 후에 재활용됩니다. MySQL은 8시간 동안 연결에서 활동이 감지되지 않으면 자동으로 연결을 끊습니다(MySQLDB 연결 자체 및 서버 구성을 통해 구성 가능).
  pool_recycle: 3600
  # 부울 값, True인 경우 연결 풀 "ping 사전 확인" 기능을 활성화하여 각 체크아웃 시 연결의 활성 상태를 테스트합니다.
  pool_pre_ping: true
  # 연결 검색 시 LIFO(후입선출) QueuePool을 사용하고 FIFO(선입선출)를 사용하지 않습니다. LIFO를 사용하면 서버 측 타임아웃 체계로 인해 사용량이 적은 시간에 사용되는 연결 수를 줄일 수 있습니다. 서버 측 타임아웃을 계획할 때는 pool_recycle 또는 pool_pre_ping 전략을 사용하여 오래된 연결을 적절히 처리해야 합니다.
  pool_use_lifo: true


# Logger 구성
logger:
  filename: /logdata/business.log
  level: info
  # 각 로그 파일의 최대 크기
  max_bytes: 52428800
  # 로그 파일 롤링 총 개수
  backup_count: 3
  # 로그 출력 방식 제어, 기본값은 파일 출력 및 stdout 출력
  output_mode_switch:
    file: true
    stdout: true

# GunLogger-access, 위와 동일
g_access_logger:
  filename: /logdata/g_access.log
  mode: a
  level: info
  max_bytes: 52428800
  backup_count: 3
  # 로그 출력 방식 제어, 기본값은 파일 출력 및 stdout 출력
  output_mode_switch:
    file: true
    stdout: true


# 새 워크스페이스 생성 시 기본 대용량 로그 분할 단위, 단위: byte
workspaceLoggingCutSizeSet:
  es: 10240
  sls: 2048
  beaver: 2048
  doris: 10240

# 새 워크스페이스 생성 시 기본 데이터 보존 정책
workspaceVersionSet:
  unlimited:
    # 배포 플랜 새 워크스페이스의 기본 정책 구성
    durationSet:
      rp: 30d
      logging: 14d
      keyevent: 14d
      tracing: 7d
      profiling: 7d
      rum: 7d
      # 배포 플랜에만 session_replay의 별도 구성이 존재함
      session_replay: 7d
      network: 2d
      security: 90d
      backup_log: 180d

# 워크스페이스 기본 상태 설정
WorkspaceDefaultStatsConfig:
  isOpenLogMultipleIndex:  true     # 기본 워크스페이스 생성 시, 사용자 정의 로그 인덱스 미활성화
  logMultipleIndexCount:  6         # 기본 워크스페이스 생성 시, 사용자 정의 로그 인덱스 수
  loggingCutSize: 10240             # 기본 워크스페이스 생성 시, 대용량 로그 카운트 단위 10KB
  maxSearchResultCount: 0           # 기본 워크스페이스 생성 시, 최대 쿼리 수 0

# es/doris 인덱스 구성 기본 정보
WorkspaceDefaultesIndexSettings:
  number_of_shards: 1               # 기본 워크스페이스 생성 시, 기본 샤드 수 es
  number_of_replicas: 1             # 기본 워크스페이스 생성 시, 복제본 활성화 여부 es | doris
  rollover_max_size: 30             # 기본 워크스페이스 생성 시, 샤드 크기    es
  hot_retention: 24                 # 기본 워크스페이스 생성 시, 핫 데이터 기간   es | doris


# openapi 속도 제한 설정
openapiCurrentLimitingSet:
  # 속도 제한 스위치, 기본 비활성화, 사용하려면 true로 설정
  isOpen: false
  crontabSet:
    # 매분 실행되는 속도 제한 횟수
    hour: "*"
    minute: "*/1"
  frequency:
    # ak 수준 호출 속도 제한 100회/분
    ak: 100
    # 워크스페이스 수준 호출 속도 제한 300회/분
    workspace: 300

# Studio 백엔드 CORS Origin 화이트리스트 구성
CorsAllowOriginSet:
  # CORS Origin 화이트리스트 활성화 여부, 기본 비활성화하여 호환성 유지; 활성화 시 화이트리스트 브라우저 Origin에 대해서만 Access-Control-Allow-Origin 반환
  enabled: false
  # 정확히 일치하는 프론트엔드 도메인 목록, 데이터 형식은 문자열 배열, 프로토콜, 도메인 및 선택적 포트를 포함해야 함
  # 예시: ["https://console.example.com", "https://uat-console.example.com:8443"]
  allowedOrigins: []
  # 제어된 와일드카드 규칙 목록, 데이터 형식은 문자열 배열, Origin 문자열에 대해 와일드카드 매칭 수행
  # 예시: ["https://*.example.com"]; 여러 하위 도메인을 허용해야 하는 경우에만 구성, "*" 사용은 권장하지 않음
  allowedOriginPatterns: []
  # 브라우저가 자격 증명을 포함한 CORS 요청을 허용할지 여부
  allowCredentials: true
  # 허용된 CORS 요청 메서드
  allowMethods: "GET,POST,HEAD,PATCH,PUT,OPTIONS,DELETE"

# 배포 플랜 로그인 제한
LoginLimitSet:
  # 동일 사용자 이름 연속 로그인 오류 재시도 횟수
  retry_times: 5
  # 연속 로그인 실패 retry_times 회 후 로그인 제한 시간, 기본 15분
  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],// 또는 상대 시간 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 # 시계열 데이터 worker 수, 기본값 8
    log_query_workers: 8 # 로그 데이터 worker 수, 기본값 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 # 시계열 데이터 worker 수, 기본값 8
    log_query_workers: 8    # 로그 데이터 worker 수, 기본값 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 # 시계열 데이터 worker 수, 기본값 8
    log_query_workers: 8 # 로그 데이터 worker 수, 기본값 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

...