アプリケーションサービス設定項目マニュアル
概要¶
このドキュメントでは、launcher の「アプリケーション設定の変更」機能を使用して関連設定を変更し、環境に合わせて設定を最適化し、カスタマイズする方法を説明します。
launcher の操作手順¶
- ブラウザで launcher コンソールにアクセスします。
- 右上隅のメニューからアプリケーション設定の変更画面を開きます。
- 該当する設定ファイルを変更するには、設定を変更するチェックボックスをオンにします。
- 設定の変更が完了したら、ページ下部右下の設定変更後自動で関連サービスを再起動するにチェックを入れ、設定を確定をクリックします。
サービスの主なよく使う設定の説明¶
Studio バックエンドサービス¶
設定ファイルの場所¶
- Namespace: forethought-core
- Launcher での設定名: Core
- Kubernetes の Configmap 名: core
設定ファイルの例¶
# Guance コンソールアドレスアクセスプロトコル
protocol: "http"
# Guance コンソールアドレス
hostname: "console.cloudcare.cn"
# 管理バックエンドサイトアクセスアドレス
managementHostname: "management.cloudcare.cn"
# 現在のサイト名
envName: Guance デプロイメントプラン
# システムのデバッグモードを有効にするかどうか(通常は無効)
debug: false
# システムのデフォルト言語
defaultLanguage: "zh"
# フロントエンドアクセスアドレスのプレフィックス。最初の2つの波括弧は 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_exp_set:
# Web 端のデフォルト設定 4 時間
front_web: 14400
# 管理バックエンドのトークン有効期限
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
# 1回のクエリまたはワークスペースリストフィルターで許可される最大ワークスペース UUID 数
maxWorkspaceCount: 20
# 1回の Trace クエリで明示的に limit を指定する場合の最大値
maxLimit: 1000
# 1回の 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
# 接続取得時に FIFO(先入れ先出し)ではなく LIFO(後入れ先出し)QueuePool を使用します。LIFO を使用すると、サーバー側のタイムアウト方式により、オフピーク時の使用接続数を減らせます。サーバー側のタイムアウトを計画する際は、pool_recycle または pool_pre_ping を使用して古い接続を適切に処理してください。
pool_use_lifo: true
# Logger Configuration
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
stdou
# 新しいワークスペース作成時のデフォルトの巨大ログ分割単位(バイト)
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 ホワイトリスト設定
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: []
# ブラウザが資格情報を伴うクロスオリジンリクエストを許可するかどうか
allowCredentials: true
# 許可されるクロスオリジンリクエストメソッド
allowMethods: "GET,POST,HEAD,PATCH,PUT,OPTIONS,DELETE"
# デプロイメントプランのログイン制限
LoginLimitSet:
# 同一ユーザー名での連続ログインエラー再試行回数
retry_times: 5
# 連続ログイン失敗 retry_times 回後にログインを制限する時間(デフォルト 15 分)
exp: 900
...
設定項目の詳細説明¶
| 設定項目 | サブ項目 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|
| protocol | 文字列 | http | Guance コンソールアドレスアクセスプロトコル | |
| hostname | 文字列 | console.cloudcare.cn | Guance コンソールアドレス | |
| managementHostname | 文字列 | management.cloudcare.cn | 管理バックエンドサイトアクセスアドレス | |
| envName | 文字列 | Guance | 現在のサイト名 | |
| debug | ブール | false | デバッグモードスイッチ | |
| frontServerUrlPrefixFormat | 文字列 | {}://{} | フロントエンドアクセスアドレスのプレフィックス。最初の2つの波括弧は protocol と hostname で置き換えられます。統一した2次アドレスを設定する場合は、この設定を直接調整してください。 | |
| enableApmServiceTopology | ブール | false | 「APM > サービス > サービスマップ」のクロスワークスペースクエリエントリを有効にするかどうか。デプロイメントプランで有効にすると、フロントエンドは権限とバージョン条件を満たした場合に空間範囲セレクターを表示します。このスイッチは kodo-inner の servicemap.cross_workspace_on とは独立しており、シナリオに応じて併用できます。 |
|
| external | timeliness | 数値 | 60 | 各リクエストの署名の有効期限(秒) |
| accessKey | 文字列 | 旧バージョンの単一アカウント AK 設定。過去の環境との互換性のために保持。privilege=w の読み書きアカウントと同等。新しい環境では accounts 設定の使用を推奨。 |
||
| secretKey | 文字列 | 旧バージョンの単一アカウント SK 設定。accessKey と組み合わせて使用。ログには書き込まれません。 |
||
| 文字列 | ExternalAPI リクエストコンテキストで表示されるデフォルトのメールアドレス。accounts[].email が空の場合、この設定にフォールバックします。 |
|||
| accounts | リスト | [] | ExternalAPI のマルチアカウント設定リスト。読み書きアカウントと読み取り専用アカウントの分離をサポート。空の場合は旧バージョンの accessKey/secretKey 設定のみが使用されます。 |
|
| accounts[].name | 文字列 | アカウント識別子。ログ、監視、トラブルシューティングにのみ使用。新しい構造では必須。"default" は使用不可。primary-write、security-readonly など用途がわかる名前を推奨。 |
||
| accounts[].accessKey | 文字列 | 現在のアカウントのリクエストヘッダー X-Df-Access-Key で使用される AK |
||
| accounts[].secretKey | 文字列 | 現在のアカウントに対応する署名 SK。サーバー側の検証のみに使用。ログには書き込まれません。 | ||
| accounts[].privilege | 文字列 | w | 現在のアカウントの権限。w は読み書きアカウントで、privilege=r/w のインターフェースにアクセス可能。r は読み取り専用アカウントで、privilege=r のインターフェースのみアクセス可能。 |
|
| accounts[].email | 文字列 | 現在のアカウントが ExternalAPI リクエストコンテキストで表示するメールアドレス。空の場合は external.email にフォールバック。 |
||
| accounts[].enabled | ブール | true | 現在のアカウントを有効にするかどうか。false に設定すると認証に使用できません。 |
|
| defaultLanguage | 文字列 | zh | システムのデフォルト言語。新しいワークスペースで言語が指定されていない場合、この設定値がデフォルトで使用されます。 | |
| token_exp_set | front_web | 数値 | 14400 | Studio ブラウザ端末のユーザーログイン有効期間(秒) |
| manage | 数値 | 7200 | 管理バックエンドブラウザ端末のユーザーログイン有効期間(秒) | |
| apiDocPageSwitch | admin | ブール | false | 管理バックエンドの API インターフェースドキュメント公開スイッチ |
| front | ブール | false | Studio バックエンド API インターフェースドキュメント公開スイッチ | |
| inner | ブール | false | Inner サービス API インターフェースドキュメント公開スイッチ | |
| openapi | ブール | false | OpenAPI インターフェースドキュメント公開スイッチ | |
| external | ブール | false | External API インターフェースドキュメント公開スイッチ | |
| BusinessQueryViewTimeOffset | 数値 | 900 | RUM Resource に対応するリンクデータをクエリする際の前後の時間オフセット範囲(秒) | |
| SameOrgTraceQuerySet | enable | ブール | false | 同一組織内のクロスワークスペース Trace クエリを許可するかどうか。無効の場合、同一組織のワークスペース簡略化情報リストインターフェースは引き続き使用できますが、Trace クエリインターフェースは現在のワークスペースのみクエリ可能。 |
| maxWorkspaceCount | 数値 | 20 | 1回の同一組織 Trace クエリおよびワークスペースリストフィルターで許可される最大ワークスペース UUID 数 | |
| maxLimit | 数値 | 1000 | 1回の同一組織 Trace クエリで明示的に limit を指定する場合の最大値 |
|
| maxTimeRangeHours | 数値 | 24 | 1回の同一組織 Trace クエリで許可される最大時間ウィンドウ(時間) | |
| workspaceListPageSizeMax | 数値 | 100 | 同一組織のワークスペース簡略化情報リストインターフェースで許可される最大ページサイズ | |
| database | connection | 文字列 | データベース接続文字列 | |
| pool_size | 数値 | 20 | 単一ワーカーの接続プール接続数の通常サイズ | |
| max_overflow | 数値 | 100 | 単一ワーカーの接続プール接続の最大オーバーフロー数 | |
| pool_timeout | 数値 | 30 | データベース接続タイムアウト(秒) | |
| pool_recycle | 数値 | 3600 | 接続プールの接続リサイクル時間を制御します。接続作成後、指定された時間が経過するとリサイクルされます(秒)。通常、pool_pre_ping、pool_use_lifo と組み合わせて使用し、pool_use_lifo は true にする必要があります。接続リサイクルメカニズムは、データベース接続が使用されたときにのみトリガーされることに注意してください。 | |
| pool_pre_ping | ブール | true | 接続プールの「事前 ping」機能を有効にします。使用時に接続の活性をテストします。 | |
| pool_use_lifo | ブール | true | 接続取得時に FIFO(先入れ先出し)ではなく LIFO(後入れ先出し)QueuePool を使用します。 | |
| logger | filename | 文字列 | /logdata/business.log | ログファイル |
| level | 文字列 | info | ログの最低レベル | |
| max_bytes | 数値 | 52428800 | 各ログファイルの最大サイズ(バイト) | |
| backup_count | 数値 | 3 | ログファイルのローテーション総数 | |
| output_mode_switch.file | true | ログ出力方法の制御スイッチ。ファイルへの出力をサポート | ||
| output_mode_switch.stdout | true | ログ出力方法の制御スイッチ。stdout への出力をサポート | ||
| g_access_logger | gunicorn ログ設定。関連するサブ設定項目は logger と同じ | |||
| workspaceLoggingCutSizeSet | es | 数値 | 10240 | 新しいワークスペース作成時のデフォルトの巨大ログ分割単位(バイト)。ストレージタイプ: elasticsearch/OpenSearch |
| sls | 数値 | 2048 | 新しいワークスペース作成時のデフォルトの巨大ログ分割単位(バイト)。ストレージタイプ: Alibaba Cloud の SLS ストレージ | |
| beaver | 数値 | 2048 | 新しいワークスペース作成時のデフォルトの巨大ログ分割単位(バイト)。ストレージタイプ: 日志易 | |
| doris | 数値 | 10240 | 新しいワークスペース作成時のデフォルトの巨大ログ分割単位(バイト)。ストレージタイプ: doris | |
| WorkspaceDefaultStatsConfig.unlimited.durationSet | json | 新しいワークスペースのデフォルトデータ保持期間設定 | ||
| rp | 文字列 | 30d | メジャーメントのデフォルトデータ保持期間 | |
| logging | 文字列 | 14d | ログのデフォルトデータ保持期間 | |
| keyevent | 文字列 | 14d | イベントのデフォルトデータ保持期間 | |
| tracing | 文字列 | 7d | トレースのデフォルトデータ保持期間 | |
| rum | 文字列 | 7d | RUM のデフォルトデータ保持期間 | |
| network | 文字列 | 2d | ネットワークのデフォルトデータ保持期間 | |
| security | 文字列 | 90d | セキュリティチェックのデフォルトデータ保持期間 | |
| backup_log | 文字列 | 180d | バックアップログのデフォルトデータ保持期間 | |
| WorkspaceDefaultStatsConfig | isOpenLogMultipleIndex | ブール | true | ワークスペース作成時、カスタムログインデックスを有効にするかどうか |
| logMultipleIndexCount | 数値 | 6 | ワークスペース作成時、カスタムログインデックス数 | |
| loggingCutSize | 数値 | 6 | ワークスペース作成時、巨大ログカウント単位 10KB | |
| maxSearchResultCount | 数値 | 0 | クエリ数上限 0 | |
| WorkspaceDefaultesIndexSettings | number_of_shards | 数値 | 1 | ワークスペース作成時、プライマリシャード数。ストレージタイプが es の場合に有効 |
| number_of_replicas | 数値 | 1 | ワークスペース作成時、レプリカを有効にするかどうか。ストレージタイプが es/doris の場合に有効 | |
| rollover_max_size | 数値 | 30 | ワークスペース作成時、シャードサイズ。ストレージタイプが es/doris の場合に有効 | |
| hot_retention | 数値 | 24 | ワークスペース作成時、ホットデータ期間。ストレージタイプが es/doris の場合に有効 | |
| openapiCurrentLimitingSet | json | openapi レート制限設定 | ||
| isOpen | ブール | false | openapi レート制限スイッチ。デフォルトは無効 | |
| openapiCurrentLimitingSet.crontabSet | json | 定期タスク設定 | ||
| hour | 文字列 | "*" | crontab の時間設定。デフォルトは毎時 | |
| minute | 文字列 | "*/1" | crontab の分設定。デフォルトは毎分 | |
| openapiCurrentLimitingSet.frequency | json | 制限設定 | ||
| ak | 数値 | 100 | ak レベルの呼び出しレート制限 100 回/分 | |
| workspace | 数値 | 300 | ワークスペースレベルの呼び出しレート制限 300 回/分 | |
| CorsAllowOriginSet | json | Studio バックエンド CORS Origin ホワイトリスト設定。無効時は互換性のある動作を維持。有効時はホワイトリスト内のブラウザ Origin のみに Access-Control-Allow-Origin を返します。Origin のないサービス内呼び出しは CORS の影響を受けません。 |
||
| enabled | ブール | false | CORS Origin ホワイトリストを有効にするかどうか。専用環境でクロスオリジンソースを制限する必要がある場合に true に設定。 | |
| allowedOrigins | 配列 | [] | 完全一致のフロントエンドドメインリスト。データ形式は文字列配列。プロトコル、ドメイン、オプションのポートを含める必要があります。例: ["https://console.example.com", "https://uat-console.example.com:8443"]。 |
|
| allowedOriginPatterns | 配列 | [] | 制御されたワイルドカードルールリスト。データ形式は文字列配列。Origin 文字列に対してワイルドカードマッチングを行います。例: ["https://*.example.com"]。"*" の設定は推奨しません。 |
|
| allowCredentials | ブール | true | ホワイトリストに一致した場合に Access-Control-Allow-Credentials: true を返すかどうか。ブラウザが Cookie や認証ヘッダーなどの資格情報を伴うクロスオリジンリクエストを許可します。 |
|
| allowMethods | 文字列 | GET,POST,HEAD,PATCH,PUT,OPTIONS,DELETE | 許可されるクロスオリジンリクエストメソッドのリスト。複数のメソッドはカンマ区切り。 | |
| LoginLimitSet | json | デプロイメントプランのログイン制限 | ||
| retry_times | 数値 | 5 | 同一ユーザー名での連続ログインエラー再試行回数 | |
| exp | 数値 | 900 | 連続ログイン失敗 retry_times 回後にログインを制限する時間(デフォルト 15 分、単位は秒) |
Studio フロントエンドサイト¶
設定ファイルの場所¶
- Namespace:forethought-webclient
- Launcher での設定名:frontWeb
- Kubernetes の Configmap 名:front-web-config
設定ファイルの例¶
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
}
...
}
設定項目の詳細説明¶
| 設定項目 | サブ項目 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|
| rumDatawayUrl | 文字列 | "https://rum-openway.guance.com" | RUM データを送信するための専用 DataWay アドレス。設定後、RUM 接続設定ページに表示されます。 | |
| datakitScriptUrl | 文字列 | "https://static.guance.com/datakit" | DataKit インストールページのデフォルトインストールスクリプトダウンロードドメイン。内部の静的リソースを自前で構築している場合は、この設定を変更してください。 | |
| datakitHelmUrl | 文字列 | "https://pubrepo.guance.com" | DataKit Helm イメージレジストリアドレス。自前のイメージレジストリを使用する場合は、この設定を変更してください。 | |
| passPublicNetwork | 数値 | 1 | Studio サイトにアクセスするクライアントマシンがパブリックネットワークにアクセスできるかどうかを設定します。0:不可、1:可。 | |
| isOverseas | 数値 | 0 | この Guance サイトが海外展開かどうかを設定します。RUM の世界地図、中国地図コンポーネントの表示に影響します。 | |
| maxTraceSpanLimit | 数値 | 10000 | トレースのフレームグラフにおける最大 Span 数。デフォルト値:10000。 | |
| maxProfileM | 数値 | 5 | プロファイルを取得してフレームグラフを表示する際の最大 MB 数。設定しない場合、デフォルト値は 5。 | |
| paasCustomLoginInfo | 配列 | なし | デプロイメントプラン Guance コンソールログインページのシングルサインオンエントリ設定。iconUrl、desc カスタムフィールドを追加。iconUrl は SSO アイコンアドレス、設定しない場合はデフォルトアイコン。desc は SSO 説明文。 | |
| paasCustomSiteList | 配列 | なし | デプロイメントプラン Guance コンソールログインページに複数サイト選択設定を追加。label はサイト表示テキスト、url はサイトアドレス。複数サイトが存在しない場合は、この設定項目を追加する必要はありません。 | |
rumEnable セルフモニタリング |
Boolean | なし | RUM を有効にするかどうか。1 で有効。有効にしない場合、以下の設定値は空でも構いません。 | |
rumDatakitUrl セルフモニタリング |
文字列 | なし | RUM DataKit のアドレス、またはパブリックネットワークの openway アドレス。 | |
rumApplicationId セルフモニタリング |
文字列 | なし | RUM アプリケーション ID。アプリケーションデータの送信に使用されます。 | |
rumJsUrl セルフモニタリング |
文字列 | なし | RUM SDK CDN アドレス。 | |
rumTrackInteractions セルフモニタリング |
Boolean | なし(無効) | ユーザーアクションデータ(Action)の収集を有効にするかどうか。 | |
rumClientToken セルフモニタリング |
文字列 | なし | RUM Openway 方式でデータを送信する場合(rumOpenwayUrl と併用が必要)、Guance プラットフォームで生成された clientToken。datakit 送信方式と競合し、優先度は datakit 送信方式より高いです。 |
|
rumOpenwayUrl セルフモニタリング |
文字列 | なし | RUM Openway パブリックネットワークアドレス(rumClientToken と併用が必要)。Studio フロントエンドサイトのセルフモニタリングデータ送信に使用されます。 |
|
isDesensitizeUser セルフモニタリング |
Boolean | なし | セルフモニタリングのユーザーメールアドレスおよびユーザー名のデータマスキングを有効にするかどうか。true で有効、false で無効。 | |
| paasCustomLoginUrl | 文字列 | なし | カスタムログイン URL。 | |
| maxMessageByte | 文字列 | なし | ログエクスプローラーのリストで message が表示する最大バイト数。未設定の場合はデフォルトで 10 * 1024。 | |
| webRumSdkUrl | 文字列 | なし | Rum web SDK CDN アドレス。未設定の場合はデフォルトで https://static.guance.com/browser-sdk/v3/dataflux-rum.js。 | |
| defaultTimeMap | 文字列または オブジェクト | なし | エクスプローラーのデフォルト初期化時間設定。形式は {'log': '5m'} または {'log': [1732254771701,1732255671701]}。オブジェクトのキーは固定文字列。ログエクスプローラーは log、セキュリティチェックは security。 |
|
| maxPipelineRulesCharacters | 数値 | 10240 | Pipeline 解析ルールでサポートされる最大文字数。設定しない場合、デフォルト値は 10240。 | |
| hideTesingOperator | Boolean | false | テストボタンを非表示にするかどうか。 |
kodo コンポーネント¶
設定ファイルの場所¶
- Namespace: forethought-kodo
- Launcher での設定名: Kodo
- Kubernetes の Configmap 名: kodo
設定ファイルの例¶
...
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
...
...
設定項目の詳細説明¶
| 設定項目 | サブ項目 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|
| log | log_file | 文字列 | '/logdata/log' | 実行ログの保存先。stdout を指定すると標準出力に出力され、ファイルには保存されません。 |
| level | 文字列 | 'info' | 実行ログの最低レベル | |
| gin_log_file | 文字列 | '/logdata/log' | gin ログの保存先。stdout を指定すると標準出力に出力され、ファイルには保存されません。 | |
| database | db_dialect | 文字列 | 'mysql' | データベースタイプ。デフォルトは mysql。 |
| addr | 文字列 | 'testsql.com:3306' | データベース接続アドレス。 | |
| username | 文字列 | ' test_user' | ユーザー名。 | |
| password | 文字列 | 'test_password' | パスワード。 | |
| network | 文字列 | 'tcp' | 接続プロトコル。 | |
| db_name | 文字列 | 'test_db_name' | データベース名。 | |
| nsq | lookupd | 文字列 | 'testnsq.com:4161' | nsq lookupd アドレス。 |
| discard_expire_interval | 数値 | 5 | 時系列データの最大冗長時間(分)。デフォルトでは、時系列メトリクスデータが 5 分以上遅延した場合、書き込まれません。 | |
| redis | host | 文字列 | 'testredis.com:6379' | データ処理用の Redis アドレス。クラスター版をサポート。注:すべての kodo 関連コンポーネントの Redis 設定は一致している必要があります。 |
| password | 文字列 | 'test_password' | パスワード。 | |
| db | 数値 | 0 | redis db 値。 | |
| is_cluster | ブール | false | Redis がクラスターであり、プロキシ接続をサポートしていない場合、true に設定する必要があります。 | |
| asynq_redis | host | 文字列 | '' | 非同期タスク用の Redis アドレス。デフォルトでは redis 設定を使用します。クラスター版はサポートしていません。redis 設定がクラスター版の場合、非クラスター版の asynq_redis を設定する必要があります。 |
| password | 文字列 | 'test_password' | パスワード。 | |
| db | 数値 | 0 | redis db 値。 |
kodo-inner コンポーネント¶
設定ファイルの場所¶
- Namespace: forethought-kodo
- Launcher での設定名: KodoInner
- Kubernetes の Configmap 名: kodo-inner
設定ファイルの例¶
...
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
...
...
設定項目の詳細説明¶
| 設定項目 | サブ項目 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|
| log | log_file | 文字列 | '/logdata/log' | 実行ログの保存先。stdout を指定すると標準出力に出力され、ファイルには保存されません。 |
| level | 文字列 | 'info' | 実行ログの最低レベル | |
| gin_log_file | 文字列 | '/logdata/log' | gin ログの保存先。stdout を指定すると標準出力に出力され、ファイルには保存されません。 | |
| database | db_dialect | 文字列 | 'mysql' | データベースタイプ。デフォルトは mysql。 |
| addr | 文字列 | 'testsql.com:3306' | データベース接続アドレス。 | |
| username | 文字列 | ' test_user' | ユーザー名。 | |
| password | 文字列 | 'test_password' | パスワード。 | |
| network | 文字列 | 'tcp' | 接続プロトコル。 | |
| db_name | 文字列 | 'test_db_name' | データベース名。 | |
| nsq | lookupd | 文字列 | 'testnsq.com:4161' | nsq lookupd アドレス。 |
| discard_expire_interval | 数値 | 5 | 時系列データの最大冗長時間(分)。デフォルトでは、時系列メトリクスデータが 5 分以上遅延した場合、書き込まれません。 | |
| redis | host | 文字列 | 'testredis.com:6379' | データ処理用の Redis アドレス。クラスター版をサポート。注:すべての kodo 関連コンポーネントの Redis 設定は一致している必要があります。 |
| password | 文字列 | 'test_password' | パスワード。 | |
| db | 数値 | 0 | redis db 値。 | |
| is_cluster | ブール | false | Redis がクラスターであり、プロキシ接続をサポートしていない場合、true に設定する必要があります。 | |
| asynq_redis | host | 文字列 | '' | 非同期タスク用の Redis アドレス。デフォルトでは redis 設定を使用します。クラスター版はサポートしていません。redis 設定がクラスター版の場合、非クラスター版の asynq_redis を設定する必要があります。 |
| password | 文字列 | 'test_password' | パスワード。 | |
| db | 数値 | 0 | redis db 値。 | |
| dql | metric_query_workers | 数値 | 32 | DQL メトリクスデータクエリ worker 数 |
| query_metric_channel_size | 数値 | 32 | 各 metric_query_worker のリクエストキューサイズ | |
| log_query_workers | 数値 | 32 | DQL ログテキスト系(ログ、トレース、RUM などすべてのテキスト系データ)データクエリ worker 数 | |
| query_log_channel_size | 数値 | 32 | 各 log_query_worker のリクエストキューサイズ | |
| general_query_workers | 数値 | 32 | メトリクスまたはログ以外のクエリ worker 数 | |
| query_general_channel_size | 数値 | 32 | 各 general_query_worker のリクエストキューサイズ | |
| profiling_parse | ブール | true | DQL クエリでメトリクスを有効にし、クエリの各フェーズの所要時間を統計するかどうか | |
| influxdb | read_timeout | 数値 | 60 | 時系列メトリクスデータのクエリタイムアウト(秒)。デフォルトは 60 秒。 |
| dial_timeout | 数値 | 30 | 時系列メトリクスデータのクエリ時の接続確立タイムアウト(ミリ秒)。デフォルトは 30 ミリ秒。 | |
| doris | read_timeout | 数値 | 60 | ログ系データのクエリタイムアウト(秒)。デフォルトは 60 秒。 |
| dial_timeout | 数値 | 30 | ログ系データのクエリ時の接続確立タイムアウト(ミリ秒)。デフォルトは 30 ミリ秒。 | |
| global | datakit_usage_check_enabled | ブール | false | ログクエリ時に、datakit 数がライセンス制限を超えているかどうかをチェックするかどうか。デフォルトはチェックしない。 |
| servicemap | cross_workspace_on | ブール | true | サービスマップのクロスワークスペースクエリ機能を有効にするかどうか。有効にすると、Kodo が ServiceMap をクエリする際にクロスワークスペースのサービス呼び出し関係をサポートします。このスイッチは Studio バックエンドの enableApmServiceTopology とは独立しており、シナリオに応じて併用できます。 |
kodo-x コンポーネント¶
設定ファイルの場所¶
- Namespace: forethought-kodo
- Launcher での設定名: KodoX
- Kubernetes の Configmap 名: kodo-x
設定ファイルの例¶
...
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"
...
設定項目の詳細説明¶
| 設定項目 | サブ項目 | タイプ | デフォルト値 | 説明 |
|---|---|---|---|---|
| log | log_file | 文字列 | '/logdata/log' | 実行ログの保存先。stdout を指定すると標準出力に出力され、ファイルには保存されません。 |
| level | 文字列 | 'info' | 実行ログの最低レベル | |
| gin_log_file | 文字列 | '/logdata/log' | gin ログの保存先。stdout を指定すると標準出力に出力され、ファイルには保存されません。 | |
| database | db_dialect | 文字列 | 'mysql' | データベースタイプ。デフォルトは mysql。 |
| addr | 文字列 | 'testsql.com:3306' | データベース接続アドレス。 | |
| username | 文字列 | ' test_user' | ユーザー名。 | |
| password | 文字列 | 'test_password' | パスワード。 | |
| network | 文字列 | 'tcp' | 接続プロトコル。 | |
| db_name | 文字列 | 'test_db_name' | データベース名。 | |
| nsq | lookupd | 文字列 | 'testnsq.com:4161' | nsq lookupd アドレス。 |
| discard_expire_interval | 数値 | 5 | 時系列データの最大冗長時間(分)。デフォルトでは、時系列メトリクスデータが 5 分以上遅延した場合、書き込まれません。 | |
| redis | host | 文字列 | 'testredis.com:6379' | データ処理用の Redis アドレス。クラスター版をサポート。注:すべての kodo 関連コンポーネントの Redis 設定は一致している必要があります。 |
| password | 文字列 | 'test_password' | パスワード。 | |
| db | 数値 | 0 | redis db 値。 | |
| is_cluster | ブール | false | Redis がクラスターであり、プロキシ接続をサポートしていない場合、true に設定する必要があります。 | |
| asynq_redis | host | 文字列 | '' | 非同期タスク用の Redis アドレス。デフォルトでは redis 設定を使用します。クラスター版はサポートしていません。redis 設定がクラスター版の場合、非クラスター版の asynq_redis を設定する必要があります。 |
| password | 文字列 | 'test_password' | パスワード。 | |
| db | 数値 | 0 | redis db 値。 | |
| global | workers | 数値 | 8 | 各種データのデフォルト処理 worker 数 |
| metric_workers | 数値 | 8 | 時系列メトリクスデータの処理 worker 数 | |
| log_workers | 数値 | 8 | ログデータの処理 worker 数 | |
| tracing_workers | 数値 | 8 | トレースデータの処理 worker 数。デフォルトでは log_workers 設定項目の値を使用します。 | |
| sub_topic_max_expire_seconds | オブジェクト | オプション値は df_audit_event(監査イベント)、df_dialtesting(Synthetic モニタリング)、df_event(イベント)、df_logging(ログ)、df_network(ネットワーク)、df_object(インフラストラクチャー)、df_profiling(プロファイリング)、df_rum(RUM)、df_security(セキュリティチェック)、df_tracing(APM)。例: df_logging: 3600。これは 1 時間前のログは直接破棄され、消費されないことを意味します。 | ||
| influxdb | read_timeout | 数値 | 60 | 時系列メトリクスデータのクエリタイムアウト(秒)。デフォルトは 60 秒。 |
| write_timeout | 数値 | 300 | 時系列メトリクスデータの書き込みタイムアウト(秒)。デフォルトは 5 分。 | |
| enable_gz | ブール | false | データ書き込み時に gzip 圧縮を有効にするかどうか。 | |
| dial_timeout | 数値 | 30 | 時系列メトリクスデータのクエリ時の接続確立タイムアウト(ミリ秒)。デフォルトは 30 ミリ秒。 | |
| doris | read_timeout | 数値 | 60 | ログ系データのクエリタイムアウト(秒)。デフォルトは 60 秒。 |
| write_timeout | 数値 | 300 | ログ系データの書き込みタイムアウト(秒)。デフォルトは 5 分。 | |
| gzip_enable | ブール | false | データ書き込み時に gzip 圧縮を有効にするかどうか。 | |
| dial_timeout | 数値 | 30 | ログ系データのクエリ時の接続確立タイムアウト(ミリ秒)。デフォルトは 30 ミリ秒。 | |
| backup_kafka | async | ブール | false | Kafka へのデータ転送の書き込み方式。デフォルトは同期書き込み。 |
| write_timeout | 数値 | 30 | Kafka への書き込みタイムアウト(秒)。デフォルトは 30 秒。 | |
| max_bulk_docs | 数値 | 0 | 複数のログを 1 つの Kafka メッセージにまとめて送信するかどうか。デフォルトでは、1 つのログが 1 つの Kafka メッセージを構成します。 | |
| pipeline | enable | ブール | false | true に設定すると、センター Pipeline 機能を有効にします。 |
| pull_duration | 文字列 | 1m | センター Pipeline スクリプトの同期間隔。デフォルト値 1m は 1 分ごとに同期することを意味します。s、m、h などの時間間隔表記をサポートします。例:1m30s は 1 分 30 秒ごとにセンター Pipeline スクリプトを同期します。 |
kodo-servicemap コンポーネント¶
設定ファイルの場所¶
- Namespace: forethought-kodo
- Launcher での設定名: kodoServiceMap
- Kubernetes の Configmap 名: kodo-servicemap
設定ファイルの例¶
...
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 | 文字列 | '' | データ処理用の Redis アドレス。クラスター版をサポート。注:すべての kodo 関連コンポーネントの Redis 設定は一致している必要があります。 |
| asynq_redis | host | 文字列 | '' | 非同期タスク用の Redis アドレス。デフォルトでは redis 設定を使用します。クラスター版はサポートしていません。redis 設定がクラスター版の場合、非クラスター版の asynq_redis を設定する必要があります。 |
kodo-x-scan コンポーネント¶
設定ファイルの場所¶
- Namespace: forethought-kodo
- Launcher での設定名: kodoXScan
- Kubernetes の Configmap 名: kodo-x-scan
設定ファイルの例¶
...
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 | 文字列 | '' | データ処理用の Redis アドレス。クラスター版をサポート。注:すべての kodo 関連コンポーネントの Redis 設定は一致している必要があります。 |
| asynq_redis | host | 文字列 | '' | 非同期タスク用の Redis アドレス。デフォルトでは redis 設定を使用します。クラスター版はサポートしていません。redis 設定がクラスター版の場合、非クラスター版の asynq_redis を設定する必要があります。 |
kodo-ws コンポーネント¶
設定ファイルの場所¶
- Namespace: forethought-kodo
- Launcher での設定名: kodoWS
- Kubernetes の Configmap 名: kodo-ws
設定ファイルの例¶
...
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 | 文字列 | '' | データ処理用の Redis アドレス。クラスター版をサポート。注:すべての kodo 関連コンポーネントの Redis 設定は一致している必要があります。 |
| asynq_redis | host | 文字列 | '' | 非同期タスク用の Redis アドレス。デフォルトでは redis 設定を使用します。クラスター版はサポートしていません。redis 設定がクラスター版の場合、非クラスター版の asynq_redis を設定する必要があります。 |

