フィルター式の使用

フィルター式を使用して、特定のリクエスト、サービス、2 つのサービス間の接続 (エッジ）、または条件を満たすリクエストのトレースマップまたはトレースを表示します。X-Ray にはフィルタ式言語があり、リクエストヘッダー、レスポンスステータス、元セグメントのインデックス付きフィールドのデータに基づいて、リクエスト、サービス、エッジをフィルタリングできます。

X-Ray コンソールで表示するトレースの期間を選択すると、コンソールが表示できる以上の結果が得られることがあります。右上隅には、スキャンしたトレースの数と使用可能なトレースが他にもあるかどうかがコンソールに表示されます。フィルター式を使用して、検索するトレースだけに結果を絞り込むことができます。

フィルタ式の詳細

トレースマップ でノードを選択すると、コンソールはノードのサービス名と選択内容に基づいて存在するエラーのタイプに基づいてフィルター式を作成します。パフォーマンスの問題を示すトレースや特定のリクエストに関連するトレースを見つけるには、コンソールが提供する式を調整するか、独自の式を作成します。X-Ray で注釈を追加する場合SDK、注釈キーの存在またはキーの値に基づいてフィルタリングすることもできます。

コンソールが表示できるものより多くの結果がまだある場合、コンソールには一致したトレースの数とスキャンされたトレースの数が表示されます。表示される割合は、スキャンされた選択済みの時間枠の割合です。結果に表示されているすべての一致するトレースを確認するには、フィルタ式をさらに絞り込むか、より短い時間枠を選択します。

一番新しい結果を得るために、コンソールは時間範囲の終わりにスキャンを開始し、逆方向に動作します。多数のトレースがあるが結果が少ない場合、コンソールは時間範囲をチャンクに分割し、それらを並行してスキャンします。進行状況バーには、スキャンされた時間範囲の一部が表示されます。

グループでフィルタ式を使用する

グループは、フィルタ式で定義されるトレースのコレクションです。グループを使用して、追加のサービスグラフを生成し、Amazon CloudWatch メトリクスを指定できます。

グループは、名前または Amazon リソースネーム (ARN) で識別され、フィルター式が含まれます。サービスは着信トレースを式と比較し、それに応じてそれらを保管します。

フィルタ式検索バーの左側にあるドロップダウンメニューを使用して、グループを作成および変更できます。

グループの詳細については、グループの設定を参照してください。

フィルタ式の構文

フィルタ式にキーワード、単項またはバイナリの演算子、値を追加して比較することができます。

keyword operator value

演算子が異なる場合は、異なるタイプのキーワードを使用できます。たとえば、responsetime は、数値型キーワードを指し、数値に関する演算子と比較することができます。

responsetime > 5

AND 演算子および OR 演算子を使用して、複合式内で複数の式を結合できます。

duration >= 5 AND duration <= 8

キーワードおよび演算子をシンプルにすると、トレースレベルでのみ問題を見つけることができます。エラーによってダウンロードが発生したが、アプリケーションによって処理され、ユーザーに返らない場合、error の検索では見つけることができません。

ダウンストリームの問題があるトレースを見つけるには、「複合型キーワード」、service()、および edge() を使用できます。これらのキーワードを使用して、すべてのダウンストリームノード、単一のダウンストリームノード、または 2 つのノード間のエッジにフィルタ式を適用することができます。さらに詳細にする場合は、「id() 関数」を使用して、タイプごとにサービスおよびエッジをフィルタリングすることができます。

ブール型キーワード

ブール値のキーワード値は true または false です。これらのキーワードを使用して、エラーの原因となったトレースを見つけます。

ブール演算子は、指定されたキーが true または false のセグメントを見つけます。

ok

!ok

ok = false

rootcause.fault.entity { last and name = "deserialize" }

rootcause.responsetime.entity { remote and coverage > 0.7 and name = "traces" }

rootcause.fault.service { inferred and name = traces and type = "AWS::DynamoDB" }

service("data-plane") {root = true and fault = true}

数値型キーワード

数値型キーワードを使用して、特定の応答時間、期間、応答ステータスを含むリクエストを検索します。

http.status != 200

duration >= 5 AND duration <= 8

ok !partial duration <3

rootcause.fault.service { index > 5 }

rootcause.responsetime.entity { last and coverage > 0.8 }

文字列型キーワード

文字列キーワードを使用して、リクエストヘッダーまたは特定のユーザー 内の特定のテキストを含むトレースを検索しますIDs。

文字列演算子は、特定のテキストと一致する値、または特定のテキストを含む値を見つけます。値は、必ず引用符で囲います。

http.url CONTAINS "/api/game/"

フィールドがトレースに存在するかどうかをテストするには、その値に関係なく、空の文字列が含まれているかどうかを確認します。

user CONTAINS ""

rootcause.fault.service { name = "Auth" }

rootcause.responsetime.service { last and type = "AWS::DynamoDB" }

rootcause.fault.exception { last and message = "Access Denied for account_id: 1234567890" 

複合型キーワード

複雑なキーワードを使用し、サービス名、エッジ名、または注釈値に基づいてリクエストを見つけます。サービスとエッジについては、サービスまたはエッジに適用される追加のフィルタ式を指定できます。注釈では、ブール値、数値、または文字列演算子を使用して、特定のキーで注釈の値をフィルタリングできます。

サービスキーワードを使用して、トレースマップ上の特定のノードにヒットしたリクエストのトレースを検索します。

複合型キーワード演算子は、指定されたキーが設定されている、または設定されていないセグメントを見つけます。

サービスキーワードを使用して、トレースマップ上の特定のノードにヒットしたリクエストのトレースを検索します。

service("api.example.com") { fault }

サービス名を除外して、フィルタ式をサービスマップのすべてのノードに適用することができます。

service() { fault }

エッジキーワードは、フィルタ式を 2 つのノード間の接続に適用します。

edge("api.example.com", "backend.example.com") { error }

また、サービスまたはエッジのキーワードを含む ! 演算子を使用して、サービスまたはエッジを他のフィルタ式の結果から除外することもできます。

http.url BEGINSWITH "http://api.example.com/" AND http.url CONTAINS "/v2/" AND !service("api.example.com")

http.url AND responseTime > 2

注釈について、annotation[key] が設定されているか、値のタイプに対応する比較演算子を使用しているかすべてのトレースを呼び出すことができます。

annotation[gameid] = "817DL6VO"

annotation[age]

!annotation[age]

annotation[age] > 29

service { annotation[request.id] = "917DL6VO" }

edge { source.annotation[request.id] = "916DL6VO" }

edge { destination.annotation[request.id] = "918DL6VO" }

group.name = "high_response_time" AND user = "alice"

rootcause.json = #[{ "Services": [ { "Name": "GetWeatherData", "EntityPath": [{ "Name": "GetWeatherData" }, { "Name": "get_temperature" } ] }, { "Name": "GetTemperature", "EntityPath": [ { "Name": "GetTemperature" } ] } ] }]

id 関数

service または edge のキーワードにサービス名を入力すると、そのサービス名を含むすべてのノードの結果が得られます。詳細にフィルタリングする場合は、id 関数を使用してサービスのタイプと名前を指定し、同一名を持つノードを区別することができます。

モニタリングアカウント内の複数のアカウントのトレースを表示する場合、account.id 関数を使用してサービスの特定のアカウントを指定します。

id(name: "service-name", type:"service::type", account.id:"account-ID")

サービスフィルタおよびエッジフィルタで、サービス名ではなく、id 関数を使用することもできます。

service(id(name: "service-name", type:"service::type")) { filter }

edge(id(name: "service-one", type:"service::type"), id(name: "service-two", type:"service::type")) { filter }

例えば、 AWS Lambda 関数はトレースマップに 2 つのノードを作成します。1 つは関数の呼び出し用、もう 1 つは Lambda サービス用です。この 2 つのノードは同じ名前ですが、タイプが異なります。標準サービスフィルタは、両ノードのトレースを見つけます。

service("function-name") { error }

id 関数を使用して、関数そのもののエラーを絞り込み、サービスからエラーを除外します。

service(id(name: "random-name", type: "AWS::Lambda::Function")) { error }

タイプ別にノードを検索するには、名前を完全に除外します。

service(id(type: "AWS::Lambda::Function")) { error }

特定の のノードを検索するには AWS アカウント、アカウント ID を指定します。

service(id(account.id: "account-id"))