Alibaba Cloud Service Mesh:ASM オブザーバビリティ設定

アクセスログ出力

1. Log Settings セクションで、必要に応じて Enable Log Output スイッチをオンまたはオフにします。

   • 有効にすると、データプレーンのサイドカーまたはゲートウェイは、アクセスログをコンテナの標準出力に送信します。

   • 無効にすると、データプレーンのサイドカーまたはゲートウェイは、コンテナの標準出力へのログ送信を停止します。

2. データプレーンのサイドカーコンテナの標準出力でログを確認します。

   以下の例は、kubectl を使用してアクセスログを表示する方法を示しています。

   1. 次のコマンドを実行して、サイドカーのログを表示します。

      kubectl logs <Pod-name> -c istio-proxy --tail 1

      出力例

      {
          "authority_for":"47.110.XX.XXX",
          "bytes_received":"0",
          "bytes_sent":"22382",
          "downstream_local_address":"192.168.0.29:80",
          "downstream_remote_address":"221.220.XXX.XXX:0",
          "duration":"80",
          "istio_policy_status":"-",
          "method":"GET",
          "path":"/static/favicon.ico",
          "protocol":"HTTP/1.1",
          "request_id":"0f2cf829-3da5-4810-a618-08d9745d****",
          "requested_server_name":"outbound_.8000_._.httpbin.default.svc.cluster.local",
          "response_code":"200",
          "response_flags":"-",
          "route_name":"default",
          "start_time":"2023-06-30T04:00:36.841Z",
          "trace_id":"-",
          "upstream_cluster":"inbound|80||",
          "upstream_host":"192.168.0.29:80",
          "upstream_local_address":"127.0.X.X:55879",
          "upstream_response_time":"79",
          "upstream_service_time":"79",
          "upstream_transport_failure_reason":"-",
          "user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.X.X Safari/537.36",
          "x_forwarded_for":"221.220.XXX.XXX"
      }

   2. 次のコマンドを実行して、イングレスゲートウェイのログを表示します。

      kubectl -n istio-system logs <ingress-gateway-Pod-name> --tail 1

      出力例

      {
          "authority_for":"47.110.XX.XXX",
          "bytes_received":"0",
          "bytes_sent":"22382",
          "downstream_local_address":"192.168.0.63:80",
          "downstream_remote_address":"221.220.XXX.XXX:64284",
          "duration":"81",
          "istio_policy_status":"-",
          "method":"GET",
          "path":"/static/favicon.ico",
          "protocol":"HTTP/1.1",
          "request_id":"0f2cf829-3da5-4810-a618-08d9745d****",
          "requested_server_name":"-",
          "response_code":"200",
          "response_flags":"-",
          "route_name":"httpbin",
          "start_time":"2023-06-30T04:00:36.841Z",
          "trace_id":"-",
          "upstream_cluster":"outbound|8000||httpbin.default.svc.cluster.local",
          "upstream_host":"192.168.0.29:80",
          "upstream_local_address":"192.168.0.63:36140",
          "upstream_response_time":"81",
          "upstream_service_time":"81",
          "upstream_transport_failure_reason":"-",
          "user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.X.X Safari/537.36",
          "x_forwarded_for":"221.220.XXX.XXX"
      }

3. (オプション) ACK コンソールでアクセスログを表示します。

   ACK クラスターを使用している場合は、ACK コンソールでアクセスログを表示することもできます。

   1. ACKコンソールにログインします。 左側のナビゲーションウィンドウで、[クラスター] をクリックします。

   2. [クラスター] ページで、管理するクラスターを検索し、その名前をクリックします。 左側のウィンドウで、[ワークロード] > [ポッド] を選択します。

   3. ポッド ページで、対象 Pod の名前をクリックし、ページ下部の ログ タブをクリックして、アクセスログを確認します。

ログ出力フォーマット

Log Settings セクションで、Log Output Format を必要に応じて [JSON] または [TEXT] に設定します。

• [JSON] を選択すると、アクセスログは JSON 文字列としてコンテナの標準出力に送信されます。

• [TEXT] を選択すると、アクセスログはプレーンテキスト文字列としてコンテナの標準出力に送信されます。

カスタムログフォーマット

1. Log Settings セクションで、含めるフィールドを選択し、カスタムフィールド情報を変更するか、 アイコンをクリックして新しいログフィールドを追加します。

   ログフォーマットをカスタマイズできるのは、[ログ出力を有効化] がオンになっている場合のみです。Log Format セクションでは、デフォルトのログフィールドは必須であり、変更できません。ログフィールドは、リクエストヘッダー、レスポンスヘッダー、または Envoy の組み込み値から値を取得できます。

   次の例は、リクエストの accept-encoding ヘッダーを出力する方法を示しています。accessLogFormat key を [accept-encoding] に、Type を Request Properties に、accessLogFormat value を [Accept-Encoding] に設定します。たとえば、組み込みフィールド authority_for はフォーマット変数 %REQ(:AUTHORITY)% に対応し、duration は %REQUEST_DURATION% に対応します。upstream_response_time などのカスタムフィールドの場合、属性タイプとして [Response Attribute] を選択すると、フォーマット変数は %RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)% になります。accept-encoding などのカスタムフィールドの場合、属性タイプとして [Request Attribute] を選択すると、フォーマット変数は %REQ(Accept-Encoding)% になります。

