トレースポリシー

ポリシー名

トレース

概要

グローバルトレース設定を上書きする

カテゴリ

トラブルシューティング

使用可能な最小 Flex Gateway バージョン

1.10.0

返される状況コード

このポリシーの戻りコードは存在しません

概要

トレースポリシーにより、API のグローバル分散トレースパラメーターを上書きできます。

始める前に

分散トレースはこのデフォルトで無効になっています。Flex Gateway グローバル設定を使用して分散トレースを有効化した後に、このポリシーを使用して API のグローバル分散トレースパラメーターを上書きできるようになります。

分散トレースを有効にする方法についての詳細は、以下を参照してください。

ポリシーのパラメーターの設定

Flex Gateway のローカルモード

ローカルモードでは、宣言型の設定ファイルを使用してポリシーを API に適用します。以下のポリシー定義とパラメーターの表を参照してください。

- policyRef:
    name: tracing-flex
  config:
    sampling:
      client: number // REQUIRED
      random: number // REQUIRED
      overall: number // REQUIRED
    labels: <array> // OPTIONAL, default: []
      - name: <string> // REQUIRED
        type: <string> // REQUIRED
        keyName: <string> // REQUIRED
        defaultValue: <string> // REQUIRED

パラメーター必須または省略可能デフォルト値説明

パラメーター	必須または省略可能	デフォルト値	説明
`sampling.client`	必須	100	`x-client-trace-id` ヘッダーが設定されている場合に強制的に追跡される要求の対象パーセンテージ。
`sampling.random`	必須	100	クライアントによって要求されない場合、または強制されない場合に、トレース生成にランダムに選択される要求の対象パーセンテージ。
`sampling.overall`	必須	100	クライアントダイレクト、強制トレース、ランダムサンプリングなど、他のすべてのサンプリングチェックが適用された後に追跡される要求の対象パーセンテージ。
`labels`	省略可能	空の配列	トレースデータのスパン属性として使用するためにトレースに追加される表示ラベルの配列。
`labels.name`	必須	なし	スパン属性名として使用される、表示ラベルの名前。
`labels.type`	必須	なし	表示ラベルの種別により、表示ラベルの値の取得元が指定されます。サポートされている値は、`literal`、`environment`、`requestHeader` です。
`labels.keyName`	必須	なし	表示ラベルのキー名。
`labels.defaultValue`	必須	なし	表示ラベルのデフォルト値。

sampling.client

必須

100

x-client-trace-id ヘッダーが設定されている場合に強制的に追跡される要求の対象パーセンテージ。

sampling.random

必須

100

クライアントによって要求されない場合、または強制されない場合に、トレース生成にランダムに選択される要求の対象パーセンテージ。

sampling.overall

必須

100

クライアントダイレクト、強制トレース、ランダムサンプリングなど、他のすべてのサンプリングチェックが適用された後に追跡される要求の対象パーセンテージ。

labels

省略可能

空の配列

トレースデータのスパン属性として使用するためにトレースに追加される表示ラベルの配列。

labels.name

必須

なし

スパン属性名として使用される、表示ラベルの名前。

labels.type

必須

なし

表示ラベルの種別により、表示ラベルの値の取得元が指定されます。サポートされている値は、literal、environment、requestHeader です。

labels.keyName

必須

なし

表示ラベルのキー名。

labels.defaultValue

必須

なし

表示ラベルのデフォルト値。

リソースの設定例

- policyRef:
    name: tracing-flex
  config:
    sampling:
      client: 100
      random: 100
      overall: 100
    labels:
      - name: c-env-tag
        type: environment
        keyName: FLEX_NAME
        defaultValue: DEFAULT_VAL
      - name: c-header-tag
        type: requestHeader
        keyName: :method
        defaultValue: DEFAULT_METHOD
      - name: c-literal-tag
        type: literal
        defaultValue: the-tag

管理 Flex Gateway および Flex Gateway の接続モード

UI からポリシーを API インスタンスに適用するときに、以下のパラメーターが表示されます。

要素説明必須

要素	説明	必須
Client Sampling (クライアントサンプリング)	`x-client-trace-id` ヘッダーが設定されている場合に強制的に追跡される要求の対象パーセンテージ。	はい
Random Sampling (ランダムサンプリング)	クライアントによって要求されない場合、または強制されない場合に、トレース生成にランダムに選択される要求の対象パーセンテージ。	はい
Overall Sampling (全体サンプリング)	クライアントダイレクト、強制トレース、ランダムサンプリングなど、他のすべてのサンプリングチェックが適用された後に追跡される要求の対象パーセンテージ。	はい
Labels (表示ラベル)	トレースデータのスパン属性として使用するためにトレースに追加される表示ラベルの配列。	省略可能
Label Name (表示ラベル名)	スパン属性名として使用される、表示ラベルの名前。	はい
Label Type (表示ラベル種別)	表示ラベルの種別により、表示ラベルの値の取得元が指定されます。サポートされている値は、`literal`、`environment`、`requestHeader` です。	はい
Label Key Name (表示ラベルキー名)	環境変数やリクエストヘッダー名など、値の取得に使用されるキー。	はい
Label Default Value (表示ラベルのデフォルト値)	キーが見つからない場合、または取得された値が空の場合に使用するデフォルト値。	はい

Client Sampling (クライアントサンプリング)

x-client-trace-id ヘッダーが設定されている場合に強制的に追跡される要求の対象パーセンテージ。

はい

Random Sampling (ランダムサンプリング)

クライアントによって要求されない場合、または強制されない場合に、トレース生成にランダムに選択される要求の対象パーセンテージ。

はい

Overall Sampling (全体サンプリング)

はい

Labels (表示ラベル)

トレースデータのスパン属性として使用するためにトレースに追加される表示ラベルの配列。

省略可能

Label Name (表示ラベル名)

スパン属性名として使用される、表示ラベルの名前。

はい

Label Type (表示ラベル種別)

表示ラベルの種別により、表示ラベルの値の取得元が指定されます。サポートされている値は、literal、environment、requestHeader です。

はい

Label Key Name (表示ラベルキー名)

環境変数やリクエストヘッダー名など、値の取得に使用されるキー。

はい

Label Default Value (表示ラベルのデフォルト値)

キーが見つからない場合、または取得された値が空の場合に使用するデフォルト値。

はい