Configurar el trazado usando MeshConfig y anotaciones de pod

Istio proporciona la capacidad de configurar opciones de trazado avanzadas, como la tasa de muestreo y la adición de tags personalizados a los spans reportados.

Antes de empezar

  1. Asegúrese de que sus applications propaguen las cabeceras de trazado como se describe aquí.

  2. Siga la guía de instalación de trazado que se encuentra en Integraciones según su backend de trazado preferido para instalar el software apropiado y configurar sus proxies de Istio para enviar trazas al deployment de trazado.

Configuraciones de trazado disponibles

Puede configurar las siguientes opciones de trazado en Istio:

  1. Tasa de muestreo aleatorio para el porcentaje de solicitudes que se seleccionarán para la generación de trazas.

  2. Longitud máxima de la ruta de la solicitud después de la cual la ruta se truncará para la presentación de informes. Esto puede ser útil para limitar el almacenamiento de datos de trazas, especialmente si está recopilando trazas en los ingress gateways.

  3. Adición de tags personalizados en los spans. Estos tags se pueden agregar en función de valores literales estáticos, valores de entorno o campos de las cabeceras de la solicitud. Esto se puede utilizar para inyectar información adicional en los spans específicos de su entorno.

Hay dos formas de configurar las opciones de trazado:

  1. Globalmente, a través de las opciones de MeshConfig.

  2. Anotaciones por pod, para personalización específica del workload.

Instalación

El uso de estas features abre nuevas posibilidades para gestionar las trazas en su entorno.

En este ejemplo, muestrearemos todas las trazas y agregaremos un tag llamado clusterID usando la variable de entorno ISTIO_META_CLUSTER_ID inyectada en su pod. Solo los primeros 256 caracteres del valor serán utilizados.

$ cat <<EOF > ./tracing.yaml
apiVersion: install.istio.io/v1alpha1
kind: IstioOperator
spec:
  meshConfig:
    enableTracing: true
    defaultConfig:
      tracing:
        sampling: 100.0
        max_path_tag_length: 256
        custom_tags:
          clusterID:
            environment:
              name: ISTIO_META_CLUSTER_ID
EOF
$ istioctl install -f ./tracing.yaml

Usar MeshConfig para la configuración de trazas

Todas las opciones de trazado se pueden configurar globalmente a través de MeshConfig. Para simplificar la configuración, se recomienda crear un único fichero YAML que pueda pasar al comando istioctl install -f.

cat <<'EOF' > tracing.yaml
apiVersion: install.istio.io/v1alpha1
kind: IstioOperator
spec:
  meshConfig:
    enableTracing: true
    defaultConfig:
      tracing:
        sampling: 10
        custom_tags:
          my_tag_header:
            header:
              name: host
EOF

Usar la anotación proxy.istio.io/config para la configuración de trazas

Puede agregar la anotación proxy.istio.io/config a la especificación de metadatos de su Pod para anular cualquier configuración de trazado de toda la malla. Por ejemplo, para modificar el deployment curl que se envía con Istio, agregaría lo siguiente a samples/curl/curl.yaml:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: curl
spec:
  ...
  template:
    metadata:
      ...
      annotations:
        ...
        proxy.istio.io/config: |
          tracing:
            sampling: 10
            custom_tags:
              my_tag_header:
                header:
                  name: host
    spec:
      ...

Personalización

Personalizar el muestreo de trazas

La opción de tasa de muestreo se puede utilizar para controlar qué porcentaje de solicitudes se informan a su sistema de trazado. Esto debe configurarse en función de su tráfico en la malla y la cantidad de datos de trazado que desea recopilar. La tasa predeterminada es del 1%.

Para modificar el muestreo aleatorio predeterminado al 50%, agregue la siguiente opción a su fichero tracing.yaml.

apiVersion: install.istio.io/v1alpha1
kind: IstioOperator
spec:
  meshConfig:
    enableTracing: true
    defaultConfig:
      tracing:
        sampling: 50

La tasa de muestreo debe estar en el rango de 0.0 a 100.0 con una precisión de 0.01. Por ejemplo, para trazar 5 solicitudes de cada 10000, use 0.05 como valor aquí.

Personalizar los tags de trazado

Se pueden agregar tags personalizados a los spans en función de literales, variables de entorno y cabeceras de solicitud del cliente para proporcionar información adicional en los spans específicos de su entorno.

Puede personalizar los tags usando cualquiera de las tres opciones admitidas a continuación.

  1. Literal representa un valor estático que se agrega a cada span.

    apiVersion: install.istio.io/v1alpha1
    kind: IstioOperator
    spec:
      meshConfig:
        enableTracing: true
        defaultConfig:
          tracing:
            custom_tags:
              my_tag_literal:
                literal:
                  value: <VALUE>
  2. Las variables de entorno se pueden usar cuando el valor del tag personalizado se completa a partir de una variable de entorno del proxy del workload.

    apiVersion: install.istio.io/v1alpha1
    kind: IstioOperator
    spec:
      meshConfig:
        enableTracing: true
        defaultConfig:
          tracing:
            custom_tags:
              my_tag_env:
                environment:
                  name: <ENV_VARIABLE_NAME>
                  defaultValue: <VALUE>      # optional
  3. La opción de cabecera de solicitud del cliente se puede utilizar para completar el valor del tag a partir de una cabecera de solicitud del cliente entrante.

    apiVersion: install.istio.io/v1alpha1
    kind: IstioOperator
    spec:
      meshConfig:
        enableTracing: true
        defaultConfig:
          tracing:
            custom_tags:
              my_tag_header:
                header:
                  name: <CLIENT-HEADER>
                  defaultValue: <VALUE>      # optional

Personalizar la longitud del tag de trazado

De forma predeterminada, la longitud máxima de la ruta de la solicitud incluida como parte del tag del span HttpUrl es 256. Para modificar esta longitud máxima, agregue lo siguiente a su fichero tracing.yaml.

apiVersion: install.istio.io/v1alpha1
kind: IstioOperator
spec:
  meshConfig:
    enableTracing: true
    defaultConfig:
      tracing:
        max_path_tag_length: <VALUE>
¿Fue útil esta información?
¿Tienes alguna sugerencia para mejorar?

¡Gracias por tus comentarios!