2. 次のコマンドを実行して、データプレーンコンポーネントのログに新しいフィールドが含まれていることを確認します。

   kubectl logs <Pod-name> -c istio-proxy --tail 1|grep accept-encoding --color=auto

   出力例

   {
       "bytes_received":"0",
       "bytes_sent":"9593",
       "downstream_local_address":"192.168.0.29:80",
       "downstream_remote_address":"69.164.XXX.XX:0",
       "duration":"2",
       "istio_policy_status":"-",
       "method":"GET",
       "path":"/",
       "protocol":"HTTP/1.1",
       "request_id":"29939dc9-62be-4ddf-acf6-32cb098d****",
       "requested_server_name":"outbound_.8000_._.httpbin.default.svc.cluster.local",
       "response_code":"200",
       "response_flags":"-",
       "route_name":"default",
       "start_time":"2023-06-30T04:18:19.734Z",
       "trace_id":"-",
       "upstream_cluster":"inbound|80||",
       "upstream_host":"192.168.0.29:80",
       "upstream_local_address":"127.0.X.X:34723",
       "upstream_service_time":"2",
       "upstream_transport_failure_reason":"-",
       "user_agent":"Mozilla/5.0 zgrab/0.x",
       "x_forwarded_for":"69.164.XXX.XX",
       "authority_for":"47.110.XX.XXX",
       "upstream_response_time":"2",
       "accept-encoding":"gzip"
   }

   出力結果から、ステップ 1 で追加した Accept-Encoding ヘッダーがアクセスログに書き込まれていることがわかります。

ログフィルタリング

Log Settings セクションで、Enable Log Filter を選択してログフィルタリングを有効にします。次に、テキストボックスにログフィルター式を入力します。式に一致するリクエストに対してのみアクセスログが生成されます。

たとえば、レスポンスの HTTP ステータスが 400 以上のリクエストのみをログに記録する場合は、式 response.code >= 400 を使用します。 詳細については、「CEL 式と共通フィールド」をご参照ください。

メトリクス生成

メトリクスは、クライアント側のメトリクスとサーバー側のメトリクスに分けられます。

• クライアント側のメトリクスは、サイドカーがクライアントとして動作してリクエストを開始する際に生成されるメトリクスです。ゲートウェイのメトリクスも CLIENT カテゴリに属します。

• サーバー側のメトリクスは、サイドカーがサーバーとしてアクセスされる際に生成されるメトリクスです。

1. Metric Settings セクションで、Client-Side Metrics または Server-Side Metrics 列において、必要に応じて対象メトリクスの Enabled チェックボックスにチェックを入れるか、チェックを外します。

   • 有効にすると、データプレーンのサイドカーまたはゲートウェイは、ポート 15020 の /stats/prometheus パスを通じてメトリクスを公開します。

   • 無効にすると、このポートではメトリクスは公開されません。

2. 次のコマンドを実行して、サイドカーまたはゲートウェイが公開するメトリクスを表示します。

   kubectl コマンドを使用して、サイドカーまたはゲートウェイのコンテナ内で curl コマンドを実行し、ローカルポート 15020 の /stats/prometheus パスにアクセスして、エクスポートされたメトリクスを表示できます。

   kubectl exec <Pod-name> -c istio-proxy -- curl 127.0.0.1:15020/stats/prometheus | head -n 10

   出力例：

   # TYPE istio_agent_cert_expiry_seconds gauge
   istio_agent_cert_expiry_seconds{resource_name="default"} 46725.287654548
   # HELP istio_agent_endpoint_no_pod Endpoints without an associated pod.
   # TYPE istio_agent_endpoint_no_pod gauge
   istio_agent_endpoint_no_pod 0
   # HELP istio_agent_go_gc_duration_seconds A summary of the pause duration of garbage collection cycles.
   # TYPE istio_agent_go_gc_duration_seconds summary
   istio_agent_go_gc_duration_seconds{quantile="0"} 5.0149e-05
   istio_agent_go_gc_duration_seconds{quantile="0.25"} 9.8807e-05
   ......

メトリクスディメンション

メトリクスディメンションによってコンテキストが追加され、Prometheus でメトリクスをフィルタリングできるようになります。たとえば、source_app ディメンションを使用して、特定のクライアントアプリケーションからのリクエストに対するメトリクスをフィルタリングできます。

kubectl exec <Pod-name> -c istio-proxy -- curl 127.0.0.1:15020/stats/prometheus

istio_request_bytes_sum{reporter="destination",source_workload="istio-ingressgateway",source_canonical_service="unknown",source_canonical_revision="latest",source_workload_namespace="istio-system",source_principal="spiffe://cluster.local/ns/istio-system/sa/istio-ingressgateway",source_app="istio-ingressgateway",source_version="unknown",source_cluster="c479fc4abd2734bfaaa54e9e36fb26c01",destination_workload="httpbin",destination_workload_namespace="default",destination_principal="spiffe://cluster.local/ns/default/sa/httpbin",destination_app="httpbin",destination_version="v1",destination_service="httpbin.default.svc.cluster.local",destination_canonical_service="httpbin",destination_canonical_revision="v1",destination_service_name="httpbin",destination_service_namespace="default",destination_cluster="c479fc4abd2734bfaaa54e9e36fb26c01",request_protocol="http",response_code="200",grpc_response_status="",response_flags="-",connection_security_policy="mutual_tls"} 18000

istio_request_bytes_sum{response_code="200"} 16550

istio_request_bytes_sum{response_code="200",request_path="/spec.json"} 5800

サンプリングレート

トレーシングのサンプリングレートをカスタマイズできます。これは、トレースレポートをトリガーするリクエストの割合です。値を 0 にすると、トレーシングが無効になり、トレースレポートはトリガーされません。

カスタムタグ

レポートされるトレーシングスパンのタグをカスタマイズできます。Tracing Analysis Settings セクションで、Add Custom Tags をクリックし、Name、Type、Value を設定します。

タイプには、固定値、リクエストヘッダー、環境変数があります。次の表は、各タイプの説明と設定例を示しています。