Alibaba Cloud Service Mesh:ASM observability settings

Saída de log de acesso

1. Na seção Log Settings, ative ou desative a chave Enable Log Output conforme necessário.

   • Ao ativar esta opção, os sidecars ou gateways no plano de dados enviam logs de acesso para a saída padrão (stdout) do contêiner.

   • Ao desativar esta opção, os sidecars ou gateways no plano de dados param de enviar logs para a stdout do contêiner.

2. Visualize os logs na stdout do contêiner sidecar do plano de dados.

   Os exemplos a seguir mostram como visualizar logs de acesso com kubectl.

   1. Execute o comando a seguir para visualizar os logs do sidecar:

      kubectl logs httpbin-5c5944c58c-w**** -c istio-proxy --tail 1

      Sample output

      {
          "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. Execute o comando a seguir para visualizar os logs do gateway de entrada:

      kubectl -n istio-system logs istio-ingressgateway-6cff9b6b58-r**** --tail 1

      Sample output

      {
          "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. (Opcional) Visualize os logs de acesso no console do Container Service for Kubernetes.

   Se você usa um cluster do Alibaba Cloud Container Service for Kubernetes (ACK), também pode visualizar os logs de acesso no console do ACK.

   1. Faça login no console do ACK. No painel de navegação à esquerda, clique em Clusters.

   2. Na página Clusters, clique em nome do seu cluster. No painel de navegação à esquerda, clique em Workloads > Pods.

   3. Na página Pods, clique em nome do pod desejado e, em seguida, na aba Logs na parte inferior da página para visualizar os logs de acesso.

Formato de saída de log

Na seção Log Settings, defina o Log Output Format como JSON ou TEXT conforme necessário.

• Se selecionar JSON, os logs de acesso serão enviados para a stdout do contêiner como strings JSON.

• Se selecionar TEXT, os logs de acesso serão enviados para a stdout do contêiner como strings de texto simples.

Formato de log personalizado

1. Na seção Log Settings, selecione campos, modifique informações de campos personalizados ou clique em ícone na parte inferior da lista de campos de log para adicionar um novo campo.

   A personalização do formato de log só é possível quando a chave Enable Log Output está ativada. Na seção Log Format, os campos de log selecionados por padrão são obrigatórios e não podem ser desmarcados. Os valores dos campos de log podem ser obtidos de cabeçalhos de requisição, cabeçalhos de resposta ou valores internos do Envoy.

   Por exemplo, para registrar o cabeçalho de requisição accept-encoding, defina a accessLogFormat key como accept-encoding, o Type como Request Properties e o accessLogFormat value como Accept-Encoding. O modelo de formato para um cabeçalho de requisição é %REQ(HEADER_NAME)% (por exemplo, %REQ(:AUTHORITY)%); para um cabeçalho de resposta é %RESP(HEADER_NAME)% (por exemplo, %RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%); e para um atributo interno do Envoy é %ATTRIBUTE_NAME% (por exemplo, %REQUEST_DURATION%).

2. Execute o comando a seguir para visualizar os logs dos componentes do plano de dados na malha de service.

   kubectl logs httpbin-5c5944c58c-w**** -c istio-proxy --tail 1|grep accept-encoding --color=auto

   Sample output

   {
       "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"
   }

   O log de acesso agora exibe o valor do cabeçalho Accept-Encoding adicionado na etapa 1.

Filtragem de logs

Na seção Log Settings, selecione Enable Log Filter para ativar a filtragem de logs e insira uma expressão de filtragem na caixa de texto. Os logs de acesso são gerados apenas para requisições que correspondem à expressão.

Por exemplo, para registrar apenas requisições que atendam à condição Response Http Status >= 400, use a expressão response.code >= 400. Para mais informações, consulte CEL expressions and common fields.

Geração de métricas

As métricas dividem-se em métricas do lado do cliente e métricas do lado do servidor.

• Métricas do lado do cliente: Geradas quando um sidecar atua como cliente para iniciar requisições. Métricas de gateway também se enquadram nesta categoria.

• Métricas do lado do servidor: Geradas quando um sidecar atua como servidor para receber requisições.

1. Na seção Metric Settings, na coluna Client-Side Metrics ou Server-Side Metrics, marque ou desmarque a caixa de seleção Enabled de uma métrica conforme necessário.

   • Quando uma métrica está ativada, o sidecar ou gateway do plano de dados expõe essa métrica pelo caminho /stats/prometheus na porta 15020.

   • Quando uma métrica está desativada, ela não fica exposta na porta e no caminho especificados.

2. Execute o comando a seguir para visualizar as métricas expostas por um sidecar ou gateway.

   Use o kubectl para executar um comando curl dentro do contêiner do sidecar ou gateway, acessando o caminho /stats/prometheus na porta local 15020 para ver as métricas exportadas.

   kubectl exec httpbin-5c5944c58c-w**** -c istio-proxy -- curl 127.0.0.1:15020/stats/prometheus|head -n 10

   Saída de exemplo:

   # 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
   ......

Dimensões de métricas

As dimensões de métricas fornecem informações contextuais ricas. Use essas dimensões para filtrar métricas-alvo no Prometheus. Por exemplo, use a dimensão source_app para filtrar métricas de requisições originadas de uma aplicação cliente específica.

kubectl exec httpbin-5c5944c58c-w**** -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

Porcentagem de amostragem

Personalize a porcentagem de amostragem para rastreamento, que determina a porcentagem de requisições para as quais os rastreamentos são gerados. Um valor de 0 desativa o rastreamento.

Tags personalizadas

Personalize as tags anexadas aos spans de rastreamento reportados. Na seção Tracing Analysis Settings, clique em Add Custom Tags e configure o Name, o Type e o Value.

Os tipos válidos incluem Valor Fixo, Cabeçalho de Requisição e Variável de Ambiente. A tabela a seguir descreve cada tipo e fornece exemplos.