[カスタム設定] タブでは、プローブ機能のトグルやサンプリングポリシーなど、一般的な設定を調整できます。
これらの設定を ARMS API を使用して構成する方法については、「SaveTraceAppConfig」をご参照ください。
前提条件
ご利用のアプリケーションに ARMS プローブがインストールされている必要があります。詳細については、「アプリケーション監視の概要」をご参照ください。
機能へのアクセス
-
ARMS コンソールにログインします。左側のナビゲーションウィンドウで、を選択します。
上部のナビゲーションバーで、を選択します。
カスタム設定を構成し、[保存] をクリックします。
サンプリング設定
「[サンプリング設定]」セクションでは、トレースのサンプリングポリシーを設定できます。Go アプリケーションは固定レートサンプリングのみをサポートします。また、インターフェイス名、プレフィックス、またはサフィックスに基づいてフルサンプリングを設定することもできます。
プローブトグル設定
[プローブトグル設定] セクションでは、アプリケーション監視を有効または無効にし、個々のプラグインを切り替えることができます。
Application Monitoring の有効化または無効化はすぐに有効になります。アプリケーションを再起動する必要はありません。Application Monitoring を一時停止すると、ARMS はご利用のアプリケーションの監視を停止します。注意して進めてください。
個別のプラグインの切り替えは、アプリケーションを手動で再起動した後に有効になります。
ランタイムトグル設定
「[ランタイム切り替え設定]」セクションで、ランタイムモニタリングを有効化または無効化できます。詳細については、「ランタイムモニタリング」をご参照ください。
変更は動的に有効になります。アプリケーションを再起動する必要はありません。ランタイム監視を無効にすると、ARMS はランタイムメトリックの収集を停止します。注意して進めてください。
アプリケーションログ関連付け設定
[アプリケーションログ関連付け設定] セクションでは、ご利用のアプリケーションに関連付けるログソースを構成できます。これにより、SpanId と TraceId を対応するログに追加できます。詳細については、「Golang アプリケーションビジネスログと TraceId の関連付け」をご参照ください。
ログ内の trace_id と span_id に使用するキーをカスタマイズできます。
URL 収束設定
「[URL 収束設定]」セクションでは、URL 収束を有効化または無効化できます。また、収束しきい値と収束ルールを設定することもできます。URL 収束は、類似した URL を 1 つのエントリにグループ化します。たとえば、/service/demo/ で始まるすべての URL が単一のエントリとして表示されます。収束しきい値は、収束が発生する前に必要な一致 URL の最小数を定義します。たとえば、しきい値が 100 の場合、ARMS は指定された正規表現に一致する URL が少なくとも 100 個ある場合にのみ収束を実行します。詳細については、「ARMS 収束メカニズム」をご参照ください。
継続的プロファイリング設定
[継続的プロファイリング設定] セクションでは、グローバルトグル、CPU ホットスポット、メモリホットスポット、コードホットスポットを有効または無効にできます。詳細については、「Golang アプリケーションの継続的プロファイリング」をご参照ください。
API 呼び出し設定
[API 呼び出し設定] セクションでは、スローコールしきい値、HTTP ステータスコードホワイトリスト、および無効な API 呼び出しのフィルターを設定できます。
[スローコールしきい値]: デフォルト値は 500 です。インターフェイスの応答時間がこのしきい値より大きい場合、そのインターフェイスはスローコールとしてマークされます。
[HTTP ステータスコードホワイトリスト]:
デフォルトでは、400 より大きい HTTP ステータスコードはエラーとして分類されます。特定ステータスコードがエラーとして分類されないようにするには、それらをホワイトリストに追加できます。
この設定は、Application Monitoring でサポートされている HTTP フレームワークにのみ適用されます。詳細については、「サポートされている HTTP フレームワーク」をご参照ください。
[メトリックへの影響]: HTTP サーバーとクライアントのエラーカウント (arms_http_requests_error_count、arms_http_client_requests_error_count、および arms_app_requests_error_count) と Span ステータス。
[機能への影響]: アプリケーション概要、提供サービス、および依存サービスタブのエラーカウント。トレース分析ページでの Span ステータスとエラーカウントアラート。
[形式]: 単一のステータスコードを入力します。複数のステータスコードはコンマ (,) で区切ります。ファジーマッチングはサポートされていません。
[例]:
403,502[デフォルト値]: 空
[無効な API 呼び出しのフィルタリング]:
提供サービスタブから特定の呼び出しを非表示にするには、無視する API の名前を入力します。プローブはこれらの API のテレメトリーデータを報告しないため、API 呼び出しビューには表示されません。
[メトリックへの影響]: 指定された API のすべてのメトリックと Span は無視されます。
[機能への影響]: アプリケーション概要、提供サービス、および依存サービスタブの指定された API のすべてのメトリック。 トレース分析ページでの指定された API の Span カウント、呼び出しカウント、エラーカウント、およびスローコールアラート。
[形式]: 文字列または AntPath 式を使用して完全な API 名を照合します。複数のルールはコンマ (,) で区切ります。(デフォルトの AntPath 式は、既存データとの下位互換性のために含まれています。これらを削除しないでください。既存のルールの後に新しいルールを追加してください。)
[例]:
/api/test/*,/api/playground/create[デフォルト値]:
/**/*.jpg,/**/*.png,/**/*.js,/**/*.jpeg,/**/*.pdf,/**/*.xlsx,/**/*.txt,/**/*.docs,/**/*.gif,/**/*.csv[HTTP リクエストボディログの有効化]: 有効にすると、http.request.body フィールドが HTTP クライアント Span に表示されます。デフォルトの長さは 1024 文字です。
[HTTP リクエストヘッダーログの有効化]: 有効にすると、http.request.header フィールドが HTTP クライアント Span に表示されます。
[HTTP リクエストボディ長]: キャプチャされる HTTP リクエストボディの最大長。デフォルトの長さは 1024 文字です。
[HTTP 応答ヘッダーに TraceId を含める]: 有効にすると、ARMS はキー Eagleeye-TraceId を使用して TraceId を応答ヘッダーに追加します。
[HTTP 応答ボディログの有効化]: 有効にすると、http.response.body フィールドが HTTP サーバー Span に表示されます。
[HTTP 応答ヘッダーログの有効化]: 有効にすると、http.response.header フィールドが HTTP サーバー Span に表示されます。
[HTTP 応答ボディ長]: キャプチャされる HTTP 応答ボディの最大長。デフォルトの長さは 1024 文字です。
[Span に含める HTTP リクエストヘッダーキー]: 含めるヘッダーのキーをコンマ (,) で区切って入力します。この設定を構成すると、ARMS は http.request.header.key フィールドを HTTP クライアント Span に追加します。
[Span に含める HTTP 応答ヘッダーキー]: 含めるヘッダーのキーをコンマ (,) で区切って入力します。この設定を構成すると、ARMS は http.response.header.key フィールドを HTTP サーバー Span に追加します。
高度な例外フィルタリング設定
コレクションプラグインの異常: コレクションプラグインが異常かどうかを示します。
例外フィルターホワイトリスト: 例外分析タブから特定の例外を非表示にするには、例外統計から除外する例外名を入力します。
データベース呼び出し設定
[データベース呼び出し設定] セクションでは、スロー SQL しきい値、キャプチャされた SQL ステートメントの最大長、および SQL ステートメントにバインドされた変数値と定数値を表示するかどうかを設定できます。
[SQL でバインドされた変数値を表示]: PreparedStatement パラメーターにバインドされた変数値をキャプチャします。変更はアプリケーションを再起動せずに有効になります。
[SQL で定数値を表示]: この設定は SQL ステートメントを切り詰めるだけで、追加処理は行われず、アプリケーションを再起動せずに有効になります。
トレース伝播プロトコル設定
「[トレース伝搬プロトコル設定]」セクションでは、ニーズに合ったトレースプロトコルを選択できます。W3C はデフォルトプロトコルです。Zipkin、Jaeger、または EagleEye も選択できます。
プローブコレクション設定
[プローブコレクション設定] セクションでは、1 秒あたりに収集されるトレースの最大数とプローブログレベルを設定できます。
一部のパラメーターの説明は次のとおりです。
[カスタムメトリックコレクション]: エージェントが OpenTelemetry SDK を使用してご利用のコードで定義されたメトリックを収集するかどうかを制御します。
[Span レポートの有効化]: デフォルトで有効になっています。無効にすると、Span は報告されません。
[Span レポート名]: シャットダウン後に報告される Span の名前を指定します。
[カスタムメトリックコレクション設定]: メトリックスコープ名を構成します。構成されていない場合、すべてのカスタムメトリックがデフォルトで収集されます。
[デフォルトメトリックコレクションフィルタリング]: 報告されるメトリックのタイプをフィルターします。次のタイプのいずれかまたは複数を選択できます。
custom_entry: メソッド監視のカスタムメトリック。
http: HTTP サーバーのメトリック。
http_client: HTTP クライアントのメトリック。
rpc: RPC サーバー呼び出しのメトリック。
rpc_client: RPC クライアント呼び出しのメトリック。
sql: データベースアクセスのメトリック。
nosql: NoSQL サービスアクセスのメトリック。
cache: キャッシュサービスアクセスのメトリック。
producer: メッセージ発行のメトリック。
consumer: メッセージ消費のメトリック。
schedule: スケジュールサービスのメトリック。
高度な設定
[高度な設定] セクションでは、パーセンタイル計算、スローコールとエラーサンプリング、および例外の最大スタックトレース長を構成できます。
他のアプリケーションへの設定のコピー
他のアプリケーションに同じ設定を同期するには、対応する設定を他のアプリケーションにコピーできます。
単一の設定を他のアプリケーションにコピー
設定のセクションで、[保存して他のアプリケーションに一括コピー] をクリックします。
[現在の設定が保存されていません] ダイアログボックスが表示された場合は、[OK] をクリックして現在のアプリケーションの設定を保存し、再度 [保存して他のアプリケーションに一括コピー] をクリックします。
表示されたダイアログボックスで、設定を適用するアプリケーションを選択し、[OK] をクリックします。
すべての設定を他のアプリケーションにコピー
ページの下部で、[保存して他のアプリケーションに一括コピー] をクリックします。
[現在の設定が保存されていません] ダイアログボックスが表示された場合は、[OK] をクリックして現在のアプリケーションの設定を保存し、再度 [保存して他のアプリケーションに一括コピー] をクリックします。
表示されたダイアログボックスで、設定を適用するアプリケーションを選択し、[OK] をクリックします。
グローバルデフォルト構成
現在の設定をグローバルデフォルト構成として保存できます。新しいアプリケーションを作成すると、これらの設定がデフォルトで使用されます。
ページの下部で、[現在のアプリ設定をグローバルデフォルト構成として保存] をクリックします。
[現在の設定が保存されていません] ダイアログボックスが表示された場合は、[OK] をクリックして現在のアプリケーションの設定を保存し、再度 [現在のアプリ設定をグローバルデフォルト構成として保存] をクリックします。
表示されたダイアログボックスで、[確認] をクリックします。