Alibaba Cloud Service Mesh:Personnaliser les journaux d'accès du plan de données

ASM avant la version 1.17.2.35

1. Connectez-vous à la console ASM. Dans le volet de navigation de gauche, sélectionnez Service Mesh > Mesh Management.

2. Sur la page Mesh Management, cliquez sur le nom de l'instance ASM. Dans le volet de navigation de gauche, sélectionnez ASM Instance > Base Information.

3. Dans le coin supérieur droit de la page Basic Information, cliquez sur Settings.

4. Dans le panneau Settings Update, cochez l'option Enable access logging and print it to container stdout, puis cliquez sur OK.

   Par défaut, le conteneur istio-proxy génère des journaux contenant les champs suivants. Si vous désactivez la journalisation des accès, le conteneur istio-proxy ne générera pas de journaux d'accès au format JSON.

   Champs de journal par défaut

   
       "authority_for":"%REQ(:AUTHORITY)%",
       "bytes_received":"%BYTES_RECEIVED%",
       "bytes_sent":"%BYTES_SENT%",
       "downstream_local_address":"%DOWNSTREAM_LOCAL_ADDRESS%",
       "downstream_remote_address":"%DOWNSTREAM_REMOTE_ADDRESS%",
       "duration":"%DURATION%",
       "istio_policy_status":"%DYNAMIC_METADATA(istio.mixer:status)%",
       "method":"%REQ(:METHOD)%",
       "path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%",
       "protocol":"%PROTOCOL%",
       "request_id":"%REQ(X-REQUEST-ID)%",
       "requested_server_name":"%REQUESTED_SERVER_NAME%",
       "response_code":"%RESPONSE_CODE%",
       "response_flags":"%RESPONSE_FLAGS%",
       "route_name":"%ROUTE_NAME%",
       "start_time":"%START_TIME%",
       "trace_id":"%REQ(X-B3-TRACEID)%",
       "upstream_cluster":"%UPSTREAM_CLUSTER%",
       "upstream_host":"%UPSTREAM_HOST%",
       "upstream_local_address":"%UPSTREAM_LOCAL_ADDRESS%",
       "upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%",
       "upstream_transport_failure_reason":"%UPSTREAM_TRANSPORT_FAILURE_REASON%",
       "user_agent":"%REQ(USER-AGENT)%",
       "x_forwarded_for":"%REQ(X-FORWARDED-FOR)%"

ASM 1.17.2.35 et versions ultérieures

1. Connectez-vous à la console ASM. Dans le volet de navigation de gauche, sélectionnez Service Mesh > Mesh Management.

2. Sur la page Mesh Management, cliquez sur le nom de l'instance ASM. Dans le volet de navigation de gauche, sélectionnez Observability Management Center > Observability Settings.

3. Sur la page Observability Settings, cliquez sur l'onglet Global, Namespace ou Custom.

   • Si vous sélectionnez l'onglet Namespace, cliquez sur Create et sélectionnez un Namespace.

   • Si vous sélectionnez l'onglet Custom, cliquez sur Create, sélectionnez un Namespace, puis saisissez un Name et une Match Label.

4. Dans la section Log Settings, activez l'option Enable Log Output, puis cliquez sur Submit.

   Une fois l'option activée, les sidecars ou les passerelles du plan de données envoient les journaux d'accès vers la sortie standard (stdout) du conteneur. ASM prend également en charge le filtrage des journaux. Pour plus d'informations, consultez la rubrique Filtrage des journaux.

5. Consultez les journaux dans la sortie standard (stdout) du conteneur sidecar du plan de données.

   Les exemples suivants illustrent la consultation des journaux d'accès à l'aide de kubectl.

   1. Exécutez la commande suivante pour afficher les journaux du sidecar :

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

      Exemple de sortie

      {
          "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. Exécutez la commande suivante pour afficher les journaux de la passerelle d'entrée :

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

      Exemple de sortie

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

6. (Facultatif) Consultez les journaux d'accès dans la console Container Service for Kubernetes.

   Si vous utilisez un cluster Alibaba Cloud Container Service for Kubernetes (ACK), vous pouvez également consulter les journaux d'accès dans la console ACK.

   1. Connectez-vous à la console ACK. Dans le volet de navigation de gauche, cliquez sur Clusters.

   2. Sur la page Clusters, cliquez sur le nom de votre cluster. Dans le volet de navigation de gauche, cliquez sur Workloads > Pods.

   3. Sur la page Pods, cliquez sur le nom du pod cible, puis sélectionnez l'onglet Logs en bas de la page pour consulter les journaux d'accès.

Pour plus d'informations, consultez les rubriques Paramètres d'observabilité et Activer la collecte des journaux du plan de contrôle et les alertes basées sur les journaux (Nouveau).

ASM avant la version 1.17.2.35

1. Connectez-vous à la console ASM. Dans le volet de navigation de gauche, sélectionnez Service Mesh > Mesh Management.

2. Sur la page Mesh Management, cliquez sur le nom de l'instance ASM. Dans le volet de navigation de gauche, sélectionnez ASM Instance > Base Information.

3. Sur la page Basic Information, dans la section Config Info, cliquez sur Update Access Log Format à droite de l'option Enable access logging and print it to container stdout.

4. Dans la boîte de dialogue Update Access Log Format, ajoutez un format de journal d'accès personnalisé. Définissez la accessLogFormat key sur my_custom_key et la accessLogFormat value sur %REQ(end-user)%. Cliquez ensuite sur Submit.

   Cet exemple permet de récupérer l'en-tête end-user d'une requête HTTP dans l'application exemple Bookinfo. Vous pouvez personnaliser le format du journal en sélectionnant parmi les champs proposés par ASM ou en ajoutant des champs personnalisés. Les journaux d'accès sont ensuite générés selon le format spécifié. La boîte de dialogue propose également des champs de journal facultatifs, tels que request_duration (%REQUEST_DURATION%), request_tx_duration (%REQUEST_TX_DURATION%), response_duration (%RESPONSE_DURATION%) et response_tx_duration (%RESPONSE_TX_DURATION%).

ASM 1.17.2.35 et versions ultérieures

1. Connectez-vous à la console ASM. Dans le volet de navigation de gauche, sélectionnez Service Mesh > Mesh Management.

2. Sur la page Mesh Management, cliquez sur le nom de l'instance ASM. Dans le volet de navigation de gauche, sélectionnez Observability Management Center > Observability Settings.

3. Sur la page Observability Settings, cliquez sur l'onglet Global, Namespace ou Custom.

   • Si vous sélectionnez l'onglet Namespace, cliquez sur Create et sélectionnez un Namespace.

   • Si vous sélectionnez l'onglet Custom, cliquez sur Create, sélectionnez un Namespace, puis saisissez un Name et une Match Label.

4. Dans la section Log Settings, sélectionnez des champs, modifiez les informations relatives aux champs ou cliquez sur l'icône située à droite des métriques de journal en bas de la liste pour ajouter un nouveau champ de journal. Cliquez ensuite sur Submit.

   La personnalisation du format du journal n'est possible qu'après activation de l'option Enable Log Output. Dans la section Log Format, les champs par défaut sont obligatoires et ne peuvent pas être modifiés. Les valeurs des champs de journal peuvent être extraites des en-têtes de requête, des en-têtes de réponse ou des valeurs intégrées d'Envoy.

   Cet exemple montre comment afficher l'en-tête accept-encoding d'une requête. Définissez la accessLogFormat key sur accept-encoding, le Type sur Request Properties et la accessLogFormat value sur Accept-Encoding. Les expressions utilisent les formats suivants : %REQ(HeaderName)% pour les propriétés de requête, %RESP(HeaderName)% pour les propriétés de réponse et %BuiltInVariableName% pour les propriétés intégrées d'Envoy, telles que %REQUEST_DURATION%. Vous pouvez ajouter des champs personnalisés, tels que upstream_response_time (expression %RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%) ou accept-encoding (expression %REQ(Accept-Encoding)%).

5. Exécutez la commande suivante pour afficher les journaux des composants du plan de données dans la maille de service :

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

   Exemple de sortie

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

   Vous constatez que la valeur de l'en-tête Accept-Encoding ajouté à l'Étape 2 est bien présente dans le journal d'accès. Pour plus d'informations, consultez les rubriques Paramètres d'observabilité et Activer la collecte des journaux du plan de contrôle et les alertes basées sur les journaux (Nouveau